Documentation for 2fd530cba1

This commit is contained in:
github-actions
2023-06-20 22:07:36 +00:00
parent 08ebd7e110
commit 08bdc61024
71 changed files with 1117 additions and 2167 deletions

View File

@@ -123,6 +123,7 @@ Namespaces</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab37f3a7302a84179aae682c79d8390bf"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf">math::aliquot_sum</a> (const uint64_t num)</td></tr>
<tr class="memdesc:ab37f3a7302a84179aae682c79d8390bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">to return the aliquot sum of a number <br /></td></tr>
<tr class="separator:ab37f3a7302a84179aae682c79d8390bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d99/aliquot__sum_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <br /></td></tr>
@@ -133,7 +134,14 @@ Functions</h2></td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Program to return the <a href="https://en.wikipedia.org/wiki/Aliquot_sum" target="_blank">Aliquot Sum</a> of a number. </p>
<p>The Aliquot sum s(n) of a non-negative integer n is the sum of all proper divisors of n, that is, all the divisors of n, other than itself. For example, the Aliquot sum of 18 = 1 + 2 + 3 + 6 + 9 = 21</p>
<p>The Aliquot sum \(s(n)\) of a non-negative integer n is the sum of all proper divisors of n, that is, all the divisors of n, other than itself.</p>
<p>Formula:</p>
<p class="formulaDsp">
\[
s(n) = \sum_{d|n, d\neq n}d.
\]
</p>
<p>For example; \(s(18) = 1 + 2 + 3 + 6 + 9 = 21 \)</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/SpiderMath" target="_blank">SpiderMath</a> </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
@@ -154,12 +162,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"> 64</span> {</div>
<div class="line"><span class="lineno"> 65</span> <a class="code hl_function" href="../../de/d99/aliquot__sum_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run the self-test implementations</span></div>
<div class="line"><span class="lineno"> 66</span> </div>
<div class="line"><span class="lineno"> 67</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 68</span>}</div>
<div class="ttc" id="aaliquot__sum_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../de/d99/aliquot__sum_8cpp.html#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:47</div></div>
<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="../../de/d99/aliquot__sum_8cpp.html#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="../../de/d99/aliquot__sum_8cpp.html#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><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -193,20 +200,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"> 47</span> {</div>
<div class="line"><span class="lineno"> 48</span> <span class="comment">// Aliquot sum of 10 is 1 + 2 + 5 = 8</span></div>
<div class="line"><span class="lineno"> 49</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"> 50</span> <span class="comment">// Aliquot sum of 15 is 1 + 3 + 5 = 9</span></div>
<div class="line"><span class="lineno"> 51</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"> 52</span> <span class="comment">// Aliquot sum of 1 is 0</span></div>
<div class="line"><span class="lineno"> 53</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"> 54</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"> 55</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"> 56</span> </div>
<div class="line"><span class="lineno"> 57</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"> 58</span>}</div>
<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="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="ttdef"><b>Definition</b> aliquot_sum.cpp:26</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><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">

View File

@@ -1,5 +1,5 @@
<map id="test" name="test">
<area shape="rect" id="Node000001" title="Self&#45;test implementations." alt="" coords="5,5,49,31"/>
<area shape="rect" id="Node000002" href="$dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" title=" " alt="" coords="97,5,225,31"/>
<area shape="rect" id="Node000002" href="$dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" title="to return the aliquot sum of a number" alt="" coords="97,5,225,31"/>
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="49,16,82,16,82,21,49,21"/>
</map>

View File

@@ -1 +1 @@
7b52f3da1e2814fcecc5b4a2cedd4b9e
9de40daebfdd73839fe6de7dbc3cefb9

View File

@@ -30,7 +30,7 @@
<!-- Node2 -->
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title=" ">
<g id="a_Node000002"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title="to return the aliquot sum of a number">
<polygon fill="white" stroke="#666666" points="164.75,-19.25 68.5,-19.25 68.5,0 164.75,0 164.75,-19.25"/>
<text text-anchor="middle" x="116.62" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">math::aliquot_sum</text>
</a>

Before

Width:  |  Height:  |  Size: 2.4 KiB

After

Width:  |  Height:  |  Size: 2.5 KiB

View File

@@ -20,7 +20,7 @@
<!-- Node2 -->
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title=" ">
<g id="a_Node000002"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title="to return the aliquot sum of a number">
<polygon fill="white" stroke="#666666" points="164.75,-19.25 68.5,-19.25 68.5,0 164.75,0 164.75,-19.25"/>
<text text-anchor="middle" x="116.62" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">math::aliquot_sum</text>
</a>

Before

Width:  |  Height:  |  Size: 1.7 KiB

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@@ -2,6 +2,6 @@
<area shape="rect" id="Node000001" title="Main function." alt="" coords="5,5,55,31"/>
<area shape="rect" id="Node000002" href="$de/d99/aliquot__sum_8cpp.html#aa8dca7b867074164d5f45b0f3851269d" title="Self&#45;test implementations." alt="" coords="103,5,146,31"/>
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="55,16,88,16,88,21,55,21"/>
<area shape="rect" id="Node000003" href="$dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" title=" " alt="" coords="194,5,322,31"/>
<area shape="rect" id="Node000003" href="$dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" title="to return the aliquot sum of a number" alt="" coords="194,5,322,31"/>
<area shape="poly" id="edge2_Node000002_Node000003" title=" " alt="" coords="146,16,179,16,179,21,146,21"/>
</map>

View File

@@ -1 +1 @@
0686e8357f8d0a058a9287ddd2816a9f
84b115a7d95db54c6e35b8265ffa00ab

View File

@@ -48,7 +48,7 @@
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title=" ">
<g id="a_Node000003"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title="to return the aliquot sum of a number">
<polygon fill="white" stroke="#666666" points="237.75,-19.25 141.5,-19.25 141.5,0 237.75,0 237.75,-19.25"/>
<text text-anchor="middle" x="189.62" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">math::aliquot_sum</text>
</a>

Before

Width:  |  Height:  |  Size: 3.2 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

View File

@@ -38,7 +38,7 @@
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title=" ">
<g id="a_Node000003"><a xlink:href="../../dd/d47/namespacemath.html#ab37f3a7302a84179aae682c79d8390bf" target="_top" xlink:title="to return the aliquot sum of a number">
<polygon fill="white" stroke="#666666" points="237.75,-19.25 141.5,-19.25 141.5,0 237.75,0 237.75,-19.25"/>
<text text-anchor="middle" x="189.62" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">math::aliquot_sum</text>
</a>

Before

Width:  |  Height:  |  Size: 2.5 KiB

After

Width:  |  Height:  |  Size: 2.5 KiB