ref: 4c8de0f3852178244ffaef00f6b411c8d1b8c5e2
dir: /docs/leaf/group__tallpassdelay.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: tAllpassDelay</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">tAllpassDelay<div class="ingroups"><a class="el" href="group__delay.html">Delay</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Allpass-interpolating delay, reimplemented from STK (Cook and Scavone). <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:gac68b64e119c315b545227a9404c2dedc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#gac68b64e119c315b545227a9404c2dedc">tAllpassDelay_init</a> (tAllpassDelay *const, float delay, uint32_t maxDelay, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr> <tr class="memdesc:gac68b64e119c315b545227a9404c2dedc"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tAllpassDelay 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__tallpassdelay.html#gac68b64e119c315b545227a9404c2dedc">More...</a><br /></td></tr> <tr class="separator:gac68b64e119c315b545227a9404c2dedc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9a65c14cde90540162d7fb94bedd4013"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga9a65c14cde90540162d7fb94bedd4013">tAllpassDelay_initToPool</a> (tAllpassDelay *const, float delay, uint32_t maxDelay, tMempool *const)</td></tr> <tr class="memdesc:ga9a65c14cde90540162d7fb94bedd4013"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tAllpassDelay to a specified mempool. <a href="group__tallpassdelay.html#ga9a65c14cde90540162d7fb94bedd4013">More...</a><br /></td></tr> <tr class="separator:ga9a65c14cde90540162d7fb94bedd4013"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaae4b75bede117322eedbb806f92af672"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#gaae4b75bede117322eedbb806f92af672">tAllpassDelay_free</a> (tAllpassDelay *const)</td></tr> <tr class="memdesc:gaae4b75bede117322eedbb806f92af672"><td class="mdescLeft"> </td><td class="mdescRight">Free a tAllpassDelay from its mempool. <a href="group__tallpassdelay.html#gaae4b75bede117322eedbb806f92af672">More...</a><br /></td></tr> <tr class="separator:gaae4b75bede117322eedbb806f92af672"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga22a3124a087816518ae22e7dd57049dd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga22a3124a087816518ae22e7dd57049dd">tAllpassDelay_clear</a> (tAllpassDelay *const)</td></tr> <tr class="separator:ga22a3124a087816518ae22e7dd57049dd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga83b93819de2b2d825247c47b830d918c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga83b93819de2b2d825247c47b830d918c">tAllpassDelay_setDelay</a> (tAllpassDelay *const, float delay)</td></tr> <tr class="separator:ga83b93819de2b2d825247c47b830d918c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7cda781e73a82d91e49f3ce5955cbd0a"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga7cda781e73a82d91e49f3ce5955cbd0a">tAllpassDelay_getDelay</a> (tAllpassDelay *const)</td></tr> <tr class="separator:ga7cda781e73a82d91e49f3ce5955cbd0a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga000dae89babb537265f9b56f8ce5560b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga000dae89babb537265f9b56f8ce5560b">tAllpassDelay_tapIn</a> (tAllpassDelay *const, float in, uint32_t tapDelay)</td></tr> <tr class="separator:ga000dae89babb537265f9b56f8ce5560b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0348f7e531aa956c0e4f1e9eb3bb208a"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga0348f7e531aa956c0e4f1e9eb3bb208a">tAllpassDelay_tapOut</a> (tAllpassDelay *const, uint32_t tapDelay)</td></tr> <tr class="separator:ga0348f7e531aa956c0e4f1e9eb3bb208a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga25124f2fc78144daa86e0008417f410c"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga25124f2fc78144daa86e0008417f410c">tAllpassDelay_addTo</a> (tAllpassDelay *const, float value, uint32_t tapDelay)</td></tr> <tr class="separator:ga25124f2fc78144daa86e0008417f410c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6145fe6d2e4fd9e423d96725183498cc"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga6145fe6d2e4fd9e423d96725183498cc">tAllpassDelay_tick</a> (tAllpassDelay *const, float sample)</td></tr> <tr class="separator:ga6145fe6d2e4fd9e423d96725183498cc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab6937352ad500b205c4fc5e822937735"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#gab6937352ad500b205c4fc5e822937735">tAllpassDelay_getLastOut</a> (tAllpassDelay *const)</td></tr> <tr class="separator:gab6937352ad500b205c4fc5e822937735"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga01be8563825023d090b5dbd750f2bba3"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tallpassdelay.html#ga01be8563825023d090b5dbd750f2bba3">tAllpassDelay_getLastIn</a> (tAllpassDelay *const)</td></tr> <tr class="separator:ga01be8563825023d090b5dbd750f2bba3"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Allpass-interpolating delay, reimplemented from STK (Cook and Scavone). </p> <h2 class="groupheader">Function Documentation</h2> <a id="gac68b64e119c315b545227a9404c2dedc"></a> <h2 class="memtitle"><span class="permalink"><a href="#gac68b64e119c315b545227a9404c2dedc">◆ </a></span>tAllpassDelay_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tAllpassDelay_init </td> <td>(</td> <td class="paramtype">tAllpassDelay * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>delay</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>maxDelay</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 tAllpassDelay 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">delay</td><td>A pointer to the tAllpassDelay to initialize. </td></tr> <tr><td class="paramname">initialLength</td><td></td></tr> <tr><td class="paramname">maxLength</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="ga9a65c14cde90540162d7fb94bedd4013"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9a65c14cde90540162d7fb94bedd4013">◆ </a></span>tAllpassDelay_initToPool()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tAllpassDelay_initToPool </td> <td>(</td> <td class="paramtype">tAllpassDelay * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>delay</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>maxDelay</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 tAllpassDelay to a specified mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">delay</td><td>A pointer to the tAllpassDelay to initialize. </td></tr> <tr><td class="paramname">initialLength</td><td></td></tr> <tr><td class="paramname">maxLength</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="gaae4b75bede117322eedbb806f92af672"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaae4b75bede117322eedbb806f92af672">◆ </a></span>tAllpassDelay_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tAllpassDelay_free </td> <td>(</td> <td class="paramtype">tAllpassDelay * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free a tAllpassDelay from its mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">delay</td><td>A pointer to the tAllpassDelay to free. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga22a3124a087816518ae22e7dd57049dd"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga22a3124a087816518ae22e7dd57049dd">◆ </a></span>tAllpassDelay_clear()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tAllpassDelay_clear </td> <td>(</td> <td class="paramtype">tAllpassDelay * 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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga83b93819de2b2d825247c47b830d918c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga83b93819de2b2d825247c47b830d918c">◆ </a></span>tAllpassDelay_setDelay()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tAllpassDelay_setDelay </td> <td>(</td> <td class="paramtype">tAllpassDelay * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>delay</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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> <tr><td class="paramname">delayLength</td><td>The new delay length in samples. Cannot be greater than the max delay length given on initialization. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga7cda781e73a82d91e49f3ce5955cbd0a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga7cda781e73a82d91e49f3ce5955cbd0a">◆ </a></span>tAllpassDelay_getDelay()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tAllpassDelay_getDelay </td> <td>(</td> <td class="paramtype">tAllpassDelay * 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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The current delay length in samples. </dd></dl> </div> </div> <a id="ga000dae89babb537265f9b56f8ce5560b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga000dae89babb537265f9b56f8ce5560b">◆ </a></span>tAllpassDelay_tapIn()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tAllpassDelay_tapIn </td> <td>(</td> <td class="paramtype">tAllpassDelay * 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 class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>tapDelay</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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> <tr><td class="paramname">inptu</td><td></td></tr> <tr><td class="paramname">position</td><td></td></tr> </table> </dd> </dl> </div> </div> <a id="ga0348f7e531aa956c0e4f1e9eb3bb208a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga0348f7e531aa956c0e4f1e9eb3bb208a">◆ </a></span>tAllpassDelay_tapOut()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tAllpassDelay_tapOut </td> <td>(</td> <td class="paramtype">tAllpassDelay * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>tapDelay</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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> <tr><td class="paramname">position</td><td></td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd></dd></dl> </div> </div> <a id="ga25124f2fc78144daa86e0008417f410c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga25124f2fc78144daa86e0008417f410c">◆ </a></span>tAllpassDelay_addTo()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tAllpassDelay_addTo </td> <td>(</td> <td class="paramtype">tAllpassDelay * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>tapDelay</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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> <tr><td class="paramname">input</td><td></td></tr> <tr><td class="paramname">position</td><td></td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd></dd></dl> </div> </div> <a id="ga6145fe6d2e4fd9e423d96725183498cc"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga6145fe6d2e4fd9e423d96725183498cc">◆ </a></span>tAllpassDelay_tick()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tAllpassDelay_tick </td> <td>(</td> <td class="paramtype">tAllpassDelay * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>sample</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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> <tr><td class="paramname">input</td><td></td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd></dd></dl> </div> </div> <a id="gab6937352ad500b205c4fc5e822937735"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab6937352ad500b205c4fc5e822937735">◆ </a></span>tAllpassDelay_getLastOut()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tAllpassDelay_getLastOut </td> <td>(</td> <td class="paramtype">tAllpassDelay * 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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd></dd></dl> </div> </div> <a id="ga01be8563825023d090b5dbd750f2bba3"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga01be8563825023d090b5dbd750f2bba3">◆ </a></span>tAllpassDelay_getLastIn()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tAllpassDelay_getLastIn </td> <td>(</td> <td class="paramtype">tAllpassDelay * 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">delay</td><td>A pointer to the relevant tAllpassDelay. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd> </dd></dl> </div> </div> </div><!-- contents --> <!-- HTML footer for doxygen 1.8.18--> <!-- start footer part --> </body> </html>