2 Copyright (C) 2003-2015 Paul Brossier <piem@aubio.org>
4 This file is part of aubio.
6 aubio is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 aubio is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with aubio. If not, see <http://www.gnu.org/licenses/>.
30 Vector of real-valued data
32 This file specifies the ::fvec_t buffer type, which is used throughout aubio
33 to store vector of real-valued ::smpl_t.
39 /** Buffer for real data
41 Vector of real-valued data
43 ::fvec_t is is the structure used to store vector of real-valued data, ::smpl_t .
47 uint_t buffer_size = 1024;
49 // create a vector of 512 values
50 fvec_t * input = new_fvec (buffer_size);
52 // set some values of the vector
56 // compute the mean of the vector
57 mean = fvec_mean(a_vector);
64 See `examples/` and `tests/src` directories for more examples.
68 uint_t length; /**< length of buffer */
69 smpl_t *data; /**< data vector of length ::fvec_t.length */
72 /** fvec_t buffer creation function
74 \param length the length of the buffer to create
77 fvec_t * new_fvec(uint_t length);
79 /** fvec_t buffer deletion function
81 \param s buffer to delete as returned by new_fvec()
84 void del_fvec(fvec_t *s);
86 /** read sample value in a buffer
88 \param s vector to read from
89 \param position sample position to read from
92 smpl_t fvec_get_sample(const fvec_t *s, uint_t position);
94 /** write sample value in a buffer
96 \param s vector to write to
97 \param data value to write in s->data[position]
98 \param position sample position to write to
101 void fvec_set_sample(fvec_t *s, smpl_t data, uint_t position);
103 /** read data from a buffer
105 \param s vector to read from
108 smpl_t * fvec_get_data(const fvec_t *s);
110 /** print out fvec data
112 \param s vector to print out
115 void fvec_print(const fvec_t *s);
117 /** set all elements to a given value
119 \param s vector to modify
120 \param val value to set elements to
123 void fvec_set_all (fvec_t *s, smpl_t val);
125 /** set all elements to zero
127 \param s vector to modify
130 void fvec_zeros(fvec_t *s);
132 /** set all elements to ones
134 \param s vector to modify
137 void fvec_ones(fvec_t *s);
139 /** revert order of vector elements
141 \param s vector to revert
144 void fvec_rev(fvec_t *s);
146 /** apply weight to vector
148 If the weight vector is longer than s, only the first elements are used. If
149 the weight vector is shorter than s, the last elements of s are not weighted.
151 \param s vector to weight
152 \param weight weighting coefficients
155 void fvec_weight(fvec_t *s, const fvec_t *weight);
157 /** make a copy of a vector
159 \param s source vector
160 \param t vector to copy to
163 void fvec_copy(const fvec_t *s, fvec_t *t);
165 /** make a copy of a vector, applying weights to each element
167 \param in input vector
168 \param weight weights vector
169 \param out output vector
172 void fvec_weighted_copy(const fvec_t *in, const fvec_t *weight, fvec_t *out);
178 #endif /* AUBIO_FVEC_H */