Documentation for 66dcc4c394

This commit is contained in:
github-actions
2020-08-26 00:00:29 +00:00
parent 9e1217846f
commit 99f8d8f650
193 changed files with 4426 additions and 3339 deletions

View File

@@ -110,8 +110,8 @@ 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: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:aaf94f3212385cff0a5f19ff6b0cce8e7"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a> (uint64_t n)</td></tr>
<tr class="separator:aaf94f3212385cff0a5f19ff6b0cce8e7"><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>
@@ -126,31 +126,38 @@ 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="ae7c261942e9479f06ac145c08dcb6cc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7c261942e9479f06ac145c08dcb6cc7">&#9670;&nbsp;</a></span>fibonacci()</h2>
<a id="aaf94f3212385cff0a5f19ff6b0cce8e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf94f3212385cff0a5f19ff6b0cce8e7">&#9670;&nbsp;</a></span>fibonacci()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int fibonacci </td>
<td class="memname">uint64_t fibonacci </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</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="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#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>
<p>Recursively compute sequences </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>input </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>n-th element of the Fbinacci's sequence </dd></dl>
<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="comment">/* If the input is 0 or 1 just return the same</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> This will set the first 2 values of the sequence */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordflow">if</span> (n &lt;= 1) {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">return</span> n;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; }</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">/* Add the last 2 values of the sequence to get next */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">return</span> <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(n - 1) + <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(n - 2);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -176,32 +183,32 @@ int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../..
</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>
<p>Function for testing the <a class="el" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">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="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; uint64_t test_case_1 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(0);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; assert(test_case_1 == 0);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</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="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint64_t test_case_2 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(1);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; assert(test_case_2 == 1);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</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="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; uint64_t test_case_3 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(2);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; assert(test_case_3 == 1);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</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="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint64_t test_case_4 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(3);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; assert(test_case_4 == 2);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</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="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; uint64_t test_case_5 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(4);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; assert(test_case_5 == 3);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</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="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uint64_t test_case_6 = <a class="code" href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a>(15);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; assert(test_case_6 == 610);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</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="l00059"></a><span class="lineno"> 59</span>&#160;}</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -213,7 +220,7 @@ Here is the call graph for this function:</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<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="afibonacci_8cpp_html_aaf94f3212385cff0a5f19ff6b0cce8e7"><div class="ttname"><a href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7">fibonacci</a></div><div class="ttdeci">uint64_t fibonacci(uint64_t n)</div><div class="ttdef"><b>Definition:</b> fibonacci.cpp:19</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 -->

View File

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

View File

@@ -1,5 +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"/>
<area shape="rect" id="node3" href="$d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7" title=" " alt="" coords="97,56,172,83"/>
</map>

View File

@@ -1 +1 @@
31a2965054af2a23ede6712d92b30b03
d36e724ae347a5066d9c401b5599def1

View File

@@ -36,7 +36,7 @@
<!-- 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=" ">
<g id="a_node3"><a xlink:href="../../d9/d89/fibonacci_8cpp.html#aaf94f3212385cff0a5f19ff6b0cce8e7" 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>

Before

Width:  |  Height:  |  Size: 2.3 KiB

After

Width:  |  Height:  |  Size: 2.3 KiB