ref: c39e469c76573e0fd129e7f65c7286af82d7702b
dir: /docs/leaf/group__tenvpd.html/
<!-- HTML header for doxygen 1.8.18--> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>LEAF: tEnvPD</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> <script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script> <!-- <script src="/js/template.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/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function() { init_search(); }); /* @license-end */ </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> <!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> --> </head> <body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()"> <div> <!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr> </tr> </tbody> </table> </div> <!-- end header part --> </div> </body> </html><!-- Generated by Doxygen 1.8.16 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </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="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">tEnvPD<div class="ingroups"><a class="el" href="group__analysis.html">Analysis</a></div></div> </div> </div><!--header--> <div class="contents"> <p>ENV~ from PD, modified for <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a>. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga49c2752feb9890d139e296e75ea74b9b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tenvpd.html#ga49c2752feb9890d139e296e75ea74b9b">tEnvPD_init</a> (tEnvPD *const, int windowSize, int hopSize, int blockSize, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr> <tr class="memdesc:ga49c2752feb9890d139e296e75ea74b9b"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tEnvPD to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. <a href="group__tenvpd.html#ga49c2752feb9890d139e296e75ea74b9b">More...</a><br /></td></tr> <tr class="separator:ga49c2752feb9890d139e296e75ea74b9b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga31446fa14ee57bd0f19d260f4c748e2e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tenvpd.html#ga31446fa14ee57bd0f19d260f4c748e2e">tEnvPD_initToPool</a> (tEnvPD *const, int windowSize, int hopSize, int blockSize, tMempool *const)</td></tr> <tr class="memdesc:ga31446fa14ee57bd0f19d260f4c748e2e"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tEnvPD to a specified mempool. <a href="group__tenvpd.html#ga31446fa14ee57bd0f19d260f4c748e2e">More...</a><br /></td></tr> <tr class="separator:ga31446fa14ee57bd0f19d260f4c748e2e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga28ade0e2893d6e94bca4dfa6cdd0f0ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tenvpd.html#ga28ade0e2893d6e94bca4dfa6cdd0f0ea">tEnvPD_free</a> (tEnvPD *const)</td></tr> <tr class="memdesc:ga28ade0e2893d6e94bca4dfa6cdd0f0ea"><td class="mdescLeft"> </td><td class="mdescRight">Free a tEnvPD from its mempool. <a href="group__tenvpd.html#ga28ade0e2893d6e94bca4dfa6cdd0f0ea">More...</a><br /></td></tr> <tr class="separator:ga28ade0e2893d6e94bca4dfa6cdd0f0ea"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga73ca443b1b36dc5995bf1659fdb242ab"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tenvpd.html#ga73ca443b1b36dc5995bf1659fdb242ab">tEnvPD_tick</a> (tEnvPD *const)</td></tr> <tr class="separator:ga73ca443b1b36dc5995bf1659fdb242ab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga15bd0b8018ca2c67120053eb8cd1fc9a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tenvpd.html#ga15bd0b8018ca2c67120053eb8cd1fc9a">tEnvPD_processBlock</a> (tEnvPD *const, float *in)</td></tr> <tr class="separator:ga15bd0b8018ca2c67120053eb8cd1fc9a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>ENV~ from PD, modified for <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a>. </p> <h2 class="groupheader">Function Documentation</h2> <a id="ga49c2752feb9890d139e296e75ea74b9b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga49c2752feb9890d139e296e75ea74b9b">◆ </a></span>tEnvPD_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tEnvPD_init </td> <td>(</td> <td class="paramtype">tEnvPD * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>windowSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>blockSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const </td> <td class="paramname"><em>leaf</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a tEnvPD to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">env</td><td>A pointer to the tEnvPD to initialize. </td></tr> <tr><td class="paramname">windowSize</td><td></td></tr> <tr><td class="paramname">hopSize</td><td></td></tr> <tr><td class="paramname">blockSize</td><td></td></tr> <tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga31446fa14ee57bd0f19d260f4c748e2e"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga31446fa14ee57bd0f19d260f4c748e2e">◆ </a></span>tEnvPD_initToPool()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tEnvPD_initToPool </td> <td>(</td> <td class="paramtype">tEnvPD * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>windowSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>blockSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">tMempool * const </td> <td class="paramname"> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a tEnvPD to a specified mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">env</td><td>A pointer to the tEnvPD to initialize. </td></tr> <tr><td class="paramname">windowSize</td><td></td></tr> <tr><td class="paramname">hopSize</td><td></td></tr> <tr><td class="paramname">blockSize</td><td></td></tr> <tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga28ade0e2893d6e94bca4dfa6cdd0f0ea"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga28ade0e2893d6e94bca4dfa6cdd0f0ea">◆ </a></span>tEnvPD_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tEnvPD_free </td> <td>(</td> <td class="paramtype">tEnvPD * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free a tEnvPD from its mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">env</td><td>A pointer to the tEnvPD to free. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga73ca443b1b36dc5995bf1659fdb242ab"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga73ca443b1b36dc5995bf1659fdb242ab">◆ </a></span>tEnvPD_tick()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tEnvPD_tick </td> <td>(</td> <td class="paramtype">tEnvPD * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">env</td><td></td></tr> </table> </dd> </dl> </div> </div> <a id="ga15bd0b8018ca2c67120053eb8cd1fc9a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga15bd0b8018ca2c67120053eb8cd1fc9a">◆ </a></span>tEnvPD_processBlock()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tEnvPD_processBlock </td> <td>(</td> <td class="paramtype">tEnvPD * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float * </td> <td class="paramname"><em>in</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">env</td><td></td></tr> <tr><td class="paramname">inputBlock</td><td> </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- HTML footer for doxygen 1.8.18--> <!-- start footer part --> </body> </html>