diff options
Diffstat (limited to 'docs/3.1/group___math.html')
| -rw-r--r-- | docs/3.1/group___math.html | 61 |
1 files changed, 53 insertions, 8 deletions
diff --git a/docs/3.1/group___math.html b/docs/3.1/group___math.html index cfcbf5a6..d43a29de 100644 --- a/docs/3.1/group___math.html +++ b/docs/3.1/group___math.html @@ -8,6 +8,14 @@ <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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</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> @@ -62,6 +70,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </ul> </div> </div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('group___math.html','');}); +</script> +<div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" @@ -86,9 +108,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <p>Fast, efficient 8-bit math functions specifically designed for high-performance LED programming. <a href="#details">More...</a></p> -<div class="dynheader"> -Collaboration diagram for Basic math operations:</div> -<div class="dyncontent"> +<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Basic math operations:</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> <center><table><tr><td><img src="group___math.png" border="0" alt="" usemap="#group______math"/> <map name="group______math" id="group______math"> <area shape="rect" id="node2" href="group__lib8tion.html" title="A variety of functions for working with numbers. " alt="" coords="5,5,144,32"/></map> @@ -178,6 +202,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e <p>Add two numbers, and calculate the modulo of the sum and a third number, M. </p> <p>In other words, it returns (A+B) % M. It is designed as a compact mechanism for incrementing a 'mode' switch and wrapping around back to 'mode 0' when the switch goes past the end of the available range. e.g. if you have seven modes, this switches to the next one and wraps around if needed: mode = addmod8( mode, 1, 7); See 'mod8' for notes on performance. </p> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00223">223</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="ga30558a835c484b418165909118e702b1"></a> @@ -207,6 +233,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e <p>Calculate an integer average of two signed 7-bit integers (int8_t) If the first argument is even, result is rounded down. </p> <p>If the first argument is odd, result is result up. </p> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00171">171</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="ga6bfedf0473d4c3705e8feeb6a25b9ea5"></a> @@ -236,6 +264,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e <p>Calculate an integer average of two unsigned 8-bit integer values (uint8_t). </p> <p>Fractional results are rounded down, e.g. avg8(20,41) = 30 </p> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00148">148</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="gaa5e80daec10cc13bf1eca8b125ee0e88"></a> @@ -265,6 +295,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e <p>Calculate the remainder of one unsigned 8-bit value divided by anoter, aka A % M. </p> <p>Implemented by repeated subtraction, which is very compact, and very fast if A is 'probably' less than M. If A is a large multiple of M, the loop has to execute multiple times. However, even in that case, the loop is only two instructions long on AVR, i.e., quick. </p> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00196">196</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="gadf60ccff727f52078aecdd5873b6f0bc"></a> @@ -301,6 +333,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e </dl> <dl class="section return"><dt>Returns</dt><dd>the sum of i & j, capped at 0xFF </dd></dl> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00054">54</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="ga38e9f9a8830353f9cbfecad7c8758b1f"></a> @@ -337,6 +371,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e </dl> <dl class="section return"><dt>Returns</dt><dd>the sum of i & j, capped at 0xFF </dd></dl> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00021">21</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="ga9d113e85065df7c9006704ea6b6dcda4"></a> @@ -366,6 +402,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e <p>saturating 8x8 bit multiplication, with 8 bit result </p> <dl class="section return"><dt>Returns</dt><dd>the product of i * j, capping at 0xFF </dd></dl> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00267">267</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="gaaaa16f47aca46653d51793b1af177587"></a> @@ -395,6 +433,8 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e <p>subtract one byte from another, saturating at 0x00 </p> <dl class="section return"><dt>Returns</dt><dd>i - j with a floor of 0 </dd></dl> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00086">86</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> <a class="anchor" id="ga66ecef97faa5f9b92c49766651c5afe9"></a> @@ -413,14 +453,19 @@ LIB8STATIC int8_t </td><td class="memItemRight" valign="bottom"><a class="e <p>square root for 16-bit integers About three times faster and five times smaller than Arduino's general sqrt on AVR. </p> +<p>Definition at line <a class="el" href="math8_8h_source.html#l00326">326</a> of file <a class="el" href="math8_8h_source.html">math8.h</a>.</p> + </div> </div> </div><!-- contents --> +</div><!-- doc-content --> <!-- start footer part --> -<hr class="footer"/><address class="footer"><small> -Generated on Wed Nov 11 2015 15:10:36 for FastLED by  <a href="http://www.doxygen.org/index.html"> -<img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.9.1 -</small></address> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Wed Nov 18 2015 11:53:18 for FastLED by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li> + </ul> +</div> </body> </html> |