Documentation for 67e26cfbae

This commit is contained in:
github-actions
2020-11-22 17:38:23 +00:00
parent a3bea7d7bd
commit 706b4eea3b
394 changed files with 8360 additions and 6581 deletions

View File

@@ -100,8 +100,8 @@ $(document).ready(function(){initNavTree('d1/dbb/n__choose__r_8cpp.html','../../
<p><a href="https://en.wikipedia.org/wiki/Combination">Combinations</a> n choose r function implementation
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;cassert&gt;</code><br />
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for n_choose_r.cpp:</div>
<div class="dyncontent">
@@ -168,10 +168,10 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; {</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="../../d1/dbb/n__choose__r_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// executing tests</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
<div class="fragment"><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; {</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="../../d1/dbb/n__choose__r_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// executing tests</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;}</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -206,28 +206,27 @@ Here is the call graph for this function:</div>
<p>Test implementations. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="comment">// First test on 5 choose 2</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; uint8_t t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(5, 2);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;10 is the answer but function says otherwise.\n&quot;</span>,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; t == 10));</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;First test passes.&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; <span class="comment">// Second test on 5 choose 3</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(5, 3);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;10 is the answer but the function says otherwise.\n&quot;</span>,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; t == 10));</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</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;Second test passes.&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="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// Third test on 3 choose 2</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(3, 2);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;3 is the answer but the function says otherwise.\n&quot;</span>,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; t == 3));</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</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;Third test passes.&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="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// Fourth test on 10 choose 4</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(10, 4);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;210 is the answer but the function says otherwise.\n&quot;</span>,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; t == 210));</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</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;Fourth test passes.&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="l00070"></a><span class="lineno"> 70</span>&#160;}</div>
<div class="fragment"><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="comment">// First test on 5 choose 2</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint8_t t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(5, 2);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;10 is the answer but function says otherwise.\n&quot;</span>, t == 10));</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</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;First test passes.&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="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// Second test on 5 choose 3</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(5, 3);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; assert(</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; ((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;10 is the answer but the function says otherwise.\n&quot;</span>, t == 10));</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</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;Second test passes.&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="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// Third test on 3 choose 2</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(3, 2);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; assert(</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; ((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;3 is the answer but the function says otherwise.\n&quot;</span>, t == 3));</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</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;Third test passes.&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="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// Fourth test on 10 choose 4</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; t = <a class="code" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(10, 4);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;210 is the answer but the function says otherwise.\n&quot;</span>,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; t == 210));</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</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;Fourth test passes.&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="l00072"></a><span class="lineno"> 72</span>&#160;}</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -239,9 +238,9 @@ Here is the call graph for this function:</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="an__choose__r_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../d1/dbb/n__choose__r_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Test implementations.</div><div class="ttdef"><b>Definition:</b> n_choose_r.cpp:49</div></div>
<div class="ttc" id="an__choose__r_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../d1/dbb/n__choose__r_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Test implementations.</div><div class="ttdef"><b>Definition:</b> n_choose_r.cpp:52</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="anamespacemath_html_a6e2dff75c5de70455b90c799d6ad6967"><div class="ttname"><a href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a></div><div class="ttdeci">T n_choose_r(T n, T r)</div><div class="ttdoc">This is the function implementation of .</div><div class="ttdef"><b>Definition:</b> n_choose_r.cpp:33</div></div>
<div class="ttc" id="anamespacemath_html_a6e2dff75c5de70455b90c799d6ad6967"><div class="ttname"><a href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a></div><div class="ttdeci">T n_choose_r(T n, T r)</div><div class="ttdoc">This is the function implementation of .</div><div class="ttdef"><b>Definition:</b> n_choose_r.cpp:35</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! -->