backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-24 22:02:20 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for f1eddf4d65

Browse Source
This commit is contained in:
realstealthninja
2025-07-09 10:53:16 +00:00
parent e7edde96ab
commit b41207008f
2497 changed files with 31270 additions and 40283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
da/d5a/class_complex.html
View File

@@ -4,7 +4,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.13.2"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: Complex Class Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
@@ -19,7 +19,6 @@
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.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>
@@ -60,26 +59,20 @@ window.MathJax = {
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.14.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
$(function() { codefold.init(); });
</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',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
@@ -94,10 +87,9 @@ $(function() {
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('da/d5a/class_complex.html','../../'); initResizable(true); });
/* @license-end */
$(function(){initNavTree('da/d5a/class_complex.html','../../','d6/d1f/class_complex-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -121,10 +113,6 @@ $(function(){initNavTree('da/d5a/class_complex.html','../../'); initResizable(tr
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="../../d6/d1f/class_complex-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Complex Class Reference</div></div>
</div><!--header-->
<div class="contents">
@@ -132,57 +120,43 @@ $(function(){initNavTree('da/d5a/class_complex.html','../../'); initResizable(tr
<p>Class <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> to represent complex numbers as a field.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></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="#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" id="r_a466cd7b664cc6a864937ceb3dead1323"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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" id="r_a312e4b19146128408fb06e0150b0faf6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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" id="r_af8aacf982e2e6c142921bc850f6dc974"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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" id="r_ae5b51b749ea4964104b9527af9d8f556"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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" id="r_ae1e03712837450549e0c9b4017533a41"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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" 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="#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" 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="#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" 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="#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" 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="#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" 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="#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" 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="#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>
<tr class="heading"><td colspan="2"><h2 id="header-pri-attribs" class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a843ce2f85af4c57db9063c86f3cd9607" id="r_a843ce2f85af4c57db9063c86f3cd9607"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a843ce2f85af4c57db9063c86f3cd9607">re</a></td></tr>
<tr class="separator:a843ce2f85af4c57db9063c86f3cd9607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a776d595d5a1b576e9136cbc6bac0589c" id="r_a776d595d5a1b576e9136cbc6bac0589c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a776d595d5a1b576e9136cbc6bac0589c">im</a></td></tr>
<tr class="separator:a776d595d5a1b576e9136cbc6bac0589c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class <a class="el" href="../../da/d5a/class_complex.html" title="Class Complex to represent complex numbers as a field.">Complex</a> to represent complex numbers as a field. </p>
<p class="definition">Definition at line <a class="el" href="../../d5/d67/complex__numbers_8cpp_source.html#l00020">20</a> of file <a class="el" href="../../d5/d67/complex__numbers_8cpp_source.html">complex_numbers.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3cfc522c782726f49ee20af17b77f867" name="a3cfc522c782726f49ee20af17b77f867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cfc522c782726f49ee20af17b77f867">&#9670;&#160;</a></span>Complex() <span class="overload">[1/2]</span></h2>
@@ -277,7 +251,7 @@ Private Attributes</h2></td></tr>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="ae5b51b749ea4964104b9527af9d8f556" name="ae5b51b749ea4964104b9527af9d8f556"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5b51b749ea4964104b9527af9d8f556">&#9670;&#160;</a></span>abs()</h2>
@@ -641,7 +615,7 @@ Private Attributes</h2></td></tr>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="a776d595d5a1b576e9136cbc6bac0589c" name="a776d595d5a1b576e9136cbc6bac0589c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a776d595d5a1b576e9136cbc6bac0589c">&#9670;&#160;</a></span>im</h2>
@@ -695,11 +669,19 @@ Private Attributes</h2></td></tr>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<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.13.2 </li>
<li class="navelem"><a 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.14.0 </li>
</ul>
</div>
</body>