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/>.
21 #ifndef _AUBIO__LVEC_H
22 #define _AUBIO__LVEC_H
30 Vector of real-valued data in double precision
32 This file specifies the ::lvec_t buffer type, which is used in some places in
33 aubio to store a vector of ::lsmp_t.
35 Note: the lvec_t data type is required in some algorithms such as IIR filters
36 (see temporal/filter.h).
42 /** Buffer for real data in double precision */
44 uint_t length; /**< length of buffer */
45 lsmp_t *data; /**< data array of size [length] */
48 /** lvec_t buffer creation function
50 \param length the length of the buffer to create
53 lvec_t * new_lvec(uint_t length);
54 /** lvec_t buffer deletion function
56 \param s buffer to delete as returned by new_lvec()
59 void del_lvec(lvec_t *s);
61 /** read sample value in a buffer
63 \param s vector to read from
64 \param position sample position to read from
67 lsmp_t lvec_get_sample(lvec_t *s, uint_t position);
69 /** write sample value in a buffer
71 \param s vector to write to
72 \param data value to write in s->data[position]
73 \param position sample position to write to
76 void lvec_set_sample(lvec_t *s, lsmp_t data, uint_t position);
78 /** read data from a buffer
80 \param s vector to read from
83 lsmp_t * lvec_get_data(lvec_t *s);
85 /** print out lvec data
87 \param s vector to print out
90 void lvec_print(lvec_t *s);
92 /** set all elements to a given value
94 \param s vector to modify
95 \param val value to set elements to
98 void lvec_set_all(lvec_t *s, smpl_t val);
100 /** set all elements to zero
102 \param s vector to modify
105 void lvec_zeros(lvec_t *s);
107 /** set all elements to ones
109 \param s vector to modify
112 void lvec_ones(lvec_t *s);
118 #endif /* _AUBIO__LVEC_H */