Changes in src/cvec.h [66fb3ea:f72364d]

File:

• src/cvec.h (modified) (6 diffs)

src/cvec.h ¶

@@ -28 +28 @@
 /** \file
 
-  Complex buffers
+  Vector of complex-valued data
 
-  This file specifies the cvec_t buffer type, which is used throughout aubio to
-  store complex data. Complex values are stored in terms of phase and
-  norm, within size/2+1 long vectors.
+  This file specifies the ::cvec_t buffer type, which is used throughout aubio
+  to store complex data. Complex values are stored in terms of ::cvec_t.phas
+  and norm, within size/2+1 long vectors of ::smpl_t.
+
+  \example test-cvec.c
 
 */
 
-/** Buffer for complex data */
+/** Buffer for complex data
+
+  \code
+
+  uint_t buffer_size = 1024;
+
+  // create a complex vector of 512 values
+  cvec_t * input = new_cvec (buffer_size);
+
+  // set some values of the vector
+  input->norm[23] = 2.;
+  input->phas[23] = M_PI;
+  // ..
+
+  // compute the mean of the vector
+  mean = cvec_mean(input);
+
+  // destroy the vector
+  del_cvec (input);
+
+  \endcode
+
+ */
 typedef struct {
-  uint_t length;   /**< length of buffer = (requested length)/2 + 1 */
-  smpl_t *norm;   /**< norm array of size [length] */
-  smpl_t *phas;   /**< phase array of size [length] */
+  uint_t length;  /**< length of buffer = (requested length)/2 + 1 */
+  smpl_t *norm;   /**< norm array of size ::cvec_t.length */
+  smpl_t *phas;   /**< phase array of size ::cvec_t.length */
 } cvec_t;
 
@@ -48 +72 @@
   [length/2+1], corresponding to the norm and phase values of the
   spectral frame. The length stored in the structure is the actual size of both
-  arrays, not the length of the complex and symetrical vector, specified as
+  arrays, not the length of the complex and symmetrical vector, specified as
   creation argument.
 
@@ -67 +91 @@
   is to access these values from wrappers, as created by swig.
 
-  \param s vector to write to 
+  \param s vector to write to
   \param data norm value to write in s->norm[position]
   \param position sample position to write to
@@ -128 +152 @@
 smpl_t * cvec_get_phas(cvec_t *s);
 
-/** print out cvec data 
+/** print out cvec data
 
-  \param s vector to print out 
+  \param s vector to print out
 
 */
@@ -143 +167 @@
 void cvec_set(cvec_t *s, smpl_t val);
 
-/** set all elements to zero 
+/** set all elements to zero
 
   \param s vector to modify
@@ -150 +174 @@
 void cvec_zeros(cvec_t *s);
 
-/** set all elements to ones 
+/** set all elements to ones
 
   \param s vector to modify