Changeset f72364d for src/cvec.h


Ignore:
Timestamp:
Mar 3, 2013, 4:29:36 AM (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:
69b11d8
Parents:
f9d5346
Message:

src/*.h: improve documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/cvec.h

    rf9d5346 rf72364d  
    3838*/
    3939
    40 /** Buffer for complex data */
     40/** Buffer for complex data
     41
     42  \code
     43
     44  uint_t buffer_size = 1024;
     45
     46  // create a complex vector of 512 values
     47  cvec_t * input = new_cvec (buffer_size);
     48
     49  // set some values of the vector
     50  input->norm[23] = 2.;
     51  input->phas[23] = M_PI;
     52  // ..
     53
     54  // compute the mean of the vector
     55  mean = cvec_mean(input);
     56
     57  // destroy the vector
     58  del_cvec (input);
     59
     60  \endcode
     61
     62 */
    4163typedef struct {
    4264  uint_t length;  /**< length of buffer = (requested length)/2 + 1 */
     
    6991  is to access these values from wrappers, as created by swig.
    7092
    71   \param s vector to write to 
     93  \param s vector to write to
    7294  \param data norm value to write in s->norm[position]
    7395  \param position sample position to write to
     
    130152smpl_t * cvec_get_phas(cvec_t *s);
    131153
    132 /** print out cvec data 
     154/** print out cvec data
    133155
    134   \param s vector to print out 
     156  \param s vector to print out
    135157
    136158*/
     
    145167void cvec_set(cvec_t *s, smpl_t val);
    146168
    147 /** set all elements to zero 
     169/** set all elements to zero
    148170
    149171  \param s vector to modify
     
    152174void cvec_zeros(cvec_t *s);
    153175
    154 /** set all elements to ones 
     176/** set all elements to ones
    155177
    156178  \param s vector to modify
Note: See TracChangeset for help on using the changeset viewer.