Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
class_c_s_d462_1_1_complex.html 17.1 KB
Newer Older
Nick Sharp's avatar
Initial commit  
Nick Sharp committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>CSD462 Library Documentation: CSD462::Complex Class 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>
<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/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">CSD462 Library Documentation
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">15-462/15-662: Computer Graphics (Fall 2015)</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>CSD462</b></li><li class="navelem"><a class="el" href="class_c_s_d462_1_1_complex.html">Complex</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_c_s_d462_1_1_complex-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CSD462::Complex Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents complex numbers as 2D vectors of their real and imaginary components.  
 <a href="class_c_s_d462_1_1_complex.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="complex_8h_source.html">complex.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CSD462::Complex:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_c_s_d462_1_1_complex__inherit__graph.svg" width="132" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for CSD462::Complex:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_c_s_d462_1_1_complex__coll__graph.svg" width="132" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a500777c75c16d0c8273ca8540a798bd9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_complex.html#a500777c75c16d0c8273ca8540a798bd9">Complex</a> ()</td></tr>
<tr class="memdesc:a500777c75c16d0c8273ca8540a798bd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a500777c75c16d0c8273ca8540a798bd9">More...</a><br /></td></tr>
<tr class="separator:a500777c75c16d0c8273ca8540a798bd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c134f802573d7e7df08e5b74eec9c3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_complex.html#a0c134f802573d7e7df08e5b74eec9c3e">Complex</a> (double a, double b)</td></tr>
<tr class="memdesc:a0c134f802573d7e7df08e5b74eec9c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a0c134f802573d7e7df08e5b74eec9c3e">More...</a><br /></td></tr>
<tr class="separator:a0c134f802573d7e7df08e5b74eec9c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbd3fc2eee93af72b850c49c29cfdb20"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_complex.html#acbd3fc2eee93af72b850c49c29cfdb20">Complex</a> (const <a class="el" href="class_c_s_d462_1_1_vector2_d.html">Vector2D</a> &amp;v)</td></tr>
<tr class="memdesc:acbd3fc2eee93af72b850c49c29cfdb20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#acbd3fc2eee93af72b850c49c29cfdb20">More...</a><br /></td></tr>
<tr class="separator:acbd3fc2eee93af72b850c49c29cfdb20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36485d90294f9a05cc8c203a839e62d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36485d90294f9a05cc8c203a839e62d7"></a>
<a class="el" href="class_c_s_d462_1_1_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_complex.html#a36485d90294f9a05cc8c203a839e62d7">conj</a> () const </td></tr>
<tr class="memdesc:a36485d90294f9a05cc8c203a839e62d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the complex conjugate. <br /></td></tr>
<tr class="separator:a36485d90294f9a05cc8c203a839e62d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1596176880e4581e9ee61547ed23e2e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1596176880e4581e9ee61547ed23e2e9"></a>
<a class="el" href="class_c_s_d462_1_1_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_complex.html#a1596176880e4581e9ee61547ed23e2e9">inv</a> () const </td></tr>
<tr class="memdesc:a1596176880e4581e9ee61547ed23e2e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the inverse. <br /></td></tr>
<tr class="separator:a1596176880e4581e9ee61547ed23e2e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e254149e827b8b6b5ed3e0662adcb02"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e254149e827b8b6b5ed3e0662adcb02"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_complex.html#a3e254149e827b8b6b5ed3e0662adcb02">arg</a> () const </td></tr>
<tr class="memdesc:a3e254149e827b8b6b5ed3e0662adcb02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return argument. <br /></td></tr>
<tr class="separator:a3e254149e827b8b6b5ed3e0662adcb02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ab4333d86d08f2626167f42244e0d60"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ab4333d86d08f2626167f42244e0d60"></a>
<a class="el" href="class_c_s_d462_1_1_complex.html">Complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_complex.html#a1ab4333d86d08f2626167f42244e0d60">exponential</a> () const </td></tr>
<tr class="memdesc:a1ab4333d86d08f2626167f42244e0d60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Complex exponentiation. <br /></td></tr>
<tr class="separator:a1ab4333d86d08f2626167f42244e0d60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_c_s_d462_1_1_vector2_d"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_c_s_d462_1_1_vector2_d')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_c_s_d462_1_1_vector2_d.html">CSD462::Vector2D</a></td></tr>
<tr class="memitem:a5239bf457201dec41ac89bc1b2263324 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_vector2_d.html#a5239bf457201dec41ac89bc1b2263324">Vector2D</a> ()</td></tr>
<tr class="memdesc:a5239bf457201dec41ac89bc1b2263324 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a5239bf457201dec41ac89bc1b2263324">More...</a><br /></td></tr>
<tr class="separator:a5239bf457201dec41ac89bc1b2263324 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36a0fd51d372a0819fdae898624a5bd3 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_vector2_d.html#a36a0fd51d372a0819fdae898624a5bd3">Vector2D</a> (double x, double y)</td></tr>
<tr class="memdesc:a36a0fd51d372a0819fdae898624a5bd3 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a36a0fd51d372a0819fdae898624a5bd3">More...</a><br /></td></tr>
<tr class="separator:a36a0fd51d372a0819fdae898624a5bd3 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53188ccc3f195d9fbf9eb6c38ddb6fbf inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_vector2_d.html#a53188ccc3f195d9fbf9eb6c38ddb6fbf">Vector2D</a> (const <a class="el" href="class_c_s_d462_1_1_vector2_d.html">Vector2D</a> &amp;v)</td></tr>
<tr class="memdesc:a53188ccc3f195d9fbf9eb6c38ddb6fbf inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a53188ccc3f195d9fbf9eb6c38ddb6fbf">More...</a><br /></td></tr>
<tr class="separator:a53188ccc3f195d9fbf9eb6c38ddb6fbf inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c771dc6437494bc37bec2c3b478f732 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c771dc6437494bc37bec2c3b478f732"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_vector2_d.html#a3c771dc6437494bc37bec2c3b478f732">norm</a> (void) const </td></tr>
<tr class="memdesc:a3c771dc6437494bc37bec2c3b478f732 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns norm. <br /></td></tr>
<tr class="separator:a3c771dc6437494bc37bec2c3b478f732 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6af10e10ed74f8aed2b0e266e19eacff inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6af10e10ed74f8aed2b0e266e19eacff"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_vector2_d.html#a6af10e10ed74f8aed2b0e266e19eacff">norm2</a> (void) const </td></tr>
<tr class="memdesc:a6af10e10ed74f8aed2b0e266e19eacff inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns norm squared. <br /></td></tr>
<tr class="separator:a6af10e10ed74f8aed2b0e266e19eacff inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41b1176b7afd62ce4c29805b8e8de134 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41b1176b7afd62ce4c29805b8e8de134"></a>
<a class="el" href="class_c_s_d462_1_1_vector2_d.html">Vector2D</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_vector2_d.html#a41b1176b7afd62ce4c29805b8e8de134">unit</a> (void) const </td></tr>
<tr class="memdesc:a41b1176b7afd62ce4c29805b8e8de134 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns unit vector parallel to this one. <br /></td></tr>
<tr class="separator:a41b1176b7afd62ce4c29805b8e8de134 inherit pub_methods_class_c_s_d462_1_1_vector2_d"><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>Represents complex numbers as 2D vectors of their real and imaginary components. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a500777c75c16d0c8273ca8540a798bd9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Complex::Complex </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Initializes to 0. </p>

</div>
</div>
<a class="anchor" id="a0c134f802573d7e7df08e5b74eec9c3e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Complex::Complex </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>b</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Initializes to a+bi. </p>

</div>
</div>
<a class="anchor" id="acbd3fc2eee93af72b850c49c29cfdb20"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Complex::Complex </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_c_s_d462_1_1_vector2_d.html">Vector2D</a> &amp;&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Initializes to a+bi from vector v = (a,b) </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>lib/<a class="el" href="complex_8h_source.html">complex.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 1 2015 14:30:00 for CSD462 Library Documentation by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>