Documentation for 8b1eab204b

This commit is contained in:
realstealthninja
2024-11-04 12:43:05 +00:00
parent 4fb6e622e9
commit a7bccf7d01
6732 changed files with 153919 additions and 365711 deletions

View File

@@ -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++: numerical_methods/bisection_method.cpp File Reference</title>
<title>TheAlgorithms/C++: numerical_methods/bisection_method.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">&#160;1.0.0</span>
<div id="projectname">TheAlgorithms/C++<span id="projectnumber">&#160;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,14 +138,15 @@ Include dependency graph for bisection_method.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d9/dd9/bisection__method_8cpp__incl.svg" width="239" 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">
</div>
<p><a href="../../d7/d6a/bisection__method_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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a002b2f4894492820fe708b1b7e7c5e70" id="r_a002b2f4894492820fe708b1b7e7c5e70"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a002b2f4894492820fe708b1b7e7c5e70">EPSILON</a>&#160;&#160;&#160; 1e-6</td></tr>
<tr class="separator:a002b2f4894492820fe708b1b7e7c5e70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a3abbca80bc98e7abcb3ae73abe0f14" id="r_a0a3abbca80bc98e7abcb3ae73abe0f14"><td class="memItemLeft" align="right" valign="top"><a id="a0a3abbca80bc98e7abcb3ae73abe0f14" name="a0a3abbca80bc98e7abcb3ae73abe0f14"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MAX_ITERATIONS</b>&#160;&#160;&#160;50000</td></tr>
<tr class="memdesc:a0a3abbca80bc98e7abcb3ae73abe0f14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of iterations to check. <br /></td></tr>
<tr class="memitem:a0a3abbca80bc98e7abcb3ae73abe0f14" id="r_a0a3abbca80bc98e7abcb3ae73abe0f14"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0a3abbca80bc98e7abcb3ae73abe0f14">MAX_ITERATIONS</a>&#160;&#160;&#160;50000</td></tr>
<tr class="memdesc:a0a3abbca80bc98e7abcb3ae73abe0f14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of iterations to check. <br /></td></tr>
<tr class="separator:a0a3abbca80bc98e7abcb3ae73abe0f14"><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>
@@ -150,6 +168,8 @@ x_{i+1} = \frac{a_i+b_i}{2}
</p>
<p> For the next iteration, the interval is selected as: \([a,x]\) if \(x&gt;0\) or \([x,b]\) if \(x&lt;0\). The Process is continued till a close enough approximation is achieved.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="../../de/dd3/newton__raphson__method_8cpp.html" title="Solve the equation using Newton-Raphson method for both real and complex solutions.">newton_raphson_method.cpp</a>, <a class="el" href="../../dd/d29/false__position_8cpp.html" title="Solve the equation using false position method, also known as the Secant method.">false_position.cpp</a>, secant_method.cpp </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html">bisection_method.cpp</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a002b2f4894492820fe708b1b7e7c5e70" name="a002b2f4894492820fe708b1b7e7c5e70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a002b2f4894492820fe708b1b7e7c5e70">&#9670;&#160;</a></span>EPSILON</h2>
@@ -162,9 +182,29 @@ x_{i+1} = \frac{a_i+b_i}{2}
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html#l00020">20</a> of file <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html">bisection_method.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 20</span><span class="preprocessor">#define EPSILON \</span></div>
<div class="line"><span class="lineno"> 21</span><span class="preprocessor"> 1e-6 </span><span class="comment">// std::numeric_limits&lt;double&gt;::epsilon() ///&lt; system accuracy limit</span></div>
</div><!-- fragment -->
</div>
</div>
<a id="a0a3abbca80bc98e7abcb3ae73abe0f14" name="a0a3abbca80bc98e7abcb3ae73abe0f14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a3abbca80bc98e7abcb3ae73abe0f14">&#9670;&#160;</a></span>MAX_ITERATIONS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_ITERATIONS&#160;&#160;&#160;50000</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of iterations to check. </p>
<p class="definition">Definition at line <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html#l00022">22</a> of file <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html">bisection_method.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
@@ -191,16 +231,12 @@ x_{i+1} = \frac{a_i+b_i}{2}
</table>
</div><div class="memdoc">
<p>define \(f(x)\) to find root for </p>
<div class="fragment"><div class="line"><span class="lineno"> 26</span> {</div>
<div class="line"><span class="lineno"> 27</span> <span class="keywordflow">return</span> (<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/pow.html">std::pow</a>(i, 3) - (4 * i) - 9); <span class="comment">// original equation</span></div>
<div class="line"><span class="lineno"> 28</span>}</div>
<div class="ttc" id="apow_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/math/pow.html">std::pow</a></div><div class="ttdeci">T pow(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="../../d7/d6a/bisection__method_8cpp_a2003b5b2dcfff0769b957ab5c968b03d_cgraph.svg" width="168" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<p class="definition">Definition at line <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html#l00026">26</a> of file <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html">bisection_method.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 26</span> {</div>
<div class="line"><span class="lineno"> 27</span> <span class="keywordflow">return</span> (std::pow(i, 3) - (4 * i) - 9); <span class="comment">// original equation</span></div>
<div class="line"><span class="lineno"> 28</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
@@ -218,6 +254,8 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>main function </p>
<p class="definition">Definition at line <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html#l00037">37</a> of file <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html">bisection_method.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 37</span> {</div>
<div class="line"><span class="lineno"> 38</span> <span class="keywordtype">double</span> a = -1, b = 1, x, z;</div>
<div class="line"><span class="lineno"> 39</span> <span class="keywordtype">int</span> i;</div>
@@ -234,14 +272,14 @@ Here is the call graph for this function:</div>
<div class="line"><span class="lineno"> 50</span> }</div>
<div class="line"><span class="lineno"> 51</span> }</div>
<div class="line"><span class="lineno"> 52</span> </div>
<div class="line"><span class="lineno"> 53</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;\nFirst initial: &quot;</span> &lt;&lt; a;</div>
<div class="line"><span class="lineno"> 54</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;\nSecond initial: &quot;</span> &lt;&lt; b;</div>
<div class="line"><span class="lineno"> 53</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\nFirst initial: &quot;</span> &lt;&lt; a;</div>
<div class="line"><span class="lineno"> 54</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\nSecond initial: &quot;</span> &lt;&lt; b;</div>
<div class="line"><span class="lineno"> 55</span> </div>
<div class="line"><span class="lineno"> 56</span> <span class="comment">// start iterations</span></div>
<div class="line"><span class="lineno"> 57</span> <span class="keywordflow">for</span> (i = 0; i &lt; <a class="code hl_define" href="#a0a3abbca80bc98e7abcb3ae73abe0f14">MAX_ITERATIONS</a>; i++) {</div>
<div class="line"><span class="lineno"> 58</span> x = (a + b) / 2;</div>
<div class="line"><span class="lineno"> 59</span> z = <a class="code hl_function" href="#a2003b5b2dcfff0769b957ab5c968b03d">eq</a>(x);</div>
<div class="line"><span class="lineno"> 60</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;\n\nz: &quot;</span> &lt;&lt; z &lt;&lt; <span class="stringliteral">&quot;\t[&quot;</span> &lt;&lt; a &lt;&lt; <span class="stringliteral">&quot; , &quot;</span> &lt;&lt; b</div>
<div class="line"><span class="lineno"> 60</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\n\nz: &quot;</span> &lt;&lt; z &lt;&lt; <span class="stringliteral">&quot;\t[&quot;</span> &lt;&lt; a &lt;&lt; <span class="stringliteral">&quot; , &quot;</span> &lt;&lt; b</div>
<div class="line"><span class="lineno"> 61</span> &lt;&lt; <span class="stringliteral">&quot; | Bisect: &quot;</span> &lt;&lt; x &lt;&lt; <span class="stringliteral">&quot;]&quot;</span>;</div>
<div class="line"><span class="lineno"> 62</span> </div>
<div class="line"><span class="lineno"> 63</span> <span class="keywordflow">if</span> (z &lt; 0) {</div>
@@ -254,20 +292,13 @@ Here is the call graph for this function:</div>
<div class="line"><span class="lineno"> 70</span> <span class="keywordflow">break</span>;</div>
<div class="line"><span class="lineno"> 71</span> }</div>
<div class="line"><span class="lineno"> 72</span> </div>
<div class="line"><span class="lineno"> 73</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;\n\nRoot: &quot;</span> &lt;&lt; x &lt;&lt; <span class="stringliteral">&quot;\t\tSteps: &quot;</span> &lt;&lt; i &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"> 73</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\n\nRoot: &quot;</span> &lt;&lt; x &lt;&lt; <span class="stringliteral">&quot;\t\tSteps: &quot;</span> &lt;&lt; i &lt;&lt; std::endl;</div>
<div class="line"><span class="lineno"> 74</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 75</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="abisection__method_8cpp_html_a0a3abbca80bc98e7abcb3ae73abe0f14"><div class="ttname"><a href="#a0a3abbca80bc98e7abcb3ae73abe0f14">MAX_ITERATIONS</a></div><div class="ttdeci">#define MAX_ITERATIONS</div><div class="ttdoc">Maximum number of iterations to check.</div><div class="ttdef"><b>Definition</b> bisection_method.cpp:22</div></div>
<div class="ttc" id="abisection__method_8cpp_html_a1ab31b90bc584c635ec159468ceed9b2"><div class="ttname"><a href="#a1ab31b90bc584c635ec159468ceed9b2">sgn</a></div><div class="ttdeci">int sgn(T val)</div><div class="ttdef"><b>Definition</b> bisection_method.cpp:32</div></div>
<div class="ttc" id="abisection__method_8cpp_html_a2003b5b2dcfff0769b957ab5c968b03d"><div class="ttname"><a href="#a2003b5b2dcfff0769b957ab5c968b03d">eq</a></div><div class="ttdeci">static double eq(double i)</div><div class="ttdef"><b>Definition</b> bisection_method.cpp:26</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><!-- 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="../../d7/d6a/bisection__method_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="299" height="135"><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="abisection__method_8cpp_html_a0a3abbca80bc98e7abcb3ae73abe0f14"><div class="ttname"><a href="#a0a3abbca80bc98e7abcb3ae73abe0f14">MAX_ITERATIONS</a></div><div class="ttdeci">#define MAX_ITERATIONS</div><div class="ttdoc">Maximum number of iterations to check.</div><div class="ttdef"><b>Definition</b> <a href="../../d7/d6a/bisection__method_8cpp_source.html#l00022">bisection_method.cpp:22</a></div></div>
<div class="ttc" id="abisection__method_8cpp_html_a1ab31b90bc584c635ec159468ceed9b2"><div class="ttname"><a href="#a1ab31b90bc584c635ec159468ceed9b2">sgn</a></div><div class="ttdeci">int sgn(T val)</div><div class="ttdef"><b>Definition</b> <a href="../../d7/d6a/bisection__method_8cpp_source.html#l00032">bisection_method.cpp:32</a></div></div>
<div class="ttc" id="abisection__method_8cpp_html_a2003b5b2dcfff0769b957ab5c968b03d"><div class="ttname"><a href="#a2003b5b2dcfff0769b957ab5c968b03d">eq</a></div><div class="ttdeci">static double eq(double i)</div><div class="ttdef"><b>Definition</b> <a href="../../d7/d6a/bisection__method_8cpp_source.html#l00026">bisection_method.cpp:26</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a1ab31b90bc584c635ec159468ceed9b2" name="a1ab31b90bc584c635ec159468ceed9b2"></a>
@@ -287,6 +318,8 @@ template&lt;typename T &gt; </div>
</table>
</div><div class="memdoc">
<p>get the sign of any given number </p>
<p class="definition">Definition at line <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html#l00032">32</a> of file <a class="el" href="../../d7/d6a/bisection__method_8cpp_source.html">bisection_method.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 32</span> {</div>
<div class="line"><span class="lineno"> 33</span> <span class="keywordflow">return</span> (T(0) &lt; val) - (val &lt; T(0));</div>
<div class="line"><span class="lineno"> 34</span>}</div>