Changeset 621f1ff for src/cvec.h


Ignore:
Timestamp:
Mar 2, 2013, 8:15:57 PM (7 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
867084e
Parents:
b3ab675
Message:

src/: improve documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/cvec.h

    rb3ab675 r621f1ff  
    2828/** \file
    2929
    30   Complex buffers
     30  Vector of complex-valued data
    3131
    32   This file specifies the cvec_t buffer type, which is used throughout aubio to
    33   store complex data. Complex values are stored in terms of phase and
    34   norm, within size/2+1 long vectors.
     32  This file specifies the ::cvec_t buffer type, which is used throughout aubio
     33  to store complex data. Complex values are stored in terms of ::cvec_t.phas
     34  and norm, within size/2+1 long vectors of ::smpl_t.
     35
     36  \example test-cvec.c
    3537
    3638*/
     
    3840/** Buffer for complex data */
    3941typedef struct {
    40   uint_t length;   /**< length of buffer = (requested length)/2 + 1 */
    41   smpl_t *norm;   /**< norm array of size [length] */
    42   smpl_t *phas;   /**< phase array of size [length] */
     42  uint_t length;  /**< length of buffer = (requested length)/2 + 1 */
     43  smpl_t *norm;   /**< norm array of size ::cvec_t.length */
     44  smpl_t *phas;   /**< phase array of size ::cvec_t.length */
    4345} cvec_t;
    4446
     
    4850  [length/2+1], corresponding to the norm and phase values of the
    4951  spectral frame. The length stored in the structure is the actual size of both
    50   arrays, not the length of the complex and symetrical vector, specified as
     52  arrays, not the length of the complex and symmetrical vector, specified as
    5153  creation argument.
    5254
Note: See TracChangeset for help on using the changeset viewer.