Changeset f72364d for src/fvec.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/fvec.h

    rf9d5346 rf72364d  
    2828/** \file
    2929
    30   Real buffers
     30  Vector of real-valued data
    3131
    32   This file specifies the fvec_t buffer type, which is used throughout aubio to
    33   store real data.
     32  This file specifies the ::fvec_t buffer type, which is used throughout aubio
     33  to store vector of real-valued ::smpl_t.
     34
     35  \example test-fvec.c
    3436
    3537*/
    3638
    37 /** Buffer for real data */
     39/** Buffer for real data
     40
     41  Vector of real-valued data
     42
     43  ::fvec_t is is the structure used to store vector of real-valued data, ::smpl_t .
     44
     45  \code
     46
     47  uint_t buffer_size = 1024;
     48
     49  // create a vector of 512 values
     50  fvec_t * input = new_fvec (buffer_size);
     51
     52  // set some values of the vector
     53  input->data[23] = 2.;
     54  // ..
     55
     56  // compute the mean of the vector
     57  mean = fvec_mean(a_vector);
     58
     59  // destroy the vector
     60  del_fvec(a_vector);
     61
     62  \endcode
     63
     64  See `examples/` and `tests/src` directories for more examples.
     65
     66 */
    3867typedef struct {
    39   uint_t length;   /**< length of buffer */
    40   smpl_t *data;   /**< data array of size [length] */
     68  uint_t length;  /**< length of buffer */
     69  smpl_t *data;   /**< data vector of length ::fvec_t.length */
    4170} fvec_t;
    4271
Note: See TracChangeset for help on using the changeset viewer.