Documentation for 2dadbf73f4

This commit is contained in:
github-actions
2024-02-12 20:07:08 +00:00
parent b5b4d78981
commit a1eb9bd385
1261 changed files with 30404 additions and 29974 deletions

View File

@@ -3,16 +3,18 @@
<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.8"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: math/approximate_pi.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>
<script type="text/javascript" src="../../clipboard.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>
<script type="text/javascript" src="../../cookie.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>
@@ -41,7 +43,7 @@ MathJax.Hub.Config({
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
@@ -53,7 +55,7 @@ var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
$(function() { init_search(); });
});
/* @license-end */
</script>
@@ -71,7 +73,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d0/d51/approximate__pi_8cpp.html','../../'); initResizable(); });
$(function(){initNavTree('d0/d51/approximate__pi_8cpp.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
@@ -100,8 +102,7 @@ $(document).ready(function(){initNavTree('d0/d51/approximate__pi_8cpp.html','../
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">approximate_pi.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
@@ -126,28 +127,21 @@ Namespaces</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a937dc0c826acf3e6c0d2785527f7e9d7" id="r_a937dc0c826acf3e6c0d2785527f7e9d7"><td class="memItemLeft" align="right" valign="top"><a id="a937dc0c826acf3e6c0d2785527f7e9d7" name="a937dc0c826acf3e6c0d2785527f7e9d7"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>math::Point</b> = { double x</td></tr>
<tr class="memdesc:a937dc0c826acf3e6c0d2785527f7e9d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure of points containing two numbers, x and y, such that 0 ≤ x ≤ 1 and 0 ≤ y ≤ 1. <br /></td></tr>
<tr class="separator:a937dc0c826acf3e6c0d2785527f7e9d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a006c8ebd11bb1e035815dc835a1a7a85" id="r_a006c8ebd11bb1e035815dc835a1a7a85"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d47/namespacemath.html#a006c8ebd11bb1e035815dc835a1a7a85">math::Point</a></td></tr>
<tr class="memdesc:a006c8ebd11bb1e035815dc835a1a7a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure of points containing two numbers, x and y, such that 0 ≤ x ≤ 1 and 0 ≤ y ≤ 1. <br /></td></tr>
<tr class="separator:a006c8ebd11bb1e035815dc835a1a7a85"><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:abf7f2a6d91f1ca6c89698792aea3f188" id="r_abf7f2a6d91f1ca6c89698792aea3f188"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d47/namespacemath.html#abf7f2a6d91f1ca6c89698792aea3f188">math::approximate_pi</a> (const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="el" href="../../dd/d47/namespacemath.html#a937dc0c826acf3e6c0d2785527f7e9d7">Point</a> &gt; &amp;pts)</td></tr>
<tr class="memitem:abf7f2a6d91f1ca6c89698792aea3f188" id="r_abf7f2a6d91f1ca6c89698792aea3f188"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d47/namespacemath.html#abf7f2a6d91f1ca6c89698792aea3f188">math::approximate_pi</a> (const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="el" href="../../dd/d47/namespacemath.html#a006c8ebd11bb1e035815dc835a1a7a85">Point</a> &gt; &amp;pts)</td></tr>
<tr class="memdesc:abf7f2a6d91f1ca6c89698792aea3f188"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function uses the points in a given vector 'pts' (drawn at random) to return an approximation of the number π. <br /></td></tr>
<tr class="separator:abf7f2a6d91f1ca6c89698792aea3f188"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a483bb8ccf42aaf7375a83e91490eda1e" id="r_a483bb8ccf42aaf7375a83e91490eda1e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d51/approximate__pi_8cpp.html#a483bb8ccf42aaf7375a83e91490eda1e">tests</a> ()</td></tr>
<tr class="memitem:a483bb8ccf42aaf7375a83e91490eda1e" id="r_a483bb8ccf42aaf7375a83e91490eda1e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a> ()</td></tr>
<tr class="memdesc:a483bb8ccf42aaf7375a83e91490eda1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <br /></td></tr>
<tr class="separator:a483bb8ccf42aaf7375a83e91490eda1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d51/approximate__pi_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a7d9210f6c94ea8c936a8162dc16c829a" id="r_a7d9210f6c94ea8c936a8162dc16c829a"><td class="memItemLeft" align="right" valign="top"><a id="a7d9210f6c94ea8c936a8162dc16c829a" name="a7d9210f6c94ea8c936a8162dc16c829a"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>math::y</b></td></tr>
<tr class="separator:a7d9210f6c94ea8c936a8162dc16c829a"><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>Implementation to calculate an estimate of the <a href="https://en.wikipedia.org/wiki/File:Pi_30K.gif" target="_blank">number π (Pi)</a>. </p>
@@ -163,8 +157,7 @@ double&#160;</td><td class="memItemRight" valign="bottom"><b>math::y</b></td></t
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
@@ -173,10 +166,10 @@ double&#160;</td><td class="memItemRight" valign="bottom"><b>math::y</b></td></t
<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"> 80</span> {</div>
<div class="line"><span class="lineno"> 81</span> <a class="code hl_function" href="../../d0/d51/approximate__pi_8cpp.html#a483bb8ccf42aaf7375a83e91490eda1e">tests</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><span class="lineno"> 81</span> <a class="code hl_function" href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a>(); <span class="comment">// run self-test implementations</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="aapproximate__pi_8cpp_html_a483bb8ccf42aaf7375a83e91490eda1e"><div class="ttname"><a href="../../d0/d51/approximate__pi_8cpp.html#a483bb8ccf42aaf7375a83e91490eda1e">tests</a></div><div class="ttdeci">static void tests()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> approximate_pi.cpp:62</div></div>
<div class="ttc" id="aapproximate__pi_8cpp_html_a483bb8ccf42aaf7375a83e91490eda1e"><div class="ttname"><a href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a></div><div class="ttdeci">static void tests()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> approximate_pi.cpp:62</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -197,7 +190,7 @@ Here is the call graph for this function:</div>
<tr>
<td class="memname">static void tests </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
@@ -213,9 +206,9 @@ Here is the call graph for this function:</div>
<div class="fragment"><div class="line"><span class="lineno"> 62</span> {</div>
<div class="line"><span class="lineno"> 63</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;math::Point&gt;</a> rands;</div>
<div class="line"><span class="lineno"> 64</span> <span class="keywordflow">for</span> (<a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> i = 0; i &lt; 100000; i++) {</div>
<div class="line"><span class="lineno"> 65</span> <a class="code hl_typedef" href="../../dd/d47/namespacemath.html#a937dc0c826acf3e6c0d2785527f7e9d7">math::Point</a> p;</div>
<div class="line"><span class="lineno"> 66</span> p.x = <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">double</span><span class="keyword">&gt;</span>(RAND_MAX); <span class="comment">// 0 &lt;= x &lt;= 1</span></div>
<div class="line"><span class="lineno"> 67</span> p.y = <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">double</span><span class="keyword">&gt;</span>(RAND_MAX); <span class="comment">// 0 &lt;= y &lt;= 1</span></div>
<div class="line"><span class="lineno"> 65</span> <a class="code hl_typedef" href="../../dd/d47/namespacemath.html#a006c8ebd11bb1e035815dc835a1a7a85">math::Point</a> p;</div>
<div class="line"><span class="lineno"> 66</span> p.x = rand() / <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(RAND_MAX); <span class="comment">// 0 &lt;= x &lt;= 1</span></div>
<div class="line"><span class="lineno"> 67</span> p.y = rand() / <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(RAND_MAX); <span class="comment">// 0 &lt;= y &lt;= 1</span></div>
<div class="line"><span class="lineno"> 68</span> rands.<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">push_back</a>(p);</div>
<div class="line"><span class="lineno"> 69</span> }</div>
<div class="line"><span class="lineno"> 70</span> assert(<a class="code hl_function" href="../../dd/d47/namespacemath.html#abf7f2a6d91f1ca6c89698792aea3f188">math::approximate_pi</a>(rands) &gt; 3.135);</div>
@@ -225,10 +218,9 @@ Here is the call graph for this function:</div>
<div class="line"><span class="lineno"> 74</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_a937dc0c826acf3e6c0d2785527f7e9d7"><div class="ttname"><a href="../../dd/d47/namespacemath.html#a937dc0c826acf3e6c0d2785527f7e9d7">math::Point</a></div><div class="ttdeci">{ double x Point</div><div class="ttdoc">structure of points containing two numbers, x and y, such that 0 ≤ x ≤ 1 and 0 ≤ y ≤ 1.</div><div class="ttdef"><b>Definition</b> approximate_pi.cpp:36</div></div>
<div class="ttc" id="anamespacemath_html_a006c8ebd11bb1e035815dc835a1a7a85"><div class="ttname"><a href="../../dd/d47/namespacemath.html#a006c8ebd11bb1e035815dc835a1a7a85">math::Point</a></div><div class="ttdeci">struct { double x; double y;} Point</div><div class="ttdoc">structure of points containing two numbers, x and y, such that 0 ≤ x ≤ 1 and 0 ≤ y ≤ 1.</div><div class="ttdef"><b>Definition</b> approximate_pi.cpp:35</div></div>
<div class="ttc" id="anamespacemath_html_abf7f2a6d91f1ca6c89698792aea3f188"><div class="ttname"><a href="../../dd/d47/namespacemath.html#abf7f2a6d91f1ca6c89698792aea3f188">math::approximate_pi</a></div><div class="ttdeci">double approximate_pi(const std::vector&lt; Point &gt; &amp;pts)</div><div class="ttdoc">This function uses the points in a given vector 'pts' (drawn at random) to return an approximation of...</div><div class="ttdef"><b>Definition</b> approximate_pi.cpp:47</div></div>
<div class="ttc" id="apush_back_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">std::vector::push_back</a></div><div class="ttdeci">T push_back(T... args)</div></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 class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></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">
@@ -245,7 +237,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_296d53ceaeaa7e099814a6def439fe8a.html">math</a></li><li class="navelem"><a class="el" href="../../d0/d51/approximate__pi_8cpp.html">approximate_pi.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.8 </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.10.0 </li>
</ul>
</div>
</body>