Documentation for 0931d530ae

This commit is contained in:
github-actions
2023-01-22 19:44:10 +00:00
parent a448f64699
commit b48f6e8671
2457 changed files with 9513 additions and 8691 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: probability/geometric_dist.cpp File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@ MathJax.Hub.Config({
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
@@ -140,22 +140,22 @@ 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:a82964ca6180507deb5fafc71050012ba"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d72/geometric__dist_8cpp.html#a82964ca6180507deb5fafc71050012ba">probability::geometric_dist::generate_uniform</a> ()</td></tr>
<tr class="memdesc:a82964ca6180507deb5fafc71050012ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a random number between [0,1]. <a href="../../de/d72/geometric__dist_8cpp.html#a82964ca6180507deb5fafc71050012ba">More...</a><br /></td></tr>
<tr class="memdesc:a82964ca6180507deb5fafc71050012ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a random number between [0,1]. <br /></td></tr>
<tr class="separator:a82964ca6180507deb5fafc71050012ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70fd1cc5c3a2813f28683dc75dcd65b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d72/geometric__dist_8cpp.html#a70fd1cc5c3a2813f28683dc75dcd65b6">sample_test</a> (const <a class="el" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html">probability::geometric_dist::geometric_distribution</a> &amp;dist)</td></tr>
<tr class="memdesc:a70fd1cc5c3a2813f28683dc75dcd65b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests the sampling method of the geometric distribution. <a href="../../de/d72/geometric__dist_8cpp.html#a70fd1cc5c3a2813f28683dc75dcd65b6">More...</a><br /></td></tr>
<tr class="memdesc:a70fd1cc5c3a2813f28683dc75dcd65b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests the sampling method of the geometric distribution. <br /></td></tr>
<tr class="separator:a70fd1cc5c3a2813f28683dc75dcd65b6"><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/d72/geometric__dist_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <a href="../../de/d72/geometric__dist_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">More...</a><br /></td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <br /></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">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d72/geometric__dist_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <a href="../../de/d72/geometric__dist_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br /></td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p ><a href="https://en.wikipedia.org/wiki/Geometric_distribution" target="_blank">Geometric Distribution</a> </p>
<p >The geometric distribution models the experiment of doing Bernoulli trials until a sucess was observed. There are two formulations of the geometric distribution: 1) The probability distribution of the number X of Bernoulli trials needed to get one success, supported on the set { 1, 2, 3, ... } 2) The probability distribution of the number Y = X 1 of failures before the first success, supported on the set { 0, 1, 2, 3, ... } Here, the first one is implemented.</p>
<p >Common variables used: p - The success probability k - The number of tries</p>
<div class="textblock"><p><a href="https://en.wikipedia.org/wiki/Geometric_distribution" target="_blank">Geometric Distribution</a> </p>
<p>The geometric distribution models the experiment of doing Bernoulli trials until a sucess was observed. There are two formulations of the geometric distribution: 1) The probability distribution of the number X of Bernoulli trials needed to get one success, supported on the set { 1, 2, 3, ... } 2) The probability distribution of the number Y = X 1 of failures before the first success, supported on the set { 0, 1, 2, 3, ... } Here, the first one is implemented.</p>
<p>Common variables used: p - The success probability k - The number of tries</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/DerAndereDomenic" target="_blank">Domenic Zingsheim</a> </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a82964ca6180507deb5fafc71050012ba" name="a82964ca6180507deb5fafc71050012ba"></a>
@@ -240,7 +240,7 @@ Here is the call graph for this function:</div>
</div><div class="memdoc">
<p>Tests the sampling method of the geometric distribution. </p>
<p >Draws 1000000 random samples and estimates mean and variance These should be close to the expected value and variance of the given distribution to pass. </p><dl class="params"><dt>Parameters</dt><dd>
<p>Draws 1000000 random samples and estimates mean and variance These should be close to the expected value and variance of the given distribution to pass. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dist</td><td>The distribution to test </td></tr>
</table>
@@ -384,7 +384,7 @@ Here is the call graph for this function:</div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_82e494173a87936756866de2fa774307.html">probability</a></li><li class="navelem"><a class="el" href="../../de/d72/geometric__dist_8cpp.html">geometric_dist.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
</ul>
</div>
</body>