<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aubio: cvec.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">aubio
 <span id="projectnumber">0.4.2~alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">cvec.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cvec_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> This file is part of aubio.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> aubio is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> the Free Software Foundation, either version 3 of the License, or</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> (at your option) any later version.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> aubio is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> GNU General Public License for more details.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> along with aubio. If not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*/</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef _AUBIO__CVEC_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define _AUBIO__CVEC_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/** \file</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> Vector of complex-valued data, stored in polar coordinates</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> This file specifies the ::cvec_t buffer type, which is used throughout aubio</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> to store complex data. Complex values are stored in terms of ::cvec_t.phas</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> and norm, within 2 vectors of ::smpl_t of size (size/2+1) each.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> \example test-cvec.c</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">*/</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/** Vector of real-valued phase and spectrum data</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> \code</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> uint_t buffer_size = 1024;</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> // create a complex vector of 512 values</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> cvec_t * input = new_cvec (buffer_size);</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> // set some values of the vector</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> input->norm[23] = 2.;</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> input->phas[23] = M_PI;</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> // ..</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> // compute the mean of the vector</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> mean = cvec_mean(input);</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> // destroy the vector</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> del_cvec (input);</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> \endcode</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> */</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structcvec__t.html"> 63</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structcvec__t.html#a8784dac0b4a6cb0fe0c201f54d3df006"> 64</a></span>  <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> <a class="code" href="structcvec__t.html#a8784dac0b4a6cb0fe0c201f54d3df006">length</a>; <span class="comment">/**< length of buffer = (requested length)/2 + 1 */</span></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structcvec__t.html#a25ee232234c0585a6a4f6de27e1f8dbb"> 65</a></span>  <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> *<a class="code" href="structcvec__t.html#a25ee232234c0585a6a4f6de27e1f8dbb">norm</a>; <span class="comment">/**< norm array of size ::cvec_t.length */</span></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structcvec__t.html#a3a2b1542ce3ee5d29a1c364f720a20f3"> 66</a></span>  <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> *<a class="code" href="structcvec__t.html#a3a2b1542ce3ee5d29a1c364f720a20f3">phas</a>; <span class="comment">/**< phase array of size ::cvec_t.length */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <a class="code" href="structcvec__t.html">cvec_t</a>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/** cvec_t buffer creation function</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> This function creates a cvec_t structure holding two arrays of size</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> [length/2+1], corresponding to the norm and phase values of the</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> spectral frame. The length stored in the structure is the actual size of both</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> arrays, not the length of the complex and symmetrical vector, specified as</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> creation argument.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> \param length the length of the buffer to create</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">*/</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <a class="code" href="structcvec__t.html">cvec_t</a> * <a class="code" href="cvec_8h.html#afbb7fc65d12893e512be56ec0f5dc5f0">new_cvec</a>(<a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> length);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/** cvec_t buffer deletion function</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> \param s buffer to delete as returned by new_cvec()</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">*/</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#a98c745b15cea1b81e62cbb6fb21b0c56">del_cvec</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">/** write norm value in a complex buffer</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> This is equivalent to:</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> \code</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> s->norm[position] = val;</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> \endcode</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> \param s vector to write to</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> \param val norm value to write in s->norm[position]</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> \param position sample position to write to</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">*/</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#ae399da2b544a4148f7a87fb12202c9c0">cvec_norm_set_sample</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s, <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> val, <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> position);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">/** write phase value in a complex buffer</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> This is equivalent to:</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> \code</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> s->phas[position] = val;</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> \endcode</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> \param s vector to write to</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> \param val phase value to write in s->phas[position]</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> \param position sample position to write to</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">*/</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#ade1260448cbfb3302cee36a94311b4a4">cvec_phas_set_sample</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s, <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> val, <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> position);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">/** read norm value from a complex buffer</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"></span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> This is equivalent to:</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> \code</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> smpl_t foo = s->norm[position];</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> \endcode</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> \param s vector to read from</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> \param position sample position to read from</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"></span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">*/</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> <a class="code" href="cvec_8h.html#abeba6a97810474913e0374a298a2218b">cvec_norm_get_sample</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s, <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> position);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">/** read phase value from a complex buffer</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"></span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> This is equivalent to:</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> \code</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> smpl_t foo = s->phas[position];</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> \endcode</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"></span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> \param s vector to read from</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> \param position sample position to read from</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> \returns the value of the sample at position</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">*/</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> <a class="code" href="cvec_8h.html#aed688a09429eab715b6a3568a367ec05">cvec_phas_get_sample</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s, <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> position);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"></span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">/** read norm data from a complex buffer</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"></span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> \code</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> smpl_t *data = s->norm;</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> \endcode</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"></span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> \param s vector to read from</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">*/</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> * <a class="code" href="cvec_8h.html#ab088860d6c00321a61ef9a4a833c3d1e">cvec_norm_get_data</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"></span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/** read phase data from a complex buffer</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"></span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> This is equivalent to:</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> \code</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> smpl_t *data = s->phas;</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> \endcode</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> \param s vector to read from</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"></span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">*/</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> * <a class="code" href="cvec_8h.html#aa1a7723e4a99e44acfee444e09604e23">cvec_phas_get_data</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"></span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">/** print out cvec data</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"></span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> \param s vector to print out</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"></span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">*/</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#a910299ca4c79f87a426f1bfb970ec77a">cvec_print</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"></span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">/** make a copy of a vector</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> \param s source vector</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> \param t vector to copy to</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"></span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">*/</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#a7416ee033e36ef40e795c7ecbd0d6757">cvec_copy</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s, <a class="code" href="structcvec__t.html">cvec_t</a> *t);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"></span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">/** set all norm elements to a given value</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"></span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> \param s vector to modify</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> \param val value to set elements to</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"></span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">*/</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#ad625a322c57a1dae0d256b958f734221">cvec_norm_set_all</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s, <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> val);</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"></span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">/** set all norm elements to zero</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"></span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> \param s vector to modify</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"></span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">*/</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#aa99a32878355b0ea7b9d5293dda88d05">cvec_norm_zeros</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">/** set all norm elements to one</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> \param s vector to modify</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"></span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">*/</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#aabb35c55a0a202ddb64a9bd67cda962a">cvec_norm_ones</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"></span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">/** set all phase elements to a given value</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"></span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> \param s vector to modify</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> \param val value to set elements to</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"></span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">*/</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#a99509bb159e68f784bded2e4d57cd4ca">cvec_phas_set_all</a> (<a class="code" href="structcvec__t.html">cvec_t</a> *s, <a class="code" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> val);</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"></span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">/** set all phase elements to zero</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"></span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> \param s vector to modify</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"></span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">*/</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#a1b266a8dc5043ddc86db1dca0861166e">cvec_phas_zeros</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"></span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">/** set all phase elements to one</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"></span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> \param s vector to modify</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">*/</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#ab142f5e4b3fca998b6064b6f76e0ba9a">cvec_phas_ones</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"></span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">/** set all norm and phas elements to zero</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"></span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> \param s vector to modify</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"></span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">*/</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="keywordtype">void</span> <a class="code" href="cvec_8h.html#aad97e5bf9b6cbd5942f0083fdbf398ec">cvec_zeros</a>(<a class="code" href="structcvec__t.html">cvec_t</a> *s);</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> }</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="preprocessor">#endif </span><span class="comment">/* _AUBIO__CVEC_H */</span><span class="preprocessor"></span></div><div class="ttc" id="cvec_8h_html_aa99a32878355b0ea7b9d5293dda88d05"><div class="ttname"><a href="cvec_8h.html#aa99a32878355b0ea7b9d5293dda88d05">cvec_norm_zeros</a></div><div class="ttdeci">void cvec_norm_zeros(cvec_t *s)</div><div class="ttdoc">set all norm elements to zero </div></div>
<div class="ttc" id="cvec_8h_html_aabb35c55a0a202ddb64a9bd67cda962a"><div class="ttname"><a href="cvec_8h.html#aabb35c55a0a202ddb64a9bd67cda962a">cvec_norm_ones</a></div><div class="ttdeci">void cvec_norm_ones(cvec_t *s)</div><div class="ttdoc">set all norm elements to one </div></div>
<div class="ttc" id="structcvec__t_html_a8784dac0b4a6cb0fe0c201f54d3df006"><div class="ttname"><a href="structcvec__t.html#a8784dac0b4a6cb0fe0c201f54d3df006">cvec_t::length</a></div><div class="ttdeci">uint_t length</div><div class="ttdoc">length of buffer = (requested length)/2 + 1 </div><div class="ttdef"><b>Definition:</b> <a href="cvec_8h_source.html#l00064">cvec.h:64</a></div></div>
<div class="ttc" id="cvec_8h_html_ade1260448cbfb3302cee36a94311b4a4"><div class="ttname"><a href="cvec_8h.html#ade1260448cbfb3302cee36a94311b4a4">cvec_phas_set_sample</a></div><div class="ttdeci">void cvec_phas_set_sample(cvec_t *s, smpl_t val, uint_t position)</div><div class="ttdoc">write phase value in a complex buffer </div></div>
<div class="ttc" id="types_8h_html_a5d7119468d78a1dc35cf76d0adfb1436"><div class="ttname"><a href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a></div><div class="ttdeci">float smpl_t</div><div class="ttdoc">short sample format (32 or 64 bits) </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00041">types.h:41</a></div></div>
<div class="ttc" id="cvec_8h_html_ab088860d6c00321a61ef9a4a833c3d1e"><div class="ttname"><a href="cvec_8h.html#ab088860d6c00321a61ef9a4a833c3d1e">cvec_norm_get_data</a></div><div class="ttdeci">smpl_t * cvec_norm_get_data(cvec_t *s)</div><div class="ttdoc">read norm data from a complex buffer </div></div>
<div class="ttc" id="cvec_8h_html_ae399da2b544a4148f7a87fb12202c9c0"><div class="ttname"><a href="cvec_8h.html#ae399da2b544a4148f7a87fb12202c9c0">cvec_norm_set_sample</a></div><div class="ttdeci">void cvec_norm_set_sample(cvec_t *s, smpl_t val, uint_t position)</div><div class="ttdoc">write norm value in a complex buffer </div></div>
<div class="ttc" id="structcvec__t_html_a25ee232234c0585a6a4f6de27e1f8dbb"><div class="ttname"><a href="structcvec__t.html#a25ee232234c0585a6a4f6de27e1f8dbb">cvec_t::norm</a></div><div class="ttdeci">smpl_t * norm</div><div class="ttdoc">norm array of size cvec_t.length </div><div class="ttdef"><b>Definition:</b> <a href="cvec_8h_source.html#l00065">cvec.h:65</a></div></div>
<div class="ttc" id="cvec_8h_html_a910299ca4c79f87a426f1bfb970ec77a"><div class="ttname"><a href="cvec_8h.html#a910299ca4c79f87a426f1bfb970ec77a">cvec_print</a></div><div class="ttdeci">void cvec_print(cvec_t *s)</div><div class="ttdoc">print out cvec data </div></div>
<div class="ttc" id="cvec_8h_html_a98c745b15cea1b81e62cbb6fb21b0c56"><div class="ttname"><a href="cvec_8h.html#a98c745b15cea1b81e62cbb6fb21b0c56">del_cvec</a></div><div class="ttdeci">void del_cvec(cvec_t *s)</div><div class="ttdoc">cvec_t buffer deletion function </div></div>
<div class="ttc" id="cvec_8h_html_afbb7fc65d12893e512be56ec0f5dc5f0"><div class="ttname"><a href="cvec_8h.html#afbb7fc65d12893e512be56ec0f5dc5f0">new_cvec</a></div><div class="ttdeci">cvec_t * new_cvec(uint_t length)</div><div class="ttdoc">cvec_t buffer creation function </div></div>
<div class="ttc" id="cvec_8h_html_a7416ee033e36ef40e795c7ecbd0d6757"><div class="ttname"><a href="cvec_8h.html#a7416ee033e36ef40e795c7ecbd0d6757">cvec_copy</a></div><div class="ttdeci">void cvec_copy(cvec_t *s, cvec_t *t)</div><div class="ttdoc">make a copy of a vector </div></div>
<div class="ttc" id="cvec_8h_html_aed688a09429eab715b6a3568a367ec05"><div class="ttname"><a href="cvec_8h.html#aed688a09429eab715b6a3568a367ec05">cvec_phas_get_sample</a></div><div class="ttdeci">smpl_t cvec_phas_get_sample(cvec_t *s, uint_t position)</div><div class="ttdoc">read phase value from a complex buffer </div></div>
<div class="ttc" id="structcvec__t_html_a3a2b1542ce3ee5d29a1c364f720a20f3"><div class="ttname"><a href="structcvec__t.html#a3a2b1542ce3ee5d29a1c364f720a20f3">cvec_t::phas</a></div><div class="ttdeci">smpl_t * phas</div><div class="ttdoc">phase array of size cvec_t.length </div><div class="ttdef"><b>Definition:</b> <a href="cvec_8h_source.html#l00066">cvec.h:66</a></div></div>
<div class="ttc" id="cvec_8h_html_aa1a7723e4a99e44acfee444e09604e23"><div class="ttname"><a href="cvec_8h.html#aa1a7723e4a99e44acfee444e09604e23">cvec_phas_get_data</a></div><div class="ttdeci">smpl_t * cvec_phas_get_data(cvec_t *s)</div><div class="ttdoc">read phase data from a complex buffer </div></div>
<div class="ttc" id="cvec_8h_html_abeba6a97810474913e0374a298a2218b"><div class="ttname"><a href="cvec_8h.html#abeba6a97810474913e0374a298a2218b">cvec_norm_get_sample</a></div><div class="ttdeci">smpl_t cvec_norm_get_sample(cvec_t *s, uint_t position)</div><div class="ttdoc">read norm value from a complex buffer </div></div>
<div class="ttc" id="cvec_8h_html_ad625a322c57a1dae0d256b958f734221"><div class="ttname"><a href="cvec_8h.html#ad625a322c57a1dae0d256b958f734221">cvec_norm_set_all</a></div><div class="ttdeci">void cvec_norm_set_all(cvec_t *s, smpl_t val)</div><div class="ttdoc">set all norm elements to a given value </div></div>
<div class="ttc" id="structcvec__t_html"><div class="ttname"><a href="structcvec__t.html">cvec_t</a></div><div class="ttdoc">Vector of real-valued phase and spectrum data. </div><div class="ttdef"><b>Definition:</b> <a href="cvec_8h_source.html#l00063">cvec.h:63</a></div></div>
<div class="ttc" id="cvec_8h_html_a99509bb159e68f784bded2e4d57cd4ca"><div class="ttname"><a href="cvec_8h.html#a99509bb159e68f784bded2e4d57cd4ca">cvec_phas_set_all</a></div><div class="ttdeci">void cvec_phas_set_all(cvec_t *s, smpl_t val)</div><div class="ttdoc">set all phase elements to a given value </div></div>
<div class="ttc" id="types_8h_html_a12a1e9b3ce141648783a82445d02b58d"><div class="ttname"><a href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a></div><div class="ttdeci">unsigned int uint_t</div><div class="ttdoc">unsigned integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00060">types.h:60</a></div></div>
<div class="ttc" id="cvec_8h_html_a1b266a8dc5043ddc86db1dca0861166e"><div class="ttname"><a href="cvec_8h.html#a1b266a8dc5043ddc86db1dca0861166e">cvec_phas_zeros</a></div><div class="ttdeci">void cvec_phas_zeros(cvec_t *s)</div><div class="ttdoc">set all phase elements to zero </div></div>
<div class="ttc" id="cvec_8h_html_ab142f5e4b3fca998b6064b6f76e0ba9a"><div class="ttname"><a href="cvec_8h.html#ab142f5e4b3fca998b6064b6f76e0ba9a">cvec_phas_ones</a></div><div class="ttdeci">void cvec_phas_ones(cvec_t *s)</div><div class="ttdoc">set all phase elements to one </div></div>
<div class="ttc" id="cvec_8h_html_aad97e5bf9b6cbd5942f0083fdbf398ec"><div class="ttname"><a href="cvec_8h.html#aad97e5bf9b6cbd5942f0083fdbf398ec">cvec_zeros</a></div><div class="ttdeci">void cvec_zeros(cvec_t *s)</div><div class="ttdoc">set all norm and phas elements to zero </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
