Mercurial > hg > btrack

annotate doc/html/_circular_buffer_8h_source.html @ 114:d6d9df2db3e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation
author Adam Stark <adamstark.uk@gmail.com>
date Fri, 18 Aug 2023 10:48:26 +0200
parents
children
rev   line source
adamstark@114 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
adamstark@114 2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
adamstark@114 3 <head>
adamstark@114 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
adamstark@114 5 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
adamstark@114 6 <meta name="generator" content="Doxygen 1.9.7"/>
adamstark@114 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
adamstark@114 8 <title>BTrack - A Real-Time Beat Tracker: src/CircularBuffer.h Source File</title>
adamstark@114 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
adamstark@114 10 <script type="text/javascript" src="jquery.js"></script>
adamstark@114 11 <script type="text/javascript" src="dynsections.js"></script>
adamstark@114 12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
adamstark@114 13 <script type="text/javascript" src="search/searchdata.js"></script>
adamstark@114 14 <script type="text/javascript" src="search/search.js"></script>
adamstark@114 15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
adamstark@114 16 </head>
adamstark@114 17 <body>
adamstark@114 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
adamstark@114 19 <div id="titlearea">
adamstark@114 20 <table cellspacing="0" cellpadding="0">
adamstark@114 21 <tbody>
adamstark@114 22 <tr id="projectrow">
adamstark@114 23 <td id="projectalign">
adamstark@114 24 <div id="projectname">BTrack - A Real-Time Beat Tracker
adamstark@114 25 </div>
adamstark@114 26 </td>
adamstark@114 27 </tr>
adamstark@114 28 </tbody>
adamstark@114 29 </table>
adamstark@114 30 </div>
adamstark@114 31 <!-- end header part -->
adamstark@114 32 <!-- Generated by Doxygen 1.9.7 -->
adamstark@114 33 <script type="text/javascript">
adamstark@114 34 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 35 var searchBox = new SearchBox("searchBox", "search/",'.html');
adamstark@114 36 /* @license-end */
adamstark@114 37 </script>
adamstark@114 38 <script type="text/javascript" src="menudata.js"></script>
adamstark@114 39 <script type="text/javascript" src="menu.js"></script>
adamstark@114 40 <script type="text/javascript">
adamstark@114 41 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 42 $(function() {
adamstark@114 43 initMenu('',true,false,'search.php','Search');
adamstark@114 44 $(document).ready(function() { init_search(); });
adamstark@114 45 });
adamstark@114 46 /* @license-end */
adamstark@114 47 </script>
adamstark@114 48 <div id="main-nav"></div>
adamstark@114 49 <!-- window showing the filter options -->
adamstark@114 50 <div id="MSearchSelectWindow"
adamstark@114 51 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@114 52 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@114 53 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@114 54 </div>
adamstark@114 55
adamstark@114 56 <!-- iframe showing the search results (closed by default) -->
adamstark@114 57 <div id="MSearchResultsWindow">
adamstark@114 58 <div id="MSearchResults">
adamstark@114 59 <div class="SRPage">
adamstark@114 60 <div id="SRIndex">
adamstark@114 61 <div id="SRResults"></div>
adamstark@114 62 <div class="SRStatus" id="Loading">Loading...</div>
adamstark@114 63 <div class="SRStatus" id="Searching">Searching...</div>
adamstark@114 64 <div class="SRStatus" id="NoMatches">No Matches</div>
adamstark@114 65 </div>
adamstark@114 66 </div>
adamstark@114 67 </div>
adamstark@114 68 </div>
adamstark@114 69
adamstark@114 70 <div id="nav-path" class="navpath">
adamstark@114 71 <ul>
adamstark@114 72 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
adamstark@114 73 </div>
adamstark@114 74 </div><!-- top -->
adamstark@114 75 <div class="header">
adamstark@114 76 <div class="headertitle"><div class="title">CircularBuffer.h</div></div>
adamstark@114 77 </div><!--header-->
adamstark@114 78 <div class="contents">
adamstark@114 79 <a href="_circular_buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//=======================================================================</span></div>
adamstark@114 80 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span><span class="comment">//=======================================================================</span></div>
adamstark@114 81 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
adamstark@114 82 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#ifndef CircularBuffer_h</span></div>
adamstark@114 83 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#define CircularBuffer_h</span></div>
adamstark@114 84 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
adamstark@114 85 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
adamstark@114 86 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
adamstark@114 87 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">//=======================================================================</span></div>
adamstark@114 88 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_circular_buffer.html"> 33</a></span><span class="comment"></span><span class="keyword">class </span><a class="code hl_class" href="class_circular_buffer.html">CircularBuffer</a></div>
adamstark@114 89 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>{</div>
adamstark@114 90 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">public</span>:</div>
adamstark@114 91 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
adamstark@114 92 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a8c5de0e610bb50bac684f4707e23431c"> 38</a></span> <a class="code hl_function" href="class_circular_buffer.html#a8c5de0e610bb50bac684f4707e23431c">CircularBuffer</a>()</div>
adamstark@114 93 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> : writeIndex (0)</div>
adamstark@114 94 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> {</div>
adamstark@114 95 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
adamstark@114 96 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</div>
adamstark@114 97 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
adamstark@114 98 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a5b0c486a7eb76bae0d1a0d6e459d0f5a"> 45</a></span> <span class="keywordtype">double</span> &amp;<a class="code hl_function" href="class_circular_buffer.html#a5b0c486a7eb76bae0d1a0d6e459d0f5a">operator[] </a>(<span class="keywordtype">int</span> i)</div>
adamstark@114 99 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> {</div>
adamstark@114 100 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">int</span> index = (i + writeIndex) % buffer.size();</div>
adamstark@114 101 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">return</span> buffer[index];</div>
adamstark@114 102 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
adamstark@114 103 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
adamstark@114 104 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a8e6fa8bf39215a466876a7a2daa1ce22"> 52</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_circular_buffer.html#a8e6fa8bf39215a466876a7a2daa1ce22">addSampleToEnd</a> (<span class="keywordtype">double</span> v)</div>
adamstark@114 105 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> {</div>
adamstark@114 106 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> buffer[writeIndex] = v;</div>
adamstark@114 107 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> writeIndex = (writeIndex + 1) % buffer.size();</div>
adamstark@114 108 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
adamstark@114 109 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
adamstark@114 110 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a09d74c64e5e9e0ee13c84663ba9523ea"> 59</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_circular_buffer.html#a09d74c64e5e9e0ee13c84663ba9523ea">resize</a> (<span class="keywordtype">int</span> <a class="code hl_function" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">size</a>)</div>
adamstark@114 111 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> {</div>
adamstark@114 112 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> buffer.resize (<a class="code hl_function" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">size</a>);</div>
adamstark@114 113 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> std::fill (buffer.begin(), buffer.end(), 0.0);</div>
adamstark@114 114 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> writeIndex = 0;</div>
adamstark@114 115 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> }</div>
adamstark@114 116 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
adamstark@114 117 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f"> 67</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">size</a>()</div>
adamstark@114 118 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> {</div>
adamstark@114 119 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">int</span><span class="keyword">&gt;</span> (buffer.size());</div>
adamstark@114 120 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
adamstark@114 121 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
adamstark@114 122 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="keyword">private</span>:</div>
adamstark@114 123 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
adamstark@114 124 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> std::vector&lt;double&gt; buffer;</div>
adamstark@114 125 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">int</span> writeIndex;</div>
adamstark@114 126 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>};</div>
adamstark@114 127 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
adamstark@114 128 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="preprocessor">#endif </span><span class="comment">/* CircularBuffer_hpp */</span><span class="preprocessor"></span></div>
adamstark@114 129 <div class="ttc" id="aclass_circular_buffer_html"><div class="ttname"><a href="class_circular_buffer.html">CircularBuffer</a></div><div class="ttdef"><b>Definition</b> CircularBuffer.h:34</div></div>
adamstark@114 130 <div class="ttc" id="aclass_circular_buffer_html_a09d74c64e5e9e0ee13c84663ba9523ea"><div class="ttname"><a href="class_circular_buffer.html#a09d74c64e5e9e0ee13c84663ba9523ea">CircularBuffer::resize</a></div><div class="ttdeci">void resize(int size)</div><div class="ttdef"><b>Definition</b> CircularBuffer.h:59</div></div>
adamstark@114 131 <div class="ttc" id="aclass_circular_buffer_html_a5b0c486a7eb76bae0d1a0d6e459d0f5a"><div class="ttname"><a href="class_circular_buffer.html#a5b0c486a7eb76bae0d1a0d6e459d0f5a">CircularBuffer::operator[]</a></div><div class="ttdeci">double &amp; operator[](int i)</div><div class="ttdef"><b>Definition</b> CircularBuffer.h:45</div></div>
adamstark@114 132 <div class="ttc" id="aclass_circular_buffer_html_a8c5de0e610bb50bac684f4707e23431c"><div class="ttname"><a href="class_circular_buffer.html#a8c5de0e610bb50bac684f4707e23431c">CircularBuffer::CircularBuffer</a></div><div class="ttdeci">CircularBuffer()</div><div class="ttdef"><b>Definition</b> CircularBuffer.h:38</div></div>
adamstark@114 133 <div class="ttc" id="aclass_circular_buffer_html_a8e6fa8bf39215a466876a7a2daa1ce22"><div class="ttname"><a href="class_circular_buffer.html#a8e6fa8bf39215a466876a7a2daa1ce22">CircularBuffer::addSampleToEnd</a></div><div class="ttdeci">void addSampleToEnd(double v)</div><div class="ttdef"><b>Definition</b> CircularBuffer.h:52</div></div>
adamstark@114 134 <div class="ttc" id="aclass_circular_buffer_html_ad452b3b0f7703927ce1f3befd8f7512f"><div class="ttname"><a href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">CircularBuffer::size</a></div><div class="ttdeci">int size()</div><div class="ttdef"><b>Definition</b> CircularBuffer.h:67</div></div>
adamstark@114 135 </div><!-- fragment --></div><!-- contents -->
adamstark@114 136 <!-- start footer part -->
adamstark@114 137 <hr class="footer"/><address class="footer"><small>
adamstark@114 138 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.7
adamstark@114 139 </small></address>
adamstark@114 140 </body>
adamstark@114 141 </html>