Documentation for 9adf7f465c

This commit is contained in:
github-actions
2020-08-16 16:38:54 +00:00
parent c3c8577331
commit e18164bf60
19 changed files with 189 additions and 65 deletions

View File

@@ -110,8 +110,10 @@ Include dependency graph for fibonacci.cpp:</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4bc27e88a3da5cc590f1f78622019a7b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d89/fibonacci_8cpp.html#a4bc27e88a3da5cc590f1f78622019a7b">fibonacci</a> (unsigned int n)</td></tr>
<tr class="separator:a4bc27e88a3da5cc590f1f78622019a7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7c261942e9479f06ac145c08dcb6cc7"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a> (unsigned int n)</td></tr>
<tr class="separator:ae7c261942e9479f06ac145c08dcb6cc7"><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="../../d9/d89/fibonacci_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top"><a id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d89/fibonacci_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <br /></td></tr>
@@ -124,14 +126,14 @@ int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../..
</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="../../de/de4/fibonacci__large_8cpp.html" title="Computes N^th Fibonacci number given as input argument. Uses custom build arbitrary integers library ...">fibonacci_large.cpp</a>, <a class="el" href="../../d4/d32/fibonacci__fast_8cpp.html" title="Faster computation of Fibonacci series.">fibonacci_fast.cpp</a>, <a class="el" href="../../de/d47/string__fibonacci_8cpp.html" title="This Programme returns the Nth fibonacci as a string.">string_fibonacci.cpp</a> </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a4bc27e88a3da5cc590f1f78622019a7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bc27e88a3da5cc590f1f78622019a7b">&#9670;&nbsp;</a></span>fibonacci()</h2>
<a id="ae7c261942e9479f06ac145c08dcb6cc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7c261942e9479f06ac145c08dcb6cc7">&#9670;&nbsp;</a></span>fibonacci()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fibonacci </td>
<td class="memname">unsigned int fibonacci </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
@@ -140,21 +142,80 @@ int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../..
</table>
</div><div class="memdoc">
<p>Recursively compute sequences </p>
<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; {</div>
<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">/* If the input is 0 or 1 just return the same</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> This will set the first 2 values of the sequence */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">if</span> (n &lt;= 1)</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordflow">return</span> n;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">/* Add the last 2 values of the sequence to get next */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordflow">return</span> <a class="code" href="../../d9/d89/fibonacci_8cpp.html#a4bc27e88a3da5cc590f1f78622019a7b">fibonacci</a>(n - 1) + <a class="code" href="../../d9/d89/fibonacci_8cpp.html#a4bc27e88a3da5cc590f1f78622019a7b">fibonacci</a>(n - 2);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordflow">return</span> <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(n - 1) + <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(n - 2);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&nbsp;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function for testing the <a class="el" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci()</a> function with a few test cases and assert statement. </p><dl class="section return"><dt>Returns</dt><dd><code>void</code> </dd></dl>
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> test_case_1 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(0);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; assert(test_case_1 == 0);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Passed Test 1!&quot;</span> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> test_case_2 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(1);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; assert(test_case_2 == 1);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Passed Test 2!&quot;</span> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> test_case_3 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(2);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; assert(test_case_3 == 1);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Passed Test 3!&quot;</span> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> test_case_4 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(3);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; assert(test_case_4 == 2);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Passed Test 4!&quot;</span> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</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; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> test_case_5 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(4);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; assert(test_case_5 == 3);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Passed Test 5!&quot;</span> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> test_case_6 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a>(15);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; assert(test_case_6 == 610);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Passed Test 6!&quot;</span> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;}</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d9/d89/fibonacci_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="178" height="88"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="afibonacci_8cpp_html_a4bc27e88a3da5cc590f1f78622019a7b"><div class="ttname"><a href="../../d9/d89/fibonacci_8cpp.html#a4bc27e88a3da5cc590f1f78622019a7b">fibonacci</a></div><div class="ttdeci">int fibonacci(unsigned int n)</div><div class="ttdef"><b>Definition:</b> fibonacci.cpp:17</div></div>
<div class="ttc" id="afibonacci_8cpp_html_ae7c261942e9479f06ac145c08dcb6cc7"><div class="ttname"><a href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7">fibonacci</a></div><div class="ttdeci">unsigned int fibonacci(unsigned int n)</div><div class="ttdef"><b>Definition:</b> fibonacci.cpp:17</div></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="aendl_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a></div><div class="ttdeci">T endl(T... args)</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>

View File

@@ -1,5 +1,6 @@
var fibonacci_8cpp =
[
[ "fibonacci", "d9/d89/fibonacci_8cpp.html#a4bc27e88a3da5cc590f1f78622019a7b", null ],
[ "main", "d9/d89/fibonacci_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4", null ]
[ "fibonacci", "d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7", null ],
[ "main", "d9/d89/fibonacci_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4", null ],
[ "test", "d9/d89/fibonacci_8cpp.html#aa8dca7b867074164d5f45b0f3851269d", null ]
];

View File

@@ -0,0 +1,5 @@
<map id="test" name="test">
<area shape="rect" id="node1" title=" " alt="" coords="5,31,49,57"/>
<area shape="rect" id="node2" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/io/manip/endl.html#" title=" " alt="" coords="99,5,171,32"/>
<area shape="rect" id="node3" href="$d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7" title=" " alt="" coords="97,56,172,83"/>
</map>

View File

@@ -0,0 +1 @@
31a2965054af2a23ede6712d92b30b03

View File

@@ -0,0 +1,52 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.44.1 (20200629.0846)
-->
<!-- Title: test Pages: 1 -->
<svg width="133pt" height="66pt"
viewBox="0.00 0.00 133.00 66.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 62)">
<title>test</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-62 129,-62 129,4 -4,4"/>
<!-- Node1 -->
<g id="node1" class="node">
<title>Node1</title>
<g id="a_node1"><a xlink:title=" ">
<polygon fill="#bfbfbf" stroke="black" points="0,-19.5 0,-38.5 33,-38.5 33,-19.5 0,-19.5"/>
<text text-anchor="middle" x="16.5" y="-26.5" font-family="Helvetica,sans-Serif" font-size="10.00">test</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="node2" class="node">
<title>Node2</title>
<g id="a_node2"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/io/manip/endl.html#" xlink:title=" ">
<polygon fill="white" stroke="black" points="70,-38.5 70,-57.5 124,-57.5 124,-38.5 70,-38.5"/>
<text text-anchor="middle" x="97" y="-45.5" font-family="Helvetica,sans-Serif" font-size="10.00">std::endl</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node2 -->
<g id="edge1" class="edge">
<title>Node1&#45;&gt;Node2</title>
<path fill="none" stroke="midnightblue" d="M33.01,-32.75C40.69,-34.61 50.31,-36.94 59.7,-39.21"/>
<polygon fill="midnightblue" stroke="midnightblue" points="59.16,-42.68 69.7,-41.63 60.81,-35.88 59.16,-42.68"/>
</g>
<!-- Node3 -->
<g id="node3" class="node">
<title>Node3</title>
<g id="a_node3"><a xlink:href="../../d9/d89/fibonacci_8cpp.html#ae7c261942e9479f06ac145c08dcb6cc7" target="_top" xlink:title=" ">
<polygon fill="white" stroke="black" points="69,-0.5 69,-19.5 125,-19.5 125,-0.5 69,-0.5"/>
<text text-anchor="middle" x="97" y="-7.5" font-family="Helvetica,sans-Serif" font-size="10.00">fibonacci</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node3 -->
<g id="edge2" class="edge">
<title>Node1&#45;&gt;Node3</title>
<path fill="none" stroke="midnightblue" d="M33.01,-25.25C40.49,-23.44 49.82,-21.18 58.98,-18.96"/>
<polygon fill="midnightblue" stroke="midnightblue" points="59.87,-22.35 68.76,-16.59 58.22,-15.54 59.87,-22.35"/>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 2.3 KiB