aboutsummaryrefslogtreecommitdiff
path: root/xtract/xtract_delta.h
diff options
context:
space:
mode:
authorJamie Bullock <jamie@postlude.co.uk>2008-03-26 13:04:33 +0000
committerJamie Bullock <jamie@postlude.co.uk>2008-03-26 13:04:33 +0000
commitd817fc9b42b0c04d6452159ca63f5a30834f5489 (patch)
tree94eb92eec04d06020bcb08e59e8da541d3a8f8ee /xtract/xtract_delta.h
parent398afce1d37bad97d50a20aa5406a4dc6327912d (diff)
downloadLibXtract-d817fc9b42b0c04d6452159ca63f5a30834f5489.tar.gz
LibXtract-d817fc9b42b0c04d6452159ca63f5a30834f5489.tar.bz2
LibXtract-d817fc9b42b0c04d6452159ca63f5a30834f5489.zip
- Fixed build fail if --enable-fft not specified
- Fixed doxygen build so that it includes libxtract.h - Doxygen tweaks
Diffstat (limited to 'xtract/xtract_delta.h')
-rw-r--r--xtract/xtract_delta.h16
1 files changed, 13 insertions, 3 deletions
diff --git a/xtract/xtract_delta.h b/xtract/xtract_delta.h
index 9b4f28f..6e19708 100644
--- a/xtract/xtract_delta.h
+++ b/xtract/xtract_delta.h
@@ -18,7 +18,7 @@
* USA.
*/
-/** \file xtract_delta.h: declares functions that extract a feature as a single value or vector from more than one input vector */
+/** \file xtract_delta.h: declares functions that scalar or vector value from 2 or more input vectors */
#ifndef XTRACT_DELTA_H
#define XTRACT_DELTA_H
@@ -27,15 +27,23 @@
extern "C" {
#endif
+/**
+ * \defgroup delta `delta' extraction functions
+ *
+ * Functions that extract a scalar or vector value from 2 or more input vectors
+ *
+ * @{
+ */
+
#include "xtract_types.h"
-/* \brief Extract flux
+/** \brief Extract flux
*
* An alias for xtract_lnorm()
*/
int xtract_flux(const float *data, const int N, const void *argv , float *result);
-/* \brief Extract the L-norm of a vector
+/** \brief Extract the L-norm of a vector
*
* \param *data: a pointer to the first element in an array of floats representing the difference between two subsequent frames of output from a vector-based feature e.g. the *result from xtract_difference_vector()
* \param N: the length of the array pointed to by *data
@@ -67,6 +75,8 @@ int xtract_difference_vector(const float *data, const int N, const void *argv, f
/*xtract_frame_tracker *xf */
/*float frames*/
+/** @} */
+
#ifdef __cplusplus
}
#endif