mirror of
https://github.com/TheAlgorithms/C-Plus-Plus.git
synced 2026-05-11 19:17:21 +08:00
Documentation for 8b1eab204b
This commit is contained in:
realstealthninja
@@ -1,3 +1,4 @@
|
||||
<!-- HTML header for doxygen 1.12.0-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
@@ -5,10 +6,15 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.12.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Algorithms_in_C++: math/n_choose_r.cpp File Reference</title>
|
||||
<title>TheAlgorithms/C++: math/n_choose_r.cpp File Reference</title>
|
||||
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
|
||||
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../jquery.js"></script>
|
||||
<script type="text/javascript" src="../../dynsections.js"></script>
|
||||
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@xpack-3rd-party/doxygen-awesome-css@2.2.0-1/doxygen-awesome-darkmode-toggle.js"></script>
|
||||
<script type="text/javascript">
|
||||
DoxygenAwesomeDarkModeToggle.init()
|
||||
</script>
|
||||
<script type="text/javascript" src="../../clipboard.js"></script>
|
||||
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../navtreedata.js"></script>
|
||||
@@ -18,14 +24,24 @@
|
||||
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="../../search/search.js"></script>
|
||||
<script type="text/x-mathjax-config">
|
||||
MathJax.Hub.Config({
|
||||
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
|
||||
jax: ["input/TeX","output/HTML-CSS"],
|
||||
});
|
||||
<script type="text/javascript">
|
||||
window.MathJax = {
|
||||
options: {
|
||||
ignoreHtmlClass: 'tex2jax_ignore',
|
||||
processHtmlClass: 'tex2jax_process'
|
||||
},
|
||||
loader: {
|
||||
load: ['[tex]/ams']
|
||||
},
|
||||
tex: {
|
||||
macros: {},
|
||||
packages: ['base','configmacros','ams']
|
||||
}
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
|
||||
<script type="text/javascript" id="MathJax-script" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
|
||||
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
@@ -33,10 +49,11 @@ MathJax.Hub.Config({
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<td id="projectlogo"><img alt="Logo" src="../../project_logo.png"/></td>
|
||||
<td id="projectalign">
|
||||
<div id="projectname">Algorithms_in_C++<span id="projectnumber"> 1.0.0</span>
|
||||
<div id="projectname">TheAlgorithms/C++<span id="projectnumber"> 1.0.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">Set of algorithms implemented in C++.</div>
|
||||
<div id="projectbrief">All the algorithms implemented in C++</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -121,7 +138,9 @@ Include dependency graph for n_choose_r.cpp:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/df6/n__choose__r_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">
|
||||
</div>
|
||||
<p><a href="../../d1/dbb/n__choose__r_8cpp_source.html">Go to the source code of this file.</a></p>
|
||||
<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  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d47/namespacemath.html">math</a></td></tr>
|
||||
@@ -145,6 +164,8 @@ Functions</h2></td></tr>
|
||||
<div class="textblock"><p><a href="https://en.wikipedia.org/wiki/Combination" target="_blank">Combinations</a> n choose r function implementation </p>
|
||||
<p>A very basic and efficient method of calculating choosing r from n different choices. \( \binom{n}{r} = \frac{n!}{r! (n-r)!} \)</p>
|
||||
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/tjgurwara99" target="_blank">Tajmeet Singh</a> </dd></dl>
|
||||
|
||||
<p class="definition">Definition in file <a class="el" href="../../d1/dbb/n__choose__r_8cpp_source.html">n_choose_r.cpp</a>.</p>
|
||||
</div><h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="a0ddf1224851353fc92bfbff6f499fa97" name="a0ddf1224851353fc92bfbff6f499fa97"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a0ddf1224851353fc92bfbff6f499fa97">◆ </a></span>main()</h2>
|
||||
@@ -174,17 +195,14 @@ Functions</h2></td></tr>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d1/dbb/n__choose__r_8cpp_source.html#l00080">80</a> of file <a class="el" href="../../d1/dbb/n__choose__r_8cpp_source.html">n_choose_r.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 80</span> {</div>
|
||||
<div class="line"><span class="lineno"> 81</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// executing tests</span></div>
|
||||
<div class="line"><span class="lineno"> 82</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><span class="lineno"> 83</span>}</div>
|
||||
<div class="ttc" id="an__choose__r_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#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><!-- 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="../../d1/dbb/n__choose__r_8cpp_a0ddf1224851353fc92bfbff6f499fa97_cgraph.svg" width="326" height="86"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
||||
</div>
|
||||
|
||||
<div class="ttc" id="an__choose__r_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Test implementations.</div><div class="ttdef"><b>Definition</b> <a href="../../d1/dbb/n__choose__r_8cpp_source.html#l00052">n_choose_r.cpp:52</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
|
||||
@@ -212,36 +230,31 @@ Here is the call graph for this function:</div>
|
||||
|
||||
<p>Test implementations. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d1/dbb/n__choose__r_8cpp_source.html#l00052">52</a> of file <a class="el" href="../../d1/dbb/n__choose__r_8cpp_source.html">n_choose_r.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 52</span> {</div>
|
||||
<div class="line"><span class="lineno"> 53</span> <span class="comment">// First test on 5 choose 2</span></div>
|
||||
<div class="line"><span class="lineno"> 54</span> uint8_t t = <a class="code hl_function" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(5, 2);</div>
|
||||
<div class="line"><span class="lineno"> 55</span> assert(((<span class="keywordtype">void</span>)<span class="stringliteral">"10 is the answer but function says otherwise.\n"</span>, t == 10));</div>
|
||||
<div class="line"><span class="lineno"> 56</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"First test passes."</span> << <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
|
||||
<div class="line"><span class="lineno"> 56</span> std::cout << <span class="stringliteral">"First test passes."</span> << std::endl;</div>
|
||||
<div class="line"><span class="lineno"> 57</span> <span class="comment">// Second test on 5 choose 3</span></div>
|
||||
<div class="line"><span class="lineno"> 58</span> t = <a class="code hl_function" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(5, 3);</div>
|
||||
<div class="line"><span class="lineno"> 59</span> assert(</div>
|
||||
<div class="line"><span class="lineno"> 60</span> ((<span class="keywordtype">void</span>)<span class="stringliteral">"10 is the answer but the function says otherwise.\n"</span>, t == 10));</div>
|
||||
<div class="line"><span class="lineno"> 61</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"Second test passes."</span> << <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
|
||||
<div class="line"><span class="lineno"> 61</span> std::cout << <span class="stringliteral">"Second test passes."</span> << std::endl;</div>
|
||||
<div class="line"><span class="lineno"> 62</span> <span class="comment">// Third test on 3 choose 2</span></div>
|
||||
<div class="line"><span class="lineno"> 63</span> t = <a class="code hl_function" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(3, 2);</div>
|
||||
<div class="line"><span class="lineno"> 64</span> assert(</div>
|
||||
<div class="line"><span class="lineno"> 65</span> ((<span class="keywordtype">void</span>)<span class="stringliteral">"3 is the answer but the function says otherwise.\n"</span>, t == 3));</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> << <span class="stringliteral">"Third test passes."</span> << <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
|
||||
<div class="line"><span class="lineno"> 66</span> std::cout << <span class="stringliteral">"Third test passes."</span> << std::endl;</div>
|
||||
<div class="line"><span class="lineno"> 67</span> <span class="comment">// Fourth test on 10 choose 4</span></div>
|
||||
<div class="line"><span class="lineno"> 68</span> t = <a class="code hl_function" href="../../dd/d47/namespacemath.html#a6e2dff75c5de70455b90c799d6ad6967">math::n_choose_r</a>(10, 4);</div>
|
||||
<div class="line"><span class="lineno"> 69</span> assert(((<span class="keywordtype">void</span>)<span class="stringliteral">"210 is the answer but the function says otherwise.\n"</span>,</div>
|
||||
<div class="line"><span class="lineno"> 70</span> t == 210));</div>
|
||||
<div class="line"><span class="lineno"> 71</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"Fourth test passes."</span> << <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
|
||||
<div class="line"><span class="lineno"> 71</span> std::cout << <span class="stringliteral">"Fourth test passes."</span> << std::endl;</div>
|
||||
<div class="line"><span class="lineno"> 72</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="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>
|
||||
<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><!-- 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="../../d1/dbb/n__choose__r_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="228" height="86"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></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> <a href="../../d1/dbb/n__choose__r_8cpp_source.html#l00035">n_choose_r.cpp:35</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
|
||||
Reference in New Issue
Block a user