backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 12:23:13 +08:00
Code Issues Projects Releases Wiki Activity
Files
08bdc61024461e46c94bdadf200d7f7c5aa7d9e7
C-Plus-Plus/de/d72/geometric__dist_8cpp.html
github-actions 29158cf9a8 Documentation for ff80be4b0a
2023-06-16 21:35:33 +00:00

387 lines
34 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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>
<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.7"/>
<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"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<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>
<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>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('de/d72/geometric__dist_8cpp.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">geometric_dist.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="https://en.wikipedia.org/wiki/Geometric_distribution" target="_blank">Geometric Distribution</a>
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;ctime&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;limits&gt;</code><br />
<code>#include &lt;random&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for geometric_dist.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../df/d2c/geometric__dist_8cpp__incl.svg" width="662" height="126"><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">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html">probability::geometric_dist::geometric_distribution</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A class to model the geometric distribution. <a href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:d4/ded/namespaceprobability"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/ded/namespaceprobability.html">probability</a></td></tr>
<tr class="memdesc:d4/ded/namespaceprobability"><td class="mdescLeft">&#160;</td><td class="mdescRight">Probability algorithms. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:dd/d8a/namespacegeometric__dist"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d8a/namespacegeometric__dist.html">geometric_dist</a></td></tr>
<tr class="memdesc:dd/d8a/namespacegeometric__dist"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for the <a href="https://en.wikipedia.org/wiki/Geometric_distribution" target="_blank">Geometric Distribution</a> algorithm implementation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<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]. <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. <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. <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. <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>
<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>
<h2 class="memtitle"><span class="permalink"><a href="#a82964ca6180507deb5fafc71050012ba">&#9670;&#160;</a></span>generate_uniform()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float probability::geometric_dist::generate_uniform </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a random number between [0,1]. </p>
<dl class="section return"><dt>Returns</dt><dd>A uniformly distributed random number between 0 (included) and 1 (included) </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 48</span> {</div>
<div class="line"><span class="lineno"> 49</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/random/rand.html">rand</a>()) / <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(RAND_MAX);</div>
<div class="line"><span class="lineno"> 50</span>}</div>
<div class="ttc" id="arand_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/random/rand.html">std::rand</a></div><div class="ttdeci">T rand(T... args)</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="../../de/d72/geometric__dist_8cpp_a82964ca6180507deb5fafc71050012ba_cgraph.svg" width="168" height="76"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&#160;</a></span>main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main function. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 256</span> {</div>
<div class="line"><span class="lineno"> 257</span> <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/random/srand.html">srand</a>(<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/chrono/c/time.html">time</a>(<span class="keyword">nullptr</span>));</div>
<div class="line"><span class="lineno"> 258</span> <a class="code hl_function" href="../../de/d72/geometric__dist_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><span class="lineno"> 259</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 260</span>}</div>
<div class="ttc" id="ageometric__dist_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../de/d72/geometric__dist_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> geometric_dist.cpp:197</div></div>
<div class="ttc" id="asrand_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/random/srand.html">std::srand</a></div><div class="ttdeci">T srand(T... args)</div></div>
<div class="ttc" id="atime_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/c/time.html">std::time</a></div><div class="ttdeci">T time(T... args)</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="../../de/d72/geometric__dist_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="100%" height="600"><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>
<a id="a70fd1cc5c3a2813f28683dc75dcd65b6" name="a70fd1cc5c3a2813f28683dc75dcd65b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70fd1cc5c3a2813f28683dc75dcd65b6">&#9670;&#160;</a></span>sample_test()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sample_test </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html">probability::geometric_dist::geometric_distribution</a> &amp;&#160;</td>
<td class="paramname"><em>dist</em></td><td>)</td>
<td></td>
</tr>
</table>
</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>
<table class="params">
<tr><td class="paramname">dist</td><td>The distribution to test </td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="lineno"> 166</span> {</div>
<div class="line"><span class="lineno"> 167</span> uint32_t n_tries = 1000000;</div>
<div class="line"><span class="lineno"> 168</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;float&gt;</a> tries;</div>
<div class="line"><span class="lineno"> 169</span> tries.<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector/resize.html">resize</a>(n_tries);</div>
<div class="line"><span class="lineno"> 170</span> </div>
<div class="line"><span class="lineno"> 171</span> <span class="keywordtype">float</span> mean = 0.0f;</div>
<div class="line"><span class="lineno"> 172</span> <span class="keywordflow">for</span> (uint32_t i = 0; i &lt; n_tries; ++i) {</div>
<div class="line"><span class="lineno"> 173</span> tries[i] = <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(dist.<a class="code hl_function" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html#a8aae1cebcf42ed2332f1c7217c401aa3">draw_sample</a>());</div>
<div class="line"><span class="lineno"> 174</span> mean += tries[i];</div>
<div class="line"><span class="lineno"> 175</span> }</div>
<div class="line"><span class="lineno"> 176</span> </div>
<div class="line"><span class="lineno"> 177</span> mean /= <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(n_tries);</div>
<div class="line"><span class="lineno"> 178</span> </div>
<div class="line"><span class="lineno"> 179</span> <span class="keywordtype">float</span> var = 0.0f;</div>
<div class="line"><span class="lineno"> 180</span> <span class="keywordflow">for</span> (uint32_t i = 0; i &lt; n_tries; ++i) {</div>
<div class="line"><span class="lineno"> 181</span> var += (tries[i] - mean) * (tries[i] - mean);</div>
<div class="line"><span class="lineno"> 182</span> }</div>
<div class="line"><span class="lineno"> 183</span> </div>
<div class="line"><span class="lineno"> 184</span> <span class="comment">// Unbiased estimate of variance</span></div>
<div class="line"><span class="lineno"> 185</span> var /= <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(n_tries - 1);</div>
<div class="line"><span class="lineno"> 186</span> </div>
<div class="line"><span class="lineno"> 187</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;This value should be near &quot;</span> &lt;&lt; dist.<a class="code hl_function" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html#a41051365f8ac7700f2ed5880a6760413">expected_value</a>() &lt;&lt; <span class="stringliteral">&quot;: &quot;</span></div>
<div class="line"><span class="lineno"> 188</span> &lt;&lt; mean &lt;&lt; <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"> 189</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;This value should be near &quot;</span> &lt;&lt; dist.<a class="code hl_function" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html#aea8b0d649f0dc9a6f8baf3341a0b4960">variance</a>() &lt;&lt; <span class="stringliteral">&quot;: &quot;</span> &lt;&lt; var</div>
<div class="line"><span class="lineno"> 190</span> &lt;&lt; <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"> 191</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="aclassprobability_1_1geometric__dist_1_1geometric__distribution_html_a41051365f8ac7700f2ed5880a6760413"><div class="ttname"><a href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html#a41051365f8ac7700f2ed5880a6760413">probability::geometric_dist::geometric_distribution::expected_value</a></div><div class="ttdeci">float expected_value() const</div><div class="ttdoc">The expected value of a geometrically distributed random variable X.</div><div class="ttdef"><b>Definition</b> geometric_dist.cpp:71</div></div>
<div class="ttc" id="aclassprobability_1_1geometric__dist_1_1geometric__distribution_html_a8aae1cebcf42ed2332f1c7217c401aa3"><div class="ttname"><a href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html#a8aae1cebcf42ed2332f1c7217c401aa3">probability::geometric_dist::geometric_distribution::draw_sample</a></div><div class="ttdeci">uint32_t draw_sample() const</div><div class="ttdoc">Generates a (discrete) sample according to the geometrical distribution.</div><div class="ttdef"><b>Definition</b> geometric_dist.cpp:125</div></div>
<div class="ttc" id="aclassprobability_1_1geometric__dist_1_1geometric__distribution_html_aea8b0d649f0dc9a6f8baf3341a0b4960"><div class="ttname"><a href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html#aea8b0d649f0dc9a6f8baf3341a0b4960">probability::geometric_dist::geometric_distribution::variance</a></div><div class="ttdeci">float variance() const</div><div class="ttdoc">The variance of a geometrically distributed random variable X.</div><div class="ttdef"><b>Definition</b> geometric_dist.cpp:77</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="aresize_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/resize.html">std::vector::resize</a></div><div class="ttdeci">T resize(T... args)</div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="../../de/d72/geometric__dist_8cpp_a70fd1cc5c3a2813f28683dc75dcd65b6_cgraph.svg" width="100%" height="585"><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>
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&#160;</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>Self-test implementations. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 197</span> {</div>
<div class="line"><span class="lineno"> 198</span> <a class="code hl_class" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html">probability::geometric_dist::geometric_distribution</a> dist(0.3);</div>
<div class="line"><span class="lineno"> 199</span> </div>
<div class="line"><span class="lineno"> 200</span> <span class="keyword">const</span> <span class="keywordtype">float</span> threshold = 1e-3f;</div>
<div class="line"><span class="lineno"> 201</span> </div>
<div class="line"><span class="lineno"> 202</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Starting tests for p = 0.3...&quot;</span> &lt;&lt; <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"> 203</span> assert(std::abs(dist.expected_value() - 3.33333333f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 204</span> assert(std::abs(dist.variance() - 7.77777777f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 205</span> assert(std::abs(dist.standard_deviation() - 2.788866755) &lt; threshold);</div>
<div class="line"><span class="lineno"> 206</span> assert(std::abs(dist.probability_density(5) - 0.07203) &lt; threshold);</div>
<div class="line"><span class="lineno"> 207</span> assert(std::abs(dist.cumulative_distribution(6) - 0.882351) &lt; threshold);</div>
<div class="line"><span class="lineno"> 208</span> assert(std::abs(dist.inverse_cumulative_distribution(</div>
<div class="line"><span class="lineno"> 209</span> dist.cumulative_distribution(8)) -</div>
<div class="line"><span class="lineno"> 210</span> 8) &lt; threshold);</div>
<div class="line"><span class="lineno"> 211</span> assert(std::abs(dist.range_tries() - 1.0f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 212</span> assert(std::abs(dist.range_tries(3) - 0.49f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 213</span> assert(std::abs(dist.range_tries(5, 11) - 0.2203267f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 214</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;All tests passed&quot;</span> &lt;&lt; <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"> 215</span> <a class="code hl_function" href="../../de/d72/geometric__dist_8cpp.html#a70fd1cc5c3a2813f28683dc75dcd65b6">sample_test</a>(dist);</div>
<div class="line"><span class="lineno"> 216</span> </div>
<div class="line"><span class="lineno"> 217</span> dist = <a class="code hl_class" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html">probability::geometric_dist::geometric_distribution</a>(0.5f);</div>
<div class="line"><span class="lineno"> 218</span> </div>
<div class="line"><span class="lineno"> 219</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Starting tests for p = 0.5...&quot;</span> &lt;&lt; <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"> 220</span> assert(std::abs(dist.expected_value() - 2.0f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 221</span> assert(std::abs(dist.variance() - 2.0f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 222</span> assert(std::abs(dist.standard_deviation() - 1.4142135f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 223</span> assert(std::abs(dist.probability_density(5) - 0.03125) &lt; threshold);</div>
<div class="line"><span class="lineno"> 224</span> assert(std::abs(dist.cumulative_distribution(6) - 0.984375) &lt; threshold);</div>
<div class="line"><span class="lineno"> 225</span> assert(std::abs(dist.inverse_cumulative_distribution(</div>
<div class="line"><span class="lineno"> 226</span> dist.cumulative_distribution(8)) -</div>
<div class="line"><span class="lineno"> 227</span> 8) &lt; threshold);</div>
<div class="line"><span class="lineno"> 228</span> assert(std::abs(dist.range_tries() - 1.0f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 229</span> assert(std::abs(dist.range_tries(3) - 0.25f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 230</span> assert(std::abs(dist.range_tries(5, 11) - 0.062011f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 231</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;All tests passed&quot;</span> &lt;&lt; <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"> 232</span> <a class="code hl_function" href="../../de/d72/geometric__dist_8cpp.html#a70fd1cc5c3a2813f28683dc75dcd65b6">sample_test</a>(dist);</div>
<div class="line"><span class="lineno"> 233</span> </div>
<div class="line"><span class="lineno"> 234</span> dist = <a class="code hl_class" href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html">probability::geometric_dist::geometric_distribution</a>(0.8f);</div>
<div class="line"><span class="lineno"> 235</span> </div>
<div class="line"><span class="lineno"> 236</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Starting tests for p = 0.8...&quot;</span> &lt;&lt; <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"> 237</span> assert(std::abs(dist.expected_value() - 1.25f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 238</span> assert(std::abs(dist.variance() - 0.3125f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 239</span> assert(std::abs(dist.standard_deviation() - 0.559016f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 240</span> assert(std::abs(dist.probability_density(5) - 0.00128) &lt; threshold);</div>
<div class="line"><span class="lineno"> 241</span> assert(std::abs(dist.cumulative_distribution(6) - 0.999936) &lt; threshold);</div>
<div class="line"><span class="lineno"> 242</span> assert(std::abs(dist.inverse_cumulative_distribution(</div>
<div class="line"><span class="lineno"> 243</span> dist.cumulative_distribution(8)) -</div>
<div class="line"><span class="lineno"> 244</span> 8) &lt; threshold);</div>
<div class="line"><span class="lineno"> 245</span> assert(std::abs(dist.range_tries() - 1.0f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 246</span> assert(std::abs(dist.range_tries(3) - 0.04f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 247</span> assert(std::abs(dist.range_tries(5, 11) - 0.00159997f) &lt; threshold);</div>
<div class="line"><span class="lineno"> 248</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;All tests have successfully passed!&quot;</span> &lt;&lt; <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"> 249</span> <a class="code hl_function" href="../../de/d72/geometric__dist_8cpp.html#a70fd1cc5c3a2813f28683dc75dcd65b6">sample_test</a>(dist);</div>
<div class="line"><span class="lineno"> 250</span>}</div>
<div class="ttc" id="aclassprobability_1_1geometric__dist_1_1geometric__distribution_html"><div class="ttname"><a href="../../da/d19/classprobability_1_1geometric__dist_1_1geometric__distribution.html">probability::geometric_dist::geometric_distribution</a></div><div class="ttdoc">A class to model the geometric distribution.</div><div class="ttdef"><b>Definition</b> geometric_dist.cpp:55</div></div>
<div class="ttc" id="ageometric__dist_8cpp_html_a70fd1cc5c3a2813f28683dc75dcd65b6"><div class="ttname"><a href="../../de/d72/geometric__dist_8cpp.html#a70fd1cc5c3a2813f28683dc75dcd65b6">sample_test</a></div><div class="ttdeci">void sample_test(const probability::geometric_dist::geometric_distribution &amp;dist)</div><div class="ttdoc">Tests the sampling method of the geometric distribution.</div><div class="ttdef"><b>Definition</b> geometric_dist.cpp:165</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="../../de/d72/geometric__dist_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="100%" height="600"><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>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<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.7 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink