<!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: lvec.h File Reference</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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">lvec.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Vector of real-valued data in double precision.
<a href="#details">More...</a></p>
<p><a href="lvec_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structlvec__t.html">lvec_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Buffer for real data in double precision. <a href="structlvec__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a36df7e5a5ab846fedfc4b65938de3714"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlvec__t.html">lvec_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a36df7e5a5ab846fedfc4b65938de3714">new_lvec</a> (<a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> length)</td></tr>
<tr class="memdesc:a36df7e5a5ab846fedfc4b65938de3714"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structlvec__t.html" title="Buffer for real data in double precision. ">lvec_t</a> buffer creation function <a href="#a36df7e5a5ab846fedfc4b65938de3714">More...</a><br /></td></tr>
<tr class="separator:a36df7e5a5ab846fedfc4b65938de3714"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d558b47bdce137e3771c6989e253e2c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a4d558b47bdce137e3771c6989e253e2c">del_lvec</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s)</td></tr>
<tr class="memdesc:a4d558b47bdce137e3771c6989e253e2c"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structlvec__t.html" title="Buffer for real data in double precision. ">lvec_t</a> buffer deletion function <a href="#a4d558b47bdce137e3771c6989e253e2c">More...</a><br /></td></tr>
<tr class="separator:a4d558b47bdce137e3771c6989e253e2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51c487b29fc7c7e9f55ebd8cf734fa02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a8b426f5dc106056d14afed88c7a17f06">lsmp_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a51c487b29fc7c7e9f55ebd8cf734fa02">lvec_get_sample</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> position)</td></tr>
<tr class="memdesc:a51c487b29fc7c7e9f55ebd8cf734fa02"><td class="mdescLeft"> </td><td class="mdescRight">read sample value in a buffer <a href="#a51c487b29fc7c7e9f55ebd8cf734fa02">More...</a><br /></td></tr>
<tr class="separator:a51c487b29fc7c7e9f55ebd8cf734fa02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa39fac7f5116a42b7d7a97cdfeae05c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#aa39fac7f5116a42b7d7a97cdfeae05c2">lvec_set_sample</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s, <a class="el" href="types_8h.html#a8b426f5dc106056d14afed88c7a17f06">lsmp_t</a> data, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> position)</td></tr>
<tr class="memdesc:aa39fac7f5116a42b7d7a97cdfeae05c2"><td class="mdescLeft"> </td><td class="mdescRight">write sample value in a buffer <a href="#aa39fac7f5116a42b7d7a97cdfeae05c2">More...</a><br /></td></tr>
<tr class="separator:aa39fac7f5116a42b7d7a97cdfeae05c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e97fe575ee91d776c3bbabfae46feee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a8b426f5dc106056d14afed88c7a17f06">lsmp_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a8e97fe575ee91d776c3bbabfae46feee">lvec_get_data</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s)</td></tr>
<tr class="memdesc:a8e97fe575ee91d776c3bbabfae46feee"><td class="mdescLeft"> </td><td class="mdescRight">read data from a buffer <a href="#a8e97fe575ee91d776c3bbabfae46feee">More...</a><br /></td></tr>
<tr class="separator:a8e97fe575ee91d776c3bbabfae46feee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f7430bda846b6c7343572a06381c259"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a8f7430bda846b6c7343572a06381c259">lvec_print</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s)</td></tr>
<tr class="memdesc:a8f7430bda846b6c7343572a06381c259"><td class="mdescLeft"> </td><td class="mdescRight">print out lvec data <a href="#a8f7430bda846b6c7343572a06381c259">More...</a><br /></td></tr>
<tr class="separator:a8f7430bda846b6c7343572a06381c259"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b77cf8de35c462c3a7cbafc2af59843"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a7b77cf8de35c462c3a7cbafc2af59843">lvec_set_all</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s, <a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> val)</td></tr>
<tr class="memdesc:a7b77cf8de35c462c3a7cbafc2af59843"><td class="mdescLeft"> </td><td class="mdescRight">set all elements to a given value <a href="#a7b77cf8de35c462c3a7cbafc2af59843">More...</a><br /></td></tr>
<tr class="separator:a7b77cf8de35c462c3a7cbafc2af59843"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a165a1e834421c4b5cf05e4e8de1a937c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a165a1e834421c4b5cf05e4e8de1a937c">lvec_zeros</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s)</td></tr>
<tr class="memdesc:a165a1e834421c4b5cf05e4e8de1a937c"><td class="mdescLeft"> </td><td class="mdescRight">set all elements to zero <a href="#a165a1e834421c4b5cf05e4e8de1a937c">More...</a><br /></td></tr>
<tr class="separator:a165a1e834421c4b5cf05e4e8de1a937c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03b179e051c134217c23034044aacda2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lvec_8h.html#a03b179e051c134217c23034044aacda2">lvec_ones</a> (<a class="el" href="structlvec__t.html">lvec_t</a> *s)</td></tr>
<tr class="memdesc:a03b179e051c134217c23034044aacda2"><td class="mdescLeft"> </td><td class="mdescRight">set all elements to ones <a href="#a03b179e051c134217c23034044aacda2">More...</a><br /></td></tr>
<tr class="separator:a03b179e051c134217c23034044aacda2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Vector of real-valued data in double precision. </p>
<p>This file specifies the <a class="el" href="structlvec__t.html" title="Buffer for real data in double precision. ">lvec_t</a> buffer type, which is used in some places in aubio to store a vector of <a class="el" href="types_8h.html#a8b426f5dc106056d14afed88c7a17f06" title="long sample format (64 bits or more) ">lsmp_t</a>.</p>
<p>Note: the <a class="el" href="structlvec__t.html" title="Buffer for real data in double precision. ">lvec_t</a> data type is required in some algorithms such as IIR filters (see <a class="el" href="filter_8h.html" title="Digital filter. ">temporal/filter.h</a>). </p>
<p class="definition">Definition in file <a class="el" href="lvec_8h_source.html">lvec.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a4d558b47bdce137e3771c6989e253e2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d558b47bdce137e3771c6989e253e2c">◆ </a></span>del_lvec()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void del_lvec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structlvec__t.html" title="Buffer for real data in double precision. ">lvec_t</a> buffer deletion function </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>buffer to delete as returned by <a class="el" href="lvec_8h.html#a36df7e5a5ab846fedfc4b65938de3714" title="lvec_t buffer creation function ">new_lvec()</a> </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="test-lvec_8c-example.html#a7">test-lvec.c</a>.</dd>
</dl>
</div>
</div>
<a id="a8e97fe575ee91d776c3bbabfae46feee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e97fe575ee91d776c3bbabfae46feee">◆ </a></span>lvec_get_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a8b426f5dc106056d14afed88c7a17f06">lsmp_t</a>* lvec_get_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>read data from a buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>vector to read from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a51c487b29fc7c7e9f55ebd8cf734fa02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51c487b29fc7c7e9f55ebd8cf734fa02">◆ </a></span>lvec_get_sample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a8b426f5dc106056d14afed88c7a17f06">lsmp_t</a> lvec_get_sample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>read sample value in a buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>vector to read from </td></tr>
<tr><td class="paramname">position</td><td>sample position to read from </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="test-lvec_8c-example.html#a3">test-lvec.c</a>.</dd>
</dl>
</div>
</div>
<a id="a03b179e051c134217c23034044aacda2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03b179e051c134217c23034044aacda2">◆ </a></span>lvec_ones()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lvec_ones </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set all elements to ones </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>vector to modify </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="test-lvec_8c-example.html#a5">test-lvec.c</a>.</dd>
</dl>
</div>
</div>
<a id="a8f7430bda846b6c7343572a06381c259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f7430bda846b6c7343572a06381c259">◆ </a></span>lvec_print()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lvec_print </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>print out lvec data </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>vector to print out </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="test-lvec_8c-example.html#a4">test-lvec.c</a>.</dd>
</dl>
</div>
</div>
<a id="a7b77cf8de35c462c3a7cbafc2af59843"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b77cf8de35c462c3a7cbafc2af59843">◆ </a></span>lvec_set_all()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lvec_set_all </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set all elements to a given value </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>vector to modify </td></tr>
<tr><td class="paramname">val</td><td>value to set elements to </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="test-lvec_8c-example.html#a6">test-lvec.c</a>.</dd>
</dl>
</div>
</div>
<a id="aa39fac7f5116a42b7d7a97cdfeae05c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa39fac7f5116a42b7d7a97cdfeae05c2">◆ </a></span>lvec_set_sample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lvec_set_sample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a8b426f5dc106056d14afed88c7a17f06">lsmp_t</a> </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>write sample value in a buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>vector to write to </td></tr>
<tr><td class="paramname">data</td><td>value to write in s->data[position] </td></tr>
<tr><td class="paramname">position</td><td>sample position to write to </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="test-lvec_8c-example.html#a2">test-lvec.c</a>.</dd>
</dl>
</div>
</div>
<a id="a165a1e834421c4b5cf05e4e8de1a937c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a165a1e834421c4b5cf05e4e8de1a937c">◆ </a></span>lvec_zeros()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lvec_zeros </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlvec__t.html">lvec_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set all elements to zero </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>vector to modify </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a36df7e5a5ab846fedfc4b65938de3714"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36df7e5a5ab846fedfc4b65938de3714">◆ </a></span>new_lvec()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlvec__t.html">lvec_t</a>* new_lvec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>length</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structlvec__t.html" title="Buffer for real data in double precision. ">lvec_t</a> buffer creation function </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>the length of the buffer to create </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="test-lvec_8c-example.html#a1">test-lvec.c</a>.</dd>
</dl>
</div>
</div>
</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>
