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/newton_raphson_method.cpp File Reference</title>
<title>TheAlgorithms/C++: numerical_methods/newton_raphson_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>
@@ -123,7 +140,9 @@ Include dependency graph for newton_raphson_method.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/d38/newton__raphson__method_8cpp__incl.svg" width="402" 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="../../de/dd3/newton__raphson__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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2003b5b2dcfff0769b957ab5c968b03d" id="r_a2003b5b2dcfff0769b957ab5c968b03d"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2003b5b2dcfff0769b957ab5c968b03d">eq</a> (double i)</td></tr>
@@ -135,13 +154,11 @@ Functions</h2></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:a75f355966e0a97665eaf5a4c79baa7af" id="r_a75f355966e0a97665eaf5a4c79baa7af"><td class="memItemLeft" align="right" valign="top"><a id="a75f355966e0a97665eaf5a4c79baa7af" name="a75f355966e0a97665eaf5a4c79baa7af"></a>
constexpr double&#160;</td><td class="memItemRight" valign="bottom"><b>EPSILON</b> = 1e-10</td></tr>
<tr class="memdesc:a75f355966e0a97665eaf5a4c79baa7af"><td class="mdescLeft">&#160;</td><td class="mdescRight">system accuracy limit <br /></td></tr>
<tr class="memitem:a75f355966e0a97665eaf5a4c79baa7af" id="r_a75f355966e0a97665eaf5a4c79baa7af"><td class="memItemLeft" align="right" valign="top">constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75f355966e0a97665eaf5a4c79baa7af">EPSILON</a> = 1e-10</td></tr>
<tr class="memdesc:a75f355966e0a97665eaf5a4c79baa7af"><td class="mdescLeft">&#160;</td><td class="mdescRight">system accuracy limit <br /></td></tr>
<tr class="separator:a75f355966e0a97665eaf5a4c79baa7af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5ff05b9f37ae59dad67e1d4f6cd51d" id="r_a5c5ff05b9f37ae59dad67e1d4f6cd51d"><td class="memItemLeft" align="right" valign="top"><a id="a5c5ff05b9f37ae59dad67e1d4f6cd51d" name="a5c5ff05b9f37ae59dad67e1d4f6cd51d"></a>
constexpr int16_t&#160;</td><td class="memItemRight" valign="bottom"><b>MAX_ITERATIONS</b> = INT16_MAX</td></tr>
<tr class="memdesc:a5c5ff05b9f37ae59dad67e1d4f6cd51d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of iterations. <br /></td></tr>
<tr class="memitem:a5c5ff05b9f37ae59dad67e1d4f6cd51d" id="r_a5c5ff05b9f37ae59dad67e1d4f6cd51d"><td class="memItemLeft" align="right" valign="top">constexpr int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c5ff05b9f37ae59dad67e1d4f6cd51d">MAX_ITERATIONS</a> = INT16_MAX</td></tr>
<tr class="memdesc:a5c5ff05b9f37ae59dad67e1d4f6cd51d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of iterations. <br /></td></tr>
<tr class="separator:a5c5ff05b9f37ae59dad67e1d4f6cd51d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -153,6 +170,8 @@ x_{i+1} = x_i - \frac{f(x_i)}{f&#39;(x_i)}
</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/kvedala" target="_blank">Krishna Vedala</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="../../d7/d6a/bisection__method_8cpp.html" title="Solve the equation using bisection method">bisection_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> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html">newton_raphson_method.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a2003b5b2dcfff0769b957ab5c968b03d" name="a2003b5b2dcfff0769b957ab5c968b03d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2003b5b2dcfff0769b957ab5c968b03d">&#9670;&#160;</a></span>eq()</h2>
@@ -181,16 +200,12 @@ x_{i+1} = x_i - \frac{f(x_i)}{f&#39;(x_i)}
f(x) = x^3 - 4x - 9
\]
</p>
<div class="fragment"><div class="line"><span class="lineno"> 30</span> {</div>
<div class="line"><span class="lineno"> 31</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>
<p class="definition">Definition at line <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html#l00030">30</a> of file <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html">newton_raphson_method.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 30</span> {</div>
<div class="line"><span class="lineno"> 31</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"> 32</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="../../de/dd3/newton__raphson__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>
</div><!-- fragment -->
</div>
</div>
<a id="a3d3f7f41977394680af6ebbed96f3386" name="a3d3f7f41977394680af6ebbed96f3386"></a>
@@ -220,15 +235,12 @@ Here is the call graph for this function:</div>
f&#39;(x) = 3x^2 - 4
\]
</p>
<div class="fragment"><div class="line"><span class="lineno"> 40</span> {</div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> ((3 * <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/pow.html">std::pow</a>(i, 2)) - 4); <span class="comment">// derivative of equation</span></div>
<p class="definition">Definition at line <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html#l00040">40</a> of file <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html">newton_raphson_method.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 40</span> {</div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> ((3 * std::pow(i, 2)) - 4); <span class="comment">// derivative of equation</span></div>
<div class="line"><span class="lineno"> 42</span>}</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/dd3/newton__raphson__method_8cpp_a3d3f7f41977394680af6ebbed96f3386_cgraph.svg" width="191" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><!-- fragment -->
</div>
</div>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
@@ -246,13 +258,15 @@ 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="../../de/dd3/newton__raphson__method_8cpp_source.html#l00045">45</a> of file <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html">newton_raphson_method.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 45</span> {</div>
<div class="line"><span class="lineno"> 46</span> <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/random/srand.html">std::srand</a>(<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/chrono/c/time.html">std::time</a>(<span class="keyword">nullptr</span>)); <span class="comment">// initialize randomizer</span></div>
<div class="line"><span class="lineno"> 46</span> std::srand(std::time(<span class="keyword">nullptr</span>)); <span class="comment">// initialize randomizer</span></div>
<div class="line"><span class="lineno"> 47</span> </div>
<div class="line"><span class="lineno"> 48</span> <span class="keywordtype">double</span> z = NAN, c = <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/random/rand.html">std::rand</a>() % 100, m = NAN, n = NAN;</div>
<div class="line"><span class="lineno"> 48</span> <span class="keywordtype">double</span> z = NAN, c = std::rand() % 100, m = NAN, n = NAN;</div>
<div class="line"><span class="lineno"> 49</span> <span class="keywordtype">int</span> i = 0;</div>
<div class="line"><span class="lineno"> 50</span> </div>
<div class="line"><span class="lineno"> 51</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;\nInitial approximation: &quot;</span> &lt;&lt; c;</div>
<div class="line"><span class="lineno"> 51</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\nInitial approximation: &quot;</span> &lt;&lt; c;</div>
<div class="line"><span class="lineno"> 52</span> </div>
<div class="line"><span class="lineno"> 53</span> <span class="comment">// start iterations</span></div>
<div class="line"><span class="lineno"> 54</span> <span class="keywordflow">for</span> (i = 0; i &lt; <a class="code hl_variable" href="#a5c5ff05b9f37ae59dad67e1d4f6cd51d">MAX_ITERATIONS</a>; i++) {</div>
@@ -267,23 +281,66 @@ Here is the call graph for this function:</div>
<div class="line"><span class="lineno"> 63</span> }</div>
<div class="line"><span class="lineno"> 64</span> }</div>
<div class="line"><span class="lineno"> 65</span> </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> &lt;&lt; <span class="stringliteral">&quot;\n\nRoot: &quot;</span> &lt;&lt; z &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"> 66</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\n\nRoot: &quot;</span> &lt;&lt; z &lt;&lt; <span class="stringliteral">&quot;\t\tSteps: &quot;</span> &lt;&lt; i &lt;&lt; std::endl;</div>
<div class="line"><span class="lineno"> 67</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 68</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="anewton__raphson__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> newton_raphson_method.cpp:30</div></div>
<div class="ttc" id="anewton__raphson__method_8cpp_html_a3d3f7f41977394680af6ebbed96f3386"><div class="ttname"><a href="#a3d3f7f41977394680af6ebbed96f3386">eq_der</a></div><div class="ttdeci">static double eq_der(double i)</div><div class="ttdef"><b>Definition</b> newton_raphson_method.cpp:40</div></div>
<div class="ttc" id="anewton__raphson__method_8cpp_html_a5c5ff05b9f37ae59dad67e1d4f6cd51d"><div class="ttname"><a href="#a5c5ff05b9f37ae59dad67e1d4f6cd51d">MAX_ITERATIONS</a></div><div class="ttdeci">constexpr int16_t MAX_ITERATIONS</div><div class="ttdoc">Maximum number of iterations.</div><div class="ttdef"><b>Definition</b> newton_raphson_method.cpp:22</div></div>
<div class="ttc" id="anewton__raphson__method_8cpp_html_a75f355966e0a97665eaf5a4c79baa7af"><div class="ttname"><a href="#a75f355966e0a97665eaf5a4c79baa7af">EPSILON</a></div><div class="ttdeci">constexpr double EPSILON</div><div class="ttdoc">system accuracy limit</div><div class="ttdef"><b>Definition</b> newton_raphson_method.cpp:21</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="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"><iframe scrolling="no" frameborder="0" src="../../de/dd3/newton__raphson__method_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="307" height="283"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="ttc" id="anewton__raphson__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="../../de/dd3/newton__raphson__method_8cpp_source.html#l00030">newton_raphson_method.cpp:30</a></div></div>
<div class="ttc" id="anewton__raphson__method_8cpp_html_a3d3f7f41977394680af6ebbed96f3386"><div class="ttname"><a href="#a3d3f7f41977394680af6ebbed96f3386">eq_der</a></div><div class="ttdeci">static double eq_der(double i)</div><div class="ttdef"><b>Definition</b> <a href="../../de/dd3/newton__raphson__method_8cpp_source.html#l00040">newton_raphson_method.cpp:40</a></div></div>
<div class="ttc" id="anewton__raphson__method_8cpp_html_a5c5ff05b9f37ae59dad67e1d4f6cd51d"><div class="ttname"><a href="#a5c5ff05b9f37ae59dad67e1d4f6cd51d">MAX_ITERATIONS</a></div><div class="ttdeci">constexpr int16_t MAX_ITERATIONS</div><div class="ttdoc">Maximum number of iterations.</div><div class="ttdef"><b>Definition</b> <a href="../../de/dd3/newton__raphson__method_8cpp_source.html#l00022">newton_raphson_method.cpp:22</a></div></div>
<div class="ttc" id="anewton__raphson__method_8cpp_html_a75f355966e0a97665eaf5a4c79baa7af"><div class="ttname"><a href="#a75f355966e0a97665eaf5a4c79baa7af">EPSILON</a></div><div class="ttdeci">constexpr double EPSILON</div><div class="ttdoc">system accuracy limit</div><div class="ttdef"><b>Definition</b> <a href="../../de/dd3/newton__raphson__method_8cpp_source.html#l00021">newton_raphson_method.cpp:21</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a75f355966e0a97665eaf5a4c79baa7af" name="a75f355966e0a97665eaf5a4c79baa7af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75f355966e0a97665eaf5a4c79baa7af">&#9670;&#160;</a></span>EPSILON</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double EPSILON = 1e-10</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>system accuracy limit </p>
<p class="definition">Definition at line <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html#l00021">21</a> of file <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html">newton_raphson_method.cpp</a>.</p>
</div>
</div>
<a id="a5c5ff05b9f37ae59dad67e1d4f6cd51d" name="a5c5ff05b9f37ae59dad67e1d4f6cd51d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c5ff05b9f37ae59dad67e1d4f6cd51d">&#9670;&#160;</a></span>MAX_ITERATIONS</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int16_t MAX_ITERATIONS = INT16_MAX</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of iterations. </p>
<p class="definition">Definition at line <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html#l00022">22</a> of file <a class="el" href="../../de/dd3/newton__raphson__method_8cpp_source.html">newton_raphson_method.cpp</a>.</p>
</div>
</div>