classapf_1_1BlockDelayLine.html

<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audio Processing Framework (APF): apf::BlockDelayLine&lt; T, Container &gt; Class Template 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>
<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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">Audio Processing Framework (APF)<span id="projectnumber">&#160;version 0.5.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceapf.html">apf</a></li><li class="navelem"><a class="el" href="classapf_1_1BlockDelayLine.html">BlockDelayLine</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classapf_1_1BlockDelayLine-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">apf::BlockDelayLine&lt; T, Container &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Block-based delay line.  
 <a href="classapf_1_1BlockDelayLine.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="blockdelayline_8h_source.html">apf/blockdelayline.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a08e30eb3059a17df4eca09b3b1c1c341"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a08e30eb3059a17df4eca09b3b1c1c341">size_type</a> = typename Container::size_type</td></tr>
<tr class="separator:a08e30eb3059a17df4eca09b3b1c1c341"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe8bf580c7e1771563bc653525e5f1c4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#afe8bf580c7e1771563bc653525e5f1c4">difference_type</a> = typename Container::difference_type</td></tr>
<tr class="separator:afe8bf580c7e1771563bc653525e5f1c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab8f0e01e3aae29fe29193e8e5543885"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#aab8f0e01e3aae29fe29193e8e5543885">pointer</a> = typename Container::pointer</td></tr>
<tr class="separator:aab8f0e01e3aae29fe29193e8e5543885"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d4918a62cb4701f9dc3344daa8a9829"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a9d4918a62cb4701f9dc3344daa8a9829">circulator</a> = <a class="el" href="classapf_1_1circular__iterator.html">apf::circular_iterator</a>&lt; typename Container::iterator &gt;</td></tr>
<tr class="separator:a9d4918a62cb4701f9dc3344daa8a9829"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6412ee03e9fd04c41dde7bed0f48afbb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a6412ee03e9fd04c41dde7bed0f48afbb">BlockDelayLine</a> (size_type block_size, size_type max_delay)</td></tr>
<tr class="memdesc:a6412ee03e9fd04c41dde7bed0f48afbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="classapf_1_1BlockDelayLine.html#a6412ee03e9fd04c41dde7bed0f48afbb">More...</a><br /></td></tr>
<tr class="separator:a6412ee03e9fd04c41dde7bed0f48afbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63204ea357c8365b0988442388026d68"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a63204ea357c8365b0988442388026d68">delay_is_valid</a> (size_type delay, size_type &amp;corrected) const</td></tr>
<tr class="memdesc:a63204ea357c8365b0988442388026d68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a given delay is valid.  <a href="classapf_1_1BlockDelayLine.html#a63204ea357c8365b0988442388026d68">More...</a><br /></td></tr>
<tr class="separator:a63204ea357c8365b0988442388026d68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77dc69ef1d87688a81b2227b86644a0c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a77dc69ef1d87688a81b2227b86644a0c">delay_is_valid</a> (size_type delay) const</td></tr>
<tr class="memdesc:a77dc69ef1d87688a81b2227b86644a0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return <b>true</b> if <code>delay</code> is valid.  <a href="classapf_1_1BlockDelayLine.html#a77dc69ef1d87688a81b2227b86644a0c">More...</a><br /></td></tr>
<tr class="separator:a77dc69ef1d87688a81b2227b86644a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b89b44fdc1f7dd3bdecd3a58c6c47c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3">advance</a> ()</td></tr>
<tr class="memdesc:a3b89b44fdc1f7dd3bdecd3a58c6c47c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the internal iterators/pointers to the next block.  <a href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3">More...</a><br /></td></tr>
<tr class="separator:a3b89b44fdc1f7dd3bdecd3a58c6c47c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab128577db27eeb2c0e341df97f27d83f"><td class="memTemplParams" colspan="2">template&lt;typename Iterator &gt; </td></tr>
<tr class="memitem:ab128577db27eeb2c0e341df97f27d83f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#ab128577db27eeb2c0e341df97f27d83f">write_block</a> (Iterator source)</td></tr>
<tr class="memdesc:ab128577db27eeb2c0e341df97f27d83f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a block of data to the delay line.  <a href="classapf_1_1BlockDelayLine.html#ab128577db27eeb2c0e341df97f27d83f">More...</a><br /></td></tr>
<tr class="separator:ab128577db27eeb2c0e341df97f27d83f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4a0c228c818d55b50cce167828e1fd5"><td class="memTemplParams" colspan="2">template&lt;typename Iterator &gt; </td></tr>
<tr class="memitem:aa4a0c228c818d55b50cce167828e1fd5"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#aa4a0c228c818d55b50cce167828e1fd5">read_block</a> (Iterator destination, size_type delay) const</td></tr>
<tr class="memdesc:aa4a0c228c818d55b50cce167828e1fd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a block of data from the delay line.  <a href="classapf_1_1BlockDelayLine.html#aa4a0c228c818d55b50cce167828e1fd5">More...</a><br /></td></tr>
<tr class="separator:aa4a0c228c818d55b50cce167828e1fd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="memTemplParams" colspan="2">template&lt;typename Iterator &gt; </td></tr>
<tr class="memitem:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#afec5abc94b8f231b1b39f3c1dd80c81a">read_block</a> (Iterator destination, size_type delay, T weight) const</td></tr>
<tr class="memdesc:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read from the delay line and multiply each element by a given factor.  <a href="classapf_1_1BlockDelayLine.html#afec5abc94b8f231b1b39f3c1dd80c81a">More...</a><br /></td></tr>
<tr class="separator:afec5abc94b8f231b1b39f3c1dd80c81a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0554f7b7e4d6537dfeb682370be3b002"><td class="memItemLeft" align="right" valign="top">pointer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a0554f7b7e4d6537dfeb682370be3b002">get_write_pointer</a> () const</td></tr>
<tr class="memdesc:a0554f7b7e4d6537dfeb682370be3b002"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the write pointer.  <a href="classapf_1_1BlockDelayLine.html#a0554f7b7e4d6537dfeb682370be3b002">More...</a><br /></td></tr>
<tr class="separator:a0554f7b7e4d6537dfeb682370be3b002"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9774d36c26b58b1487220a6832267f15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classapf_1_1circular__iterator.html">circulator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a9774d36c26b58b1487220a6832267f15">get_read_circulator</a> (size_type delay=0) const</td></tr>
<tr class="memdesc:a9774d36c26b58b1487220a6832267f15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the read circulator.  <a href="classapf_1_1BlockDelayLine.html#a9774d36c26b58b1487220a6832267f15">More...</a><br /></td></tr>
<tr class="separator:a9774d36c26b58b1487220a6832267f15"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aedbb09fc15ddd696fc8d83bbe4673f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classapf_1_1circular__iterator.html">circulator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#aedbb09fc15ddd696fc8d83bbe4673f55">_get_data_circulator</a> () const</td></tr>
<tr class="memdesc:aedbb09fc15ddd696fc8d83bbe4673f55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a circular iterator to the sample with time 0.  <a href="classapf_1_1BlockDelayLine.html#aedbb09fc15ddd696fc8d83bbe4673f55">More...</a><br /></td></tr>
<tr class="separator:aedbb09fc15ddd696fc8d83bbe4673f55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a499ee411350674ed2c5763fc833bdb75"><td class="memItemLeft" align="right" valign="top">const size_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1BlockDelayLine.html#a499ee411350674ed2c5763fc833bdb75">_block_size</a></td></tr>
<tr class="memdesc:a499ee411350674ed2c5763fc833bdb75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of read/write blocks.  <a href="classapf_1_1BlockDelayLine.html#a499ee411350674ed2c5763fc833bdb75">More...</a><br /></td></tr>
<tr class="separator:a499ee411350674ed2c5763fc833bdb75"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T, typename Container = std::vector&lt;T&gt;&gt;<br />
class apf::BlockDelayLine&lt; T, Container &gt;</div><p >Block-based delay line. </p>
<p >This is a "write once, read many times" delay line. The write operation is simple and fast. The desired delay is specified at the more flexible read operation. </p>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00047">47</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a08e30eb3059a17df4eca09b3b1c1c341" name="a08e30eb3059a17df4eca09b3b1c1c341"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08e30eb3059a17df4eca09b3b1c1c341">&#9670;&nbsp;</a></span>size_type</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::size_type =  typename Container::size_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00050">50</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<a id="afe8bf580c7e1771563bc653525e5f1c4" name="afe8bf580c7e1771563bc653525e5f1c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe8bf580c7e1771563bc653525e5f1c4">&#9670;&nbsp;</a></span>difference_type</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::difference_type =  typename Container::difference_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00051">51</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<a id="aab8f0e01e3aae29fe29193e8e5543885" name="aab8f0e01e3aae29fe29193e8e5543885"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab8f0e01e3aae29fe29193e8e5543885">&#9670;&nbsp;</a></span>pointer</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::pointer =  typename Container::pointer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00052">52</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<a id="a9d4918a62cb4701f9dc3344daa8a9829" name="a9d4918a62cb4701f9dc3344daa8a9829"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d4918a62cb4701f9dc3344daa8a9829">&#9670;&nbsp;</a></span>circulator</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::circulator =  <a class="el" href="classapf_1_1circular__iterator.html">apf::circular_iterator</a>&lt;typename Container::iterator&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00053">53</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6412ee03e9fd04c41dde7bed0f48afbb" name="a6412ee03e9fd04c41dde7bed0f48afbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6412ee03e9fd04c41dde7bed0f48afbb">&#9670;&nbsp;</a></span>BlockDelayLine()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::BlockDelayLine </td>
          <td>(</td>
          <td class="paramtype">size_type&#160;</td>
          <td class="paramname"><em>block_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_type&#160;</td>
          <td class="paramname"><em>max_delay</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">block_size</td><td>Block size </td></tr>
    <tr><td class="paramname">max_delay</td><td>Maximum delay in samples </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00121">121</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

<p class="reference">References <a class="el" href="blockdelayline_8h_source.html#l00100">apf::BlockDelayLine&lt; T, Container &gt;::_block_size</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a63204ea357c8365b0988442388026d68" name="a63204ea357c8365b0988442388026d68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63204ea357c8365b0988442388026d68">&#9670;&nbsp;</a></span>delay_is_valid() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::delay_is_valid </td>
          <td>(</td>
          <td class="paramtype">size_type&#160;</td>
          <td class="paramname"><em>delay</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_type &amp;&#160;</td>
          <td class="paramname"><em>corrected</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Check if a given delay is valid. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir"></td><td class="paramname">delay</td><td>Desired delay </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">corrected</td><td>If valid, the same as <code>delay</code>, if not, the maximum possible delay. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> if <code>delay</code> is valid. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00062">62</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00266">apf::NonCausalBlockDelayLine&lt; T, Container &gt;::delay_is_valid()</a>, and <a class="el" href="blockdelayline_8h_source.html#l00070">apf::BlockDelayLine&lt; T, Container &gt;::delay_is_valid()</a>.</p>

</div>
</div>
<a id="a77dc69ef1d87688a81b2227b86644a0c" name="a77dc69ef1d87688a81b2227b86644a0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77dc69ef1d87688a81b2227b86644a0c">&#9670;&nbsp;</a></span>delay_is_valid() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::delay_is_valid </td>
          <td>(</td>
          <td class="paramtype">size_type&#160;</td>
          <td class="paramname"><em>delay</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return <b>true</b> if <code>delay</code> is valid. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classapf_1_1BlockDelayLine.html#a63204ea357c8365b0988442388026d68" title="Check if a given delay is valid.">delay_is_valid()</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00070">70</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

<p class="reference">References <a class="el" href="blockdelayline_8h_source.html#l00062">apf::BlockDelayLine&lt; T, Container &gt;::delay_is_valid()</a>.</p>

</div>
</div>
<a id="a3b89b44fdc1f7dd3bdecd3a58c6c47c3" name="a3b89b44fdc1f7dd3bdecd3a58c6c47c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b89b44fdc1f7dd3bdecd3a58c6c47c3">&#9670;&nbsp;</a></span>advance()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::advance </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Advance the internal iterators/pointers to the next block. </p>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00077">77</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

<p class="reference">References <a class="el" href="blockdelayline_8h_source.html#l00100">apf::BlockDelayLine&lt; T, Container &gt;::_block_size</a>.</p>

</div>
</div>
<a id="ab128577db27eeb2c0e341df97f27d83f" name="ab128577db27eeb2c0e341df97f27d83f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab128577db27eeb2c0e341df97f27d83f">&#9670;&nbsp;</a></span>write_block()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container &gt; </div>
<div class="memtemplate">
template&lt;typename Iterator &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::write_block </td>
          <td>(</td>
          <td class="paramtype">Iterator&#160;</td>
          <td class="paramname"><em>source</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Write a block of data to the delay line. </p>
<p >Before writing, the read and write pointers are advanced to the next block. If you don't want to use this function, you can also call <a class="el" href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3" title="Advance the internal iterators/pointers to the next block.">advance()</a>, get the write pointer with <a class="el" href="classapf_1_1BlockDelayLine.html#a0554f7b7e4d6537dfeb682370be3b002" title="Get the write pointer.">get_write_pointer()</a> and write directly to it. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">source</td><td>Pointer/iterator where the block of data shall be read from. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section attention"><dt>Attention</dt><dd>In <code>source</code> there must be enough data to read from! </dd></dl>
<dl class="section note"><dt>Note</dt><dd><code>source</code> must be a random access iterator. If you want to use another iterator, you'll have to do it on your own (as written above). </dd></dl>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00152">152</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<a id="aa4a0c228c818d55b50cce167828e1fd5" name="aa4a0c228c818d55b50cce167828e1fd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4a0c228c818d55b50cce167828e1fd5">&#9670;&nbsp;</a></span>read_block() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container &gt; </div>
<div class="memtemplate">
template&lt;typename Iterator &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::read_block </td>
          <td>(</td>
          <td class="paramtype">Iterator&#160;</td>
          <td class="paramname"><em>destination</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_type&#160;</td>
          <td class="paramname"><em>delay</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read a block of data from the delay line. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">destination</td><td>Iterator to destination </td></tr>
    <tr><td class="paramname">delay</td><td>Delay in samples </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> on success </dd></dl>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00167">167</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00289">apf::NonCausalBlockDelayLine&lt; T, Container &gt;::read_block()</a>.</p>

</div>
</div>
<a id="afec5abc94b8f231b1b39f3c1dd80c81a" name="afec5abc94b8f231b1b39f3c1dd80c81a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afec5abc94b8f231b1b39f3c1dd80c81a">&#9670;&nbsp;</a></span>read_block() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container &gt; </div>
<div class="memtemplate">
template&lt;typename Iterator &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::read_block </td>
          <td>(</td>
          <td class="paramtype">Iterator&#160;</td>
          <td class="paramname"><em>destination</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_type&#160;</td>
          <td class="paramname"><em>delay</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>weight</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read from the delay line and multiply each element by a given factor. </p>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00183">183</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<a id="a0554f7b7e4d6537dfeb682370be3b002" name="a0554f7b7e4d6537dfeb682370be3b002"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0554f7b7e4d6537dfeb682370be3b002">&#9670;&nbsp;</a></span>get_write_pointer()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classapf_1_1BlockDelayLine.html">BlockDelayLine</a>&lt; T, Container &gt;::pointer <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::get_write_pointer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the write pointer. </p>
<dl class="section attention"><dt>Attention</dt><dd>Before the write operation, <a class="el" href="classapf_1_1BlockDelayLine.html#a3b89b44fdc1f7dd3bdecd3a58c6c47c3" title="Advance the internal iterators/pointers to the next block.">advance()</a> must be called to update read and write pointers. </dd>
<dd>
You must not write more than one block with this pointer! For the next block, you have to get a new pointer. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00201">201</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<a id="a9774d36c26b58b1487220a6832267f15" name="a9774d36c26b58b1487220a6832267f15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9774d36c26b58b1487220a6832267f15">&#9670;&nbsp;</a></span>get_read_circulator()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classapf_1_1BlockDelayLine.html">BlockDelayLine</a>&lt; T, Container &gt;::circulator <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::get_read_circulator </td>
          <td>(</td>
          <td class="paramtype">size_type&#160;</td>
          <td class="paramname"><em>delay</em> = <code>0</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the read circulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">delay</td><td>Delay in samples </td></tr>
  </table>
  </dd>
</dl>
<dl class="section attention"><dt>Attention</dt><dd>There is no check if the delay is in the valid range between 0 and <code>max_delay</code>. You are responsible for checking that! </dd></dl>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00213">213</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00306">apf::NonCausalBlockDelayLine&lt; T, Container &gt;::get_read_circulator()</a>.</p>

</div>
</div>
<a id="aedbb09fc15ddd696fc8d83bbe4673f55" name="aedbb09fc15ddd696fc8d83bbe4673f55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedbb09fc15ddd696fc8d83bbe4673f55">&#9670;&nbsp;</a></span>_get_data_circulator()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classapf_1_1circular__iterator.html">circulator</a> <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::_get_data_circulator </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get a circular iterator to the sample with time 0. </p>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00098">98</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a499ee411350674ed2c5763fc833bdb75" name="a499ee411350674ed2c5763fc833bdb75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a499ee411350674ed2c5763fc833bdb75">&#9670;&nbsp;</a></span>_block_size</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Container  = std::vector&lt;T&gt;&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const size_type <a class="el" href="classapf_1_1BlockDelayLine.html">apf::BlockDelayLine</a>&lt; T, Container &gt;::_block_size</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Size of read/write blocks. </p>

<p class="definition">Definition at line <a class="el" href="blockdelayline_8h_source.html#l00100">100</a> of file <a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="blockdelayline_8h_source.html#l00077">apf::BlockDelayLine&lt; T, Container &gt;::advance()</a>, and <a class="el" href="blockdelayline_8h_source.html#l00121">apf::BlockDelayLine&lt; T, Container &gt;::BlockDelayLine()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>apf/<a class="el" href="blockdelayline_8h_source.html">blockdelayline.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>