Mercurial > hg > libxtract
comparison xtract/xtract_scalar.h @ 20:8b8d4f1c5fb6
Improved doxygen documentation
author | Jamie Bullock <jamie@postlude.co.uk> |
---|---|
date | Tue, 10 Oct 2006 12:29:39 +0000 |
parents | 1aec087ddfca |
children | bc44e56e6c81 |
comparison
equal
deleted
inserted
replaced
19:c7d93630aa5f | 20:8b8d4f1c5fb6 |
---|---|
25 | 25 |
26 #ifdef __cplusplus | 26 #ifdef __cplusplus |
27 extern "C" { | 27 extern "C" { |
28 #endif | 28 #endif |
29 | 29 |
30 /** | |
31 * \defgroup scalar extraction functions | |
32 * | |
33 * Defines scalar extraction functions, and their parameters. | |
34 * @{ | |
35 */ | |
30 | 36 |
31 /** \brief Extract the mean of an input vector | 37 /** \brief Extract the mean of an input vector |
32 * | 38 * |
33 * \param *data: a pointer to the first element in an array of floats | 39 * \param *data: a pointer to the first element in an array of floats |
34 * \param N: the number of array elements to be considered | 40 * \param N: the number of array elements to be considered |
294 * This algorithm is based on the AMDF and would benefit from further refinement | 300 * This algorithm is based on the AMDF and would benefit from further refinement |
295 * | 301 * |
296 */ | 302 */ |
297 int xtract_f0(float *data, int N, void *argv, float *result); | 303 int xtract_f0(float *data, int N, void *argv, float *result); |
298 | 304 |
305 /** @} */ | |
306 | |
299 #ifdef __cplusplus | 307 #ifdef __cplusplus |
300 } | 308 } |
301 #endif | 309 #endif |
302 | 310 |
303 #endif | 311 #endif |