1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Update docs

This commit is contained in:
Rhys Weatherley
2016-03-26 19:05:43 +10:00
parent 328b82e3fb
commit 73c9ce4455
422 changed files with 3036 additions and 561 deletions

View File

@@ -542,6 +542,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span>&#160; --size;</div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>&#160; }</div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span>&#160;}</div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span>&#160;</div>
<div class="line"><a name="l00647"></a><span class="lineno"><a class="line" href="classBigNumberUtil.html#ad0aafacd8e224bd543341973c62ff1dd"> 647</a></span>&#160;limb_t <a class="code" href="classBigNumberUtil.html#ad0aafacd8e224bd543341973c62ff1dd">BigNumberUtil::isZero</a>(<span class="keyword">const</span> limb_t *x, <span class="keywordtype">size_t</span> size)</div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span>&#160;{</div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span>&#160; limb_t word = 0;</div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span>&#160; <span class="keywordflow">while</span> (size &gt; 0) {</div>
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span>&#160; word |= *x++;</div>
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span>&#160; --size;</div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>&#160; }</div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>&#160; <span class="keywordflow">return</span> (limb_t)(((((dlimb_t)1) &lt;&lt; LIMB_BITS) - word) &gt;&gt; LIMB_BITS);</div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span>&#160;}</div>
<div class="ttc" id="classBigNumberUtil_html_a00c9cde0b626788a60552a6bc9ce058b"><div class="ttname"><a href="classBigNumberUtil.html#a00c9cde0b626788a60552a6bc9ce058b">BigNumberUtil::reduceQuick_P</a></div><div class="ttdeci">static void reduceQuick_P(limb_t *result, const limb_t *x, const limb_t *y, size_t size)</div><div class="ttdoc">Reduces x modulo y using subtraction where y is in program memory. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00620">BigNumberUtil.cpp:620</a></div></div>
<div class="ttc" id="classBigNumberUtil_html_aa6904b2727af6b767fe041b1b7f27414"><div class="ttname"><a href="classBigNumberUtil.html#aa6904b2727af6b767fe041b1b7f27414">BigNumberUtil::add</a></div><div class="ttdeci">static limb_t add(limb_t *result, const limb_t *x, const limb_t *y, size_t size)</div><div class="ttdoc">Adds two big numbers. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00381">BigNumberUtil.cpp:381</a></div></div>
<div class="ttc" id="classBigNumberUtil_html_af0fa1527647af42b65eda6b0aab982b3"><div class="ttname"><a href="classBigNumberUtil.html#af0fa1527647af42b65eda6b0aab982b3">BigNumberUtil::sub_P</a></div><div class="ttdeci">static limb_t sub_P(limb_t *result, const limb_t *x, const limb_t *y, size_t size)</div><div class="ttdoc">Subtracts one big number from another where one is in program memory. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00541">BigNumberUtil.cpp:541</a></div></div>
@@ -553,11 +563,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classBigNumberUtil_html_a1c2c5484f2bf440ae292fd3dfd2d594f"><div class="ttname"><a href="classBigNumberUtil.html#a1c2c5484f2bf440ae292fd3dfd2d594f">BigNumberUtil::mul</a></div><div class="ttdeci">static void mul(limb_t *result, const limb_t *x, size_t xcount, const limb_t *y, size_t ycount)</div><div class="ttdoc">Multiplies two big numbers. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00432">BigNumberUtil.cpp:432</a></div></div>
<div class="ttc" id="classBigNumberUtil_html_a63f9d7884eb36227d39e1b95e219d865"><div class="ttname"><a href="classBigNumberUtil.html#a63f9d7884eb36227d39e1b95e219d865">BigNumberUtil::unpackBE</a></div><div class="ttdeci">static void unpackBE(limb_t *limbs, size_t count, const uint8_t *bytes, size_t len)</div><div class="ttdoc">Unpacks the big-endian byte representation of a big number into a limb array. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00134">BigNumberUtil.cpp:134</a></div></div>
<div class="ttc" id="classBigNumberUtil_html_a989cd5f389ac5adc798d8767383e2810"><div class="ttname"><a href="classBigNumberUtil.html#a989cd5f389ac5adc798d8767383e2810">BigNumberUtil::packLE</a></div><div class="ttdeci">static void packLE(uint8_t *bytes, size_t len, const limb_t *limbs, size_t count)</div><div class="ttdoc">Packs the little-endian byte representation of a big number into a byte array. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00208">BigNumberUtil.cpp:208</a></div></div>
<div class="ttc" id="classBigNumberUtil_html_ad0aafacd8e224bd543341973c62ff1dd"><div class="ttname"><a href="classBigNumberUtil.html#ad0aafacd8e224bd543341973c62ff1dd">BigNumberUtil::isZero</a></div><div class="ttdeci">static limb_t isZero(const limb_t *x, size_t size)</div><div class="ttdoc">Determine if a big number is zero. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00647">BigNumberUtil.cpp:647</a></div></div>
<div class="ttc" id="classBigNumberUtil_html_ab9a9f532fcfc182433adac44d8e4ee20"><div class="ttname"><a href="classBigNumberUtil.html#ab9a9f532fcfc182433adac44d8e4ee20">BigNumberUtil::add_P</a></div><div class="ttdeci">static limb_t add_P(limb_t *result, const limb_t *x, const limb_t *y, size_t size)</div><div class="ttdoc">Adds two big numbers where one of them is in program memory. </div><div class="ttdef"><b>Definition:</b> <a href="BigNumberUtil_8cpp_source.html#l00514">BigNumberUtil.cpp:514</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 23 2016 19:08:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Mar 26 2016 19:04:40 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>