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

File:

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

src/cvec.h ¶

@@ -28 +28 @@
 /** \file
 
-  Vector of complex-valued data
+  Complex buffers
 
-  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
+  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.
 
 */
 
-/** 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
-
- */
+/** Buffer for complex data */
 typedef struct {
-  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 */
+  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] */
 } cvec_t;
 
@@ -72 +48 @@
   [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 symmetrical vector, specified as
+  arrays, not the length of the complex and symetrical vector, specified as
   creation argument.
 
@@ -91 +67 @@
   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
@@ -152 +128 @@
 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 
 
 */
@@ -167 +143 @@
 void cvec_set(cvec_t *s, smpl_t val);
 
-/** set all elements to zero
+/** set all elements to zero 
 
   \param s vector to modify
@@ -174 +150 @@
 void cvec_zeros(cvec_t *s);
 
-/** set all elements to ones
+/** set all elements to ones 
 
   \param s vector to modify