Documentation for c6af943508

This commit is contained in:
realstealthninja
2024-11-04 12:10:37 +00:00
parent e97327bf4f
commit fb1d00ead7
518 changed files with 13882 additions and 10974 deletions

View File

@@ -114,17 +114,18 @@ $(function(){initNavTree('de/d99/aliquot__sum_8cpp.html','../../'); initResizabl
<p>Program to return the <a href="https://en.wikipedia.org/wiki/Aliquot_sum" target="_blank">Aliquot Sum</a> of a number.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for aliquot_sum.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/d4a/aliquot__sum_8cpp__incl.svg" width="171" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/d4a/aliquot__sum_8cpp__incl.svg" width="255" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d47/namespacemath.html">math</a></td></tr>
<tr class="memdesc:dd/d47/namespacemath"><td class="mdescLeft">&#160;</td><td class="mdescRight">for IO operations <br /></td></tr>
<tr class="memdesc:dd/d47/namespacemath"><td class="mdescLeft">&#160;</td><td class="mdescRight">for assert <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
@@ -168,11 +169,11 @@ Functions</h2></td></tr>
<p>Main function. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 73</span> {</div>
<div class="line"><span class="lineno"> 74</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run the self-test implementations</span></div>
<div class="line"><span class="lineno"> 75</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 76</span>}</div>
<div class="ttc" id="aaliquot__sum_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> aliquot_sum.cpp:56</div></div>
<div class="fragment"><div class="line"><span class="lineno"> 74</span> {</div>
<div class="line"><span class="lineno"> 75</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run the self-test implementations</span></div>
<div class="line"><span class="lineno"> 76</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 77</span>}</div>
<div class="ttc" id="aaliquot__sum_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> aliquot_sum.cpp:57</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -206,20 +207,20 @@ Here is the call graph for this function:</div>
<p>Self-test implementations. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 56</span> {</div>
<div class="line"><span class="lineno"> 57</span> <span class="comment">// Aliquot sum of 10 is 1 + 2 + 5 = 8</span></div>
<div class="line"><span class="lineno"> 58</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(10) == 8);</div>
<div class="line"><span class="lineno"> 59</span> <span class="comment">// Aliquot sum of 15 is 1 + 3 + 5 = 9</span></div>
<div class="line"><span class="lineno"> 60</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(15) == 9);</div>
<div class="line"><span class="lineno"> 61</span> <span class="comment">// Aliquot sum of 1 is 0</span></div>
<div class="line"><span class="lineno"> 62</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(1) == 0);</div>
<div class="line"><span class="lineno"> 63</span> <span class="comment">// Aliquot sum of 97 is 1 (the aliquot sum of a prime number is 1)</span></div>
<div class="line"><span class="lineno"> 64</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(97) == 1);</div>
<div class="line"><span class="lineno"> 65</span> </div>
<div class="line"><span class="lineno"> 66</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;All the tests have successfully passed!\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 67</span>}</div>
<div class="fragment"><div class="line"><span class="lineno"> 57</span> {</div>
<div class="line"><span class="lineno"> 58</span> <span class="comment">// Aliquot sum of 10 is 1 + 2 + 5 = 8</span></div>
<div class="line"><span class="lineno"> 59</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(10) == 8);</div>
<div class="line"><span class="lineno"> 60</span> <span class="comment">// Aliquot sum of 15 is 1 + 3 + 5 = 9</span></div>
<div class="line"><span class="lineno"> 61</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(15) == 9);</div>
<div class="line"><span class="lineno"> 62</span> <span class="comment">// Aliquot sum of 1 is 0</span></div>
<div class="line"><span class="lineno"> 63</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(1) == 0);</div>
<div class="line"><span class="lineno"> 64</span> <span class="comment">// Aliquot sum of 97 is 1 (the aliquot sum of a prime number is 1)</span></div>
<div class="line"><span class="lineno"> 65</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a>(97) == 1);</div>
<div class="line"><span class="lineno"> 66</span> </div>
<div class="line"><span class="lineno"> 67</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;All the tests have successfully passed!\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 68</span>}</div>
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a></div></div>
<div class="ttc" id="anamespacemath_html_ab37f3a7302a84179aae682c79d8390bf"><div class="ttname"><a href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a></div><div class="ttdeci">uint64_t aliquot_sum(const uint64_t num)</div><div class="ttdoc">to return the aliquot sum of a number</div><div class="ttdef"><b>Definition</b> aliquot_sum.cpp:35</div></div>
<div class="ttc" id="anamespacemath_html_ab37f3a7302a84179aae682c79d8390bf"><div class="ttname"><a href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a></div><div class="ttdeci">uint64_t aliquot_sum(const uint64_t num)</div><div class="ttdoc">to return the aliquot sum of a number</div><div class="ttdef"><b>Definition</b> aliquot_sum.cpp:36</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">