Documentation for 6376bf46af

This commit is contained in:
github-actions
2023-09-27 18:42:32 +00:00
parent d28eba1fef
commit b5b4d78981
5708 changed files with 52275 additions and 51112 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.7"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: Complex Class 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.7 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
@@ -110,49 +110,49 @@ $(document).ready(function(){initNavTree('da/d5a/class_complex.html','../../');
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3cfc522c782726f49ee20af17b77f867"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a3cfc522c782726f49ee20af17b77f867">Complex</a> (double x=0.f, double y=0.f, bool is_polar=false)</td></tr>
<tr class="memitem:a3cfc522c782726f49ee20af17b77f867" id="r_a3cfc522c782726f49ee20af17b77f867"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a3cfc522c782726f49ee20af17b77f867">Complex</a> (double x=0.f, double y=0.f, bool is_polar=false)</td></tr>
<tr class="memdesc:a3cfc522c782726f49ee20af17b77f867"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> Constructor which initialises our complex number. <br /></td></tr>
<tr class="separator:a3cfc522c782726f49ee20af17b77f867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a466cd7b664cc6a864937ceb3dead1323"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a466cd7b664cc6a864937ceb3dead1323">Complex</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memitem:a466cd7b664cc6a864937ceb3dead1323" id="r_a466cd7b664cc6a864937ceb3dead1323"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a466cd7b664cc6a864937ceb3dead1323">Complex</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memdesc:a466cd7b664cc6a864937ceb3dead1323"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy Constructor. <br /></td></tr>
<tr class="separator:a466cd7b664cc6a864937ceb3dead1323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a312e4b19146128408fb06e0150b0faf6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a312e4b19146128408fb06e0150b0faf6">real</a> () const</td></tr>
<tr class="memitem:a312e4b19146128408fb06e0150b0faf6" id="r_a312e4b19146128408fb06e0150b0faf6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a312e4b19146128408fb06e0150b0faf6">real</a> () const</td></tr>
<tr class="memdesc:a312e4b19146128408fb06e0150b0faf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Member function to get real value of our complex number. Member function (getter) to access the class' re value. <br /></td></tr>
<tr class="separator:a312e4b19146128408fb06e0150b0faf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8aacf982e2e6c142921bc850f6dc974"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#af8aacf982e2e6c142921bc850f6dc974">imag</a> () const</td></tr>
<tr class="memitem:af8aacf982e2e6c142921bc850f6dc974" id="r_af8aacf982e2e6c142921bc850f6dc974"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#af8aacf982e2e6c142921bc850f6dc974">imag</a> () const</td></tr>
<tr class="memdesc:af8aacf982e2e6c142921bc850f6dc974"><td class="mdescLeft">&#160;</td><td class="mdescRight">Member function to get imaginary value of our complex number. Member function (getter) to access the class' im value. <br /></td></tr>
<tr class="separator:af8aacf982e2e6c142921bc850f6dc974"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5b51b749ea4964104b9527af9d8f556"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#ae5b51b749ea4964104b9527af9d8f556">abs</a> () const</td></tr>
<tr class="memitem:ae5b51b749ea4964104b9527af9d8f556" id="r_ae5b51b749ea4964104b9527af9d8f556"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#ae5b51b749ea4964104b9527af9d8f556">abs</a> () const</td></tr>
<tr class="memdesc:ae5b51b749ea4964104b9527af9d8f556"><td class="mdescLeft">&#160;</td><td class="mdescRight">Member function to give the modulus of our complex number. Member function to which gives the absolute value (modulus) of our complex number. <br /></td></tr>
<tr class="separator:ae5b51b749ea4964104b9527af9d8f556"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1e03712837450549e0c9b4017533a41"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#ae1e03712837450549e0c9b4017533a41">arg</a> () const</td></tr>
<tr class="memitem:ae1e03712837450549e0c9b4017533a41" id="r_ae1e03712837450549e0c9b4017533a41"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#ae1e03712837450549e0c9b4017533a41">arg</a> () const</td></tr>
<tr class="memdesc:ae1e03712837450549e0c9b4017533a41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Member function to give the argument of our complex number. <br /></td></tr>
<tr class="separator:ae1e03712837450549e0c9b4017533a41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a820afcbb330df716577459d7a3aa3a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a820afcbb330df716577459d7a3aa3a1c">operator+</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memitem:a820afcbb330df716577459d7a3aa3a1c" id="r_a820afcbb330df716577459d7a3aa3a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a820afcbb330df716577459d7a3aa3a1c">operator+</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memdesc:a820afcbb330df716577459d7a3aa3a1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator overload of '+' on <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> class. Operator overload to be able to add two complex numbers. <br /></td></tr>
<tr class="separator:a820afcbb330df716577459d7a3aa3a1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36739619a07b5478bcd8a28ad2f8b7da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a36739619a07b5478bcd8a28ad2f8b7da">operator-</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memitem:a36739619a07b5478bcd8a28ad2f8b7da" id="r_a36739619a07b5478bcd8a28ad2f8b7da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a36739619a07b5478bcd8a28ad2f8b7da">operator-</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memdesc:a36739619a07b5478bcd8a28ad2f8b7da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator overload of '-' on <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> class. Operator overload to be able to subtract two complex numbers. <br /></td></tr>
<tr class="separator:a36739619a07b5478bcd8a28ad2f8b7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9b4a7d6083ca7040ddd4fe93db5c19d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#aa9b4a7d6083ca7040ddd4fe93db5c19d">operator*</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memitem:aa9b4a7d6083ca7040ddd4fe93db5c19d" id="r_aa9b4a7d6083ca7040ddd4fe93db5c19d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#aa9b4a7d6083ca7040ddd4fe93db5c19d">operator*</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memdesc:aa9b4a7d6083ca7040ddd4fe93db5c19d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator overload of '*' on <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> class. Operator overload to be able to multiple two complex numbers. <br /></td></tr>
<tr class="separator:aa9b4a7d6083ca7040ddd4fe93db5c19d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d5427f6c42c15283031d73e1418c59d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a8d5427f6c42c15283031d73e1418c59d">operator~</a> () const</td></tr>
<tr class="memitem:a8d5427f6c42c15283031d73e1418c59d" id="r_a8d5427f6c42c15283031d73e1418c59d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a8d5427f6c42c15283031d73e1418c59d">operator~</a> () const</td></tr>
<tr class="memdesc:a8d5427f6c42c15283031d73e1418c59d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator overload of '~' on <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> class. Operator overload of the BITWISE NOT which gives us the conjugate of our complex number. NOTE: This is overloading the BITWISE operator but its not a BITWISE operation in this definition. <br /></td></tr>
<tr class="separator:a8d5427f6c42c15283031d73e1418c59d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac38437c10eb798f176c384a695171b90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#ac38437c10eb798f176c384a695171b90">operator/</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memitem:ac38437c10eb798f176c384a695171b90" id="r_ac38437c10eb798f176c384a695171b90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d5a/class_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#ac38437c10eb798f176c384a695171b90">operator/</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memdesc:ac38437c10eb798f176c384a695171b90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator overload of '/' on <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> class. Operator overload to be able to divide two complex numbers. This function would throw an exception if the other number is zero. <br /></td></tr>
<tr class="separator:ac38437c10eb798f176c384a695171b90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ac9f529d54cacf2969f2c7179b4c4ac"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a4ac9f529d54cacf2969f2c7179b4c4ac">operator=</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memitem:a4ac9f529d54cacf2969f2c7179b4c4ac" id="r_a4ac9f529d54cacf2969f2c7179b4c4ac"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5a/class_complex.html#a4ac9f529d54cacf2969f2c7179b4c4ac">operator=</a> (const <a class="el" href="../../da/d5a/class_complex.html">Complex</a> &amp;other)</td></tr>
<tr class="memdesc:a4ac9f529d54cacf2969f2c7179b4c4ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator overload of '=' on <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> class. Operator overload to be able to copy RHS instance of <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> to LHS instance of <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a>. <br /></td></tr>
<tr class="separator:a4ac9f529d54cacf2969f2c7179b4c4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a843ce2f85af4c57db9063c86f3cd9607"><td class="memItemLeft" align="right" valign="top"><a id="a843ce2f85af4c57db9063c86f3cd9607" name="a843ce2f85af4c57db9063c86f3cd9607"></a>
<tr class="memitem:a843ce2f85af4c57db9063c86f3cd9607" id="r_a843ce2f85af4c57db9063c86f3cd9607"><td class="memItemLeft" align="right" valign="top"><a id="a843ce2f85af4c57db9063c86f3cd9607" name="a843ce2f85af4c57db9063c86f3cd9607"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>re</b></td></tr>
<tr class="separator:a843ce2f85af4c57db9063c86f3cd9607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a776d595d5a1b576e9136cbc6bac0589c"><td class="memItemLeft" align="right" valign="top"><a id="a776d595d5a1b576e9136cbc6bac0589c" name="a776d595d5a1b576e9136cbc6bac0589c"></a>
<tr class="memitem:a776d595d5a1b576e9136cbc6bac0589c" id="r_a776d595d5a1b576e9136cbc6bac0589c"><td class="memItemLeft" align="right" valign="top"><a id="a776d595d5a1b576e9136cbc6bac0589c" name="a776d595d5a1b576e9136cbc6bac0589c"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>im</b></td></tr>
<tr class="separator:a776d595d5a1b576e9136cbc6bac0589c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
@@ -646,7 +646,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="../../da/d5a/class_complex.html">Complex</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>
<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>
</ul>
</div>
</body>