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

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 File Reference</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="summary">
adamstark@114 77 <a href="#nested-classes">Classes</a> </div>
adamstark@114 78 <div class="headertitle"><div class="title">CircularBuffer.h File Reference</div></div>
adamstark@114 79 </div><!--header-->
adamstark@114 80 <div class="contents">
adamstark@114 81
adamstark@114 82 <p>A circular buffer.
adamstark@114 83 <a href="#details">More...</a></p>
adamstark@114 84 <div class="textblock"><code>#include &lt;vector&gt;</code><br />
adamstark@114 85 </div>
adamstark@114 86 <p><a href="_circular_buffer_8h_source.html">Go to the source code of this file.</a></p>
adamstark@114 87 <table class="memberdecls">
adamstark@114 88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
adamstark@114 89 Classes</h2></td></tr>
adamstark@114 90 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_circular_buffer.html">CircularBuffer</a></td></tr>
adamstark@114 91 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@114 92 </table>
adamstark@114 93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
adamstark@114 94 <div class="textblock"><p>A circular buffer. </p>
adamstark@114 95 <dl class="section author"><dt>Author</dt><dd>Adam Stark </dd></dl>
adamstark@114 96 <dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2008-2014 Queen Mary University of London</dd></dl>
adamstark@114 97 <p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
adamstark@114 98 <p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
adamstark@114 99 <p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p>
adamstark@114 100 </div></div><!-- contents -->
adamstark@114 101 <!-- start footer part -->
adamstark@114 102 <hr class="footer"/><address class="footer"><small>
adamstark@114 103 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 104 </small></address>
adamstark@114 105 </body>
adamstark@114 106 </html>