acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
Log | Files | Refs | Archive | README | LICENSE

TimingStats_8h_source.html (16866B)

      1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
      2 <html xmlns="http://www.w3.org/1999/xhtml">
      3 <head>
      4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
      5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
      6 <meta name="generator" content="Doxygen 1.8.13"/>
      7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
      8 <title>AceButton: /home/brian/dev/AceButton/src/ace_button/TimingStats.h Source File</title>
      9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
     10 <script type="text/javascript" src="jquery.js"></script>
     11 <script type="text/javascript" src="dynsections.js"></script>
     12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
     13 <script type="text/javascript" src="search/searchdata.js"></script>
     14 <script type="text/javascript" src="search/search.js"></script>
     15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
     16 </head>
     17 <body>
     18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
     19 <div id="titlearea">
     20 <table cellspacing="0" cellpadding="0">
     21  <tbody>
     22  <tr style="height: 56px;">
     23   <td id="projectalign" style="padding-left: 0.5em;">
     24    <div id="projectname">AceButton
     25    &#160;<span id="projectnumber">1.3.3</span>
     26    </div>
     27    <div id="projectbrief">An adjustable, compact, event-driven button library for Arduino.</div>
     28   </td>
     29  </tr>
     30  </tbody>
     31 </table>
     32 </div>
     33 <!-- end header part -->
     34 <!-- Generated by Doxygen 1.8.13 -->
     35 <script type="text/javascript">
     36 var searchBox = new SearchBox("searchBox", "search",false,'Search');
     37 </script>
     38 <script type="text/javascript" src="menudata.js"></script>
     39 <script type="text/javascript" src="menu.js"></script>
     40 <script type="text/javascript">
     41 $(function() {
     42   initMenu('',true,false,'search.php','Search');
     43   $(document).ready(function() { init_search(); });
     44 });
     45 </script>
     46 <div id="main-nav"></div>
     47 <!-- window showing the filter options -->
     48 <div id="MSearchSelectWindow"
     49      onmouseover="return searchBox.OnSearchSelectShow()"
     50      onmouseout="return searchBox.OnSearchSelectHide()"
     51      onkeydown="return searchBox.OnSearchSelectKey(event)">
     52 </div>
     53 
     54 <!-- iframe showing the search results (closed by default) -->
     55 <div id="MSearchResultsWindow">
     56 <iframe src="javascript:void(0)" frameborder="0" 
     57         name="MSearchResults" id="MSearchResults">
     58 </iframe>
     59 </div>
     60 
     61 <div id="nav-path" class="navpath">
     62   <ul>
     63 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ebbe9b537c0e01d975153fa119b09658.html">ace_button</a></li>  </ul>
     64 </div>
     65 </div><!-- top -->
     66 <div class="header">
     67   <div class="headertitle">
     68 <div class="title">TimingStats.h</div>  </div>
     69 </div><!--header-->
     70 <div class="contents">
     71 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">MIT License</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">Copyright (c) 2018 Brian T. Park</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifndef ACE_BUTTON_TIMING_STATS_H</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define ACE_BUTTON_TIMING_STATS_H</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceace__button.html">ace_button</a> {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html">   32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classace__button_1_1TimingStats.html">TimingStats</a> {</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;  <span class="keyword">public</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#ad763ef53d333dd86964acd7b5458491b">   35</a></span>&#160;    <a class="code" href="classace__button_1_1TimingStats.html#ad763ef53d333dd86964acd7b5458491b">TimingStats</a>(): mCounter(0) {</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;      reset();</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    }</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keywordtype">void</span> reset() {</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;      mExpDecayAvg = 0;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;      mMin = UINT16_MAX;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;      mMax = 0;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;      mSum = 0;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;      mCount = 0;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    }</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    uint16_t getMax()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMax; }</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    uint16_t getMin()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMin; }</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    uint16_t getAvg()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mCount &gt; 0) ? mSum / mCount : 0; }</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#a04c9dbea755eafeed3bb7872d7fb0d24">   54</a></span>&#160;    uint16_t <a class="code" href="classace__button_1_1TimingStats.html#a04c9dbea755eafeed3bb7872d7fb0d24">getExpDecayAvg</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mExpDecayAvg; }</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#ad23641b3302acb7050317c8749febe3d">   57</a></span>&#160;    uint16_t <a class="code" href="classace__button_1_1TimingStats.html#ad23641b3302acb7050317c8749febe3d">getCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCount; }</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#a3eab5a6a7a43e1a565d91faf14b148b2">   64</a></span>&#160;    uint16_t <a class="code" href="classace__button_1_1TimingStats.html#a3eab5a6a7a43e1a565d91faf14b148b2">getCounter</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCounter; }</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="keywordtype">void</span> update(uint16_t duration) {</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;      mCount++;</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;      mCounter++;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;      mSum += duration;</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;      <span class="keywordflow">if</span> (duration &lt; mMin) {</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        mMin = duration;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;      }</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;      <span class="keywordflow">if</span> (duration &gt; mMax) {</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        mMax = duration;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;      }</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;      mExpDecayAvg = (mExpDecayAvg + duration) / 2;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    }</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="keyword">private</span>:</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    uint16_t mExpDecayAvg;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    uint16_t mMin;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    uint16_t mMax;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    uint32_t mSum;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    uint16_t mCount;</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    uint16_t mCounter;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;};</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;}</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classace__button_1_1TimingStats_html_a04c9dbea755eafeed3bb7872d7fb0d24"><div class="ttname"><a href="classace__button_1_1TimingStats.html#a04c9dbea755eafeed3bb7872d7fb0d24">ace_button::TimingStats::getExpDecayAvg</a></div><div class="ttdeci">uint16_t getExpDecayAvg() const</div><div class="ttdoc">An exponential decay average. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00054">TimingStats.h:54</a></div></div>
     72 <div class="ttc" id="classace__button_1_1TimingStats_html"><div class="ttname"><a href="classace__button_1_1TimingStats.html">ace_button::TimingStats</a></div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00032">TimingStats.h:32</a></div></div>
     73 <div class="ttc" id="namespaceace__button_html"><div class="ttname"><a href="namespaceace__button.html">ace_button</a></div><div class="ttdef"><b>Definition:</b> <a href="AceButton_8cpp_source.html#l00028">AceButton.cpp:28</a></div></div>
     74 <div class="ttc" id="classace__button_1_1TimingStats_html_ad763ef53d333dd86964acd7b5458491b"><div class="ttname"><a href="classace__button_1_1TimingStats.html#ad763ef53d333dd86964acd7b5458491b">ace_button::TimingStats::TimingStats</a></div><div class="ttdeci">TimingStats()</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00035">TimingStats.h:35</a></div></div>
     75 <div class="ttc" id="classace__button_1_1TimingStats_html_ad23641b3302acb7050317c8749febe3d"><div class="ttname"><a href="classace__button_1_1TimingStats.html#ad23641b3302acb7050317c8749febe3d">ace_button::TimingStats::getCount</a></div><div class="ttdeci">uint16_t getCount() const</div><div class="ttdoc">Number of times update() was called since last reset. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00057">TimingStats.h:57</a></div></div>
     76 <div class="ttc" id="classace__button_1_1TimingStats_html_a3eab5a6a7a43e1a565d91faf14b148b2"><div class="ttname"><a href="classace__button_1_1TimingStats.html#a3eab5a6a7a43e1a565d91faf14b148b2">ace_button::TimingStats::getCounter</a></div><div class="ttdeci">uint16_t getCounter() const</div><div class="ttdoc">Number of times update() was called from the beginning of time. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00064">TimingStats.h:64</a></div></div>
     77 </div><!-- fragment --></div><!-- contents -->
     78 <!-- start footer part -->
     79 <hr class="footer"/><address class="footer"><small>
     80 Generated by &#160;<a href="http://www.doxygen.org/index.html">
     81 <img class="footer" src="doxygen.png" alt="doxygen"/>
     82 </a> 1.8.13
     83 </small></address>
     84 </body>
     85 </html>