python/tests/test_source.py: really fail wrong hop size test

[aubio.git] / src / fmat.h

diff --git a/src/fmat.h b/src/fmat.h
index 855b2ad8c9b5b6a72e132c9527f31c3fe16cafdb..4c52a844b4c949d55e7c282b4091083ccdf1911f 100644 (file)
--- a/src/fmat.h
+++ b/src/fmat.h
@@ -27,27 +27,29 @@ extern "C" {
 
 /** \file
 
-  Real buffers
+  Matrix of real valued data
 
-  This file specifies the fmat_t type, which is used in aubio to store real
-  valued arrays.
+  This file specifies the fmat_t type, which is used in aubio to store arrays
+  of floating point values.
+
+  \example test-fmat.c
 
 */
 
 /** Buffer for real data */
 typedef struct {
-  uint_t length;   /**< length of buffer */
-  uint_t height; /**< number of channels */
-  smpl_t **data;   /**< data array of size [length] * [channels] */
+  uint_t length; /**< length of matrix */
+  uint_t height; /**< height of matrix */
+  smpl_t **data; /**< data array of size [length] * [height] */
 } fmat_t;
 
 /** fmat_t buffer creation function
 
-  \param length the length of the buffer to create
-  \param channels the number of channels in the buffer
+  \param length the length of the matrix to create
+  \param height the height of the matrix to create
 
 */
-fmat_t * new_fmat(uint_t length, uint_t channels);
+fmat_t * new_fmat(uint_t length, uint_t height);
 /** fmat_t buffer deletion function
 
   \param s buffer to delete as returned by new_fmat()