Complex Class Reference

Complex class implements a set of data types, conversions, and operations for complex numbers. More...

#include <Complex.h>

List of all members.

Public Member Functions
	Complex ()
	Default constructor.
	Complex (Real i)
	Construct Complex from real part.
	Complex (Real r, Real i)
	Construct Complex from real and imaginary.
Real	r (Void)
	Get the real part of Complex number as a Real.
Real	i (Void)
	Get the imaginary part of the Complex number as a Real.
Void	r (Real r)
	Set the real part of Complex number.
Void	i (Real i)
	Set the imaginary part of Complex number.
Complex &	operator= (Const Real &x)
	Asignment operator for Complex = Real.
Bool	operator== (Const Complex &x) Const
	Equality operator for Complex == Complex.
Bool	operator!= (Const Complex &x) Const
	Inquality operator for Complex != Complex.
Bool	operator< (Const Complex &x) Const
	Less-than operator for Complex < Complex.
Bool	operator<= (Const Complex &x) Const
	Less-than or equal operator for Complex < Complex.
Bool	operator>= (Const Complex &x) Const
	Greater-than or equal operator for Complex < Complex.
Bool	operator> (Const Complex &x) Const
	Greater-than operator for Complex < Complex.
Complex	operator+ (Const Complex &c)
	Addition operator for Complex + Complex.
Complex	operator- (Const Complex &c)
	Subtraction operator for Complex - Complex.
Complex	operator- ()
	Negation operator for Complex.
Complex	operator~ ()
	Conjugation operator for Complex.
Complex	operator * (Const Complex &c)
	Multiplication operator for Complex * Complex.
Complex	operator * (Const Real &r)
	Multiplication operator for Complex * Real.
Complex	operator/ (Const Complex &c)
	Division operator for Complex / Complex.
Complex	operator/ (Const Real &r)
	Division operator for Complex / Real.
Complex &	operator+= (const Complex x)
	Increment operator for Complex += Complex.
Complex &	operator-= (const Complex x)
	Decrement operator for Complex -= Complex.
Complex &	operator *= (const Complex x)
	Multiply scale operator for Complex *= Complex.
Complex &	operator/= (const Complex x)
	Divide scale operator for Complex /= Complex.
Complex &	operator/= (const Real r)
	Divide scale operator for Complex /= Real.
Complex	Abs ()
	Complex absolute value.
Complex	Conjugate ()
	Complex conjugate.
Complex	Exp (Complex e)
	Complex exponentiation.
Void	print (String s=0)
	Print complex value, prepended by String s if not null.
Friends
ostream &	operator<< (ostream &os, const Complex &c)
	Print to output stream.
istream &	operator>> (istream &is, Complex &c)
	Read from input stream.

---

Detailed Description

Complex class implements a set of data types, conversions, and operations for complex numbers.

Definition at line 28 of file Complex.h.

---

Constructor & Destructor Documentation

Complex::Complex

(

)

[inline]

Default constructor.

Definition at line 55 of file Complex.h.

Referenced by operator *(), operator+(), operator-(), operator/(), and operator~().

                  : 
          m_r(0), 
          m_i(0) {
          }

Complex::Complex

(

Real

i

)

[inline]

Construct Complex from real part.

Parameters:

i

Initializer for both real and imaginary parts.

Definition at line 62 of file Complex.h.

                        : 
          m_r(i), 
          m_i(i) {
          }

Complex::Complex	(	Real	r,
		Real	i
	)			[inline]

Construct Complex from real and imaginary.

Parameters:

	r	Real part of complex number as a Real datatype
	i	Imaginary part of the complex number as a Real datatype

Definition at line 70 of file Complex.h.

                                : 
          m_r(r), 
          m_i(i) {
          }

---

Member Function Documentation

Complex Complex::Abs

(

)

[inline]

Complex absolute value.

Returns:

Absolute value.

Definition at line 209 of file Complex.h.

References Return.

Referenced by Abs().

                      {
                Complex t(m_r < 0.0 ? -m_r : m_r, m_i < 0.0 ? -m_i : m_i);
                Return(t);
        }

Complex Complex::Conjugate

(

)

[inline]

Complex conjugate.

Returns:

Conjugate value.

Definition at line 216 of file Complex.h.

References Return.

                            {
                Complex t(m_r, -m_i);
                Return(t);
        }

Complex Complex::Exp

(

Complex

e

)

[inline]

Complex exponentiation.

Definition at line 222 of file Complex.h.

References Cos(), i(), r(), Return, and Sin().

Referenced by Exp().

                               {
                Real r = e.r();
                r = exp(r);
                Real theta = e.i();
                Complex t(r * Cos(theta), r * Sin(theta));
                Return t;
        }

Void Complex::i

(

Real

i

)

[inline]

Set the imaginary part of Complex number.

See also:

i(Void)

Definition at line 93 of file Complex.h.

{ m_i = i; }

Real Complex::i

(

Void

)

[inline]

Get the imaginary part of the Complex number as a Real.

Returns:

The imaginary part of the complex number as a Real

Definition at line 83 of file Complex.h.

References Return.

Referenced by Exp(), ImagPart(), and operator/().

                     {
                Return m_i;
        }

Complex Complex::operator *

(

Const Real &

r

)

[inline]

Multiplication operator for Complex * Real.

Definition at line 161 of file Complex.h.

References Return.

                                        {
                Complex c(r, 0.0);
                Return *this * c;
        }

Complex Complex::operator *

(

Const Complex &

c

)

[inline]

Multiplication operator for Complex * Complex.

Definition at line 155 of file Complex.h.

References Complex(), and Return.

                                           {
                Return Complex(m_r * c.m_r - m_i * c.m_i,
                                           m_r * c.m_i + m_i * c.m_r);
        }

Complex& Complex::operator *=

(

const Complex

x

)

[inline]

Multiply scale operator for Complex *= Complex.

Definition at line 192 of file Complex.h.

References Return.

                                             {
                Return( *this = *this * x );
        }

Bool Complex::operator!=

(

Const Complex &

x

)

[inline]

Inquality operator for Complex != Complex.

Definition at line 108 of file Complex.h.

References Return.

                                                {
                Return !(m_r == x.m_r && m_i == x.m_i);
        }

Complex Complex::operator+

(

Const Complex &

c

)

[inline]

Addition operator for Complex + Complex.

Definition at line 133 of file Complex.h.

References Complex(), and Return.

                                           {
                Return Complex(m_r + c.m_r, m_i + c.m_i);
        }

Complex& Complex::operator+=

(

const Complex

x

)

[inline]

Increment operator for Complex += Complex.

Definition at line 182 of file Complex.h.

References Return.

                                             {
                Return( *this = *this + x );
        }

Complex Complex::operator-

(

)

[inline]

Negation operator for Complex.

Both real and imaginary parts are negated.

See also:

operator~()

Definition at line 144 of file Complex.h.

References Complex(), and Return.

                           {
                Return Complex(-m_r, -m_i);
        }

Complex Complex::operator-

(

Const Complex &

c

)

[inline]

Subtraction operator for Complex - Complex.

Definition at line 138 of file Complex.h.

References Complex(), and Return.

                                           {
                Return Complex(m_r - c.m_r, m_i - c.m_i);
        }

Complex& Complex::operator-=

(

const Complex

x

)

[inline]

Decrement operator for Complex -= Complex.

Definition at line 187 of file Complex.h.

References Return.

                                             {
                Return( *this = *this - x );
        }

Complex Complex::operator/

(

Const Real &

r

)

[inline]

Division operator for Complex / Real.

Definition at line 176 of file Complex.h.

References Return.

                                        {
                Complex c(r, 0.0);
                Return *this / c;
        }

Complex Complex::operator/

(

Const Complex &

c

)

[inline]

Division operator for Complex / Complex.

Definition at line 167 of file Complex.h.

References Complex(), i(), r(), and Return.

                                           {
                Real modulus = c.m_r * c.m_r + c.m_i * c.m_i;
                Real r = m_i * c.m_i + m_r * c.m_r;
                Real i = m_i * c.m_r - m_r * c.m_i;
    
                Return Complex(r / modulus, i / modulus);
        }

Complex& Complex::operator/=

(

const Real

r

)

[inline]

Divide scale operator for Complex /= Real.

Definition at line 202 of file Complex.h.

References Return.

                                          {
                Complex x(r, 0.0);
                Return( *this = *this / x );
        }

Complex& Complex::operator/=

(

const Complex

x

)

[inline]

Divide scale operator for Complex /= Complex.

Definition at line 197 of file Complex.h.

References Return.

                                             {
                Return( *this = *this / x );
        }

Bool Complex::operator<

(

Const Complex &

x

)

[inline]

Less-than operator for Complex < Complex.

Definition at line 113 of file Complex.h.

References Return.

                                               {
                Return m_r < x.m_r && m_i < x.m_i;
        }

Bool Complex::operator<=

(

Const Complex &

x

)

[inline]

Less-than or equal operator for Complex < Complex.

Definition at line 118 of file Complex.h.

References Return.

                                                {
                Return m_r <= x.m_r && m_i <= x.m_i;
        }

Complex& Complex::operator=

(

Const Real &

x

)

[inline]

Asignment operator for Complex = Real.

Definition at line 96 of file Complex.h.

References Return.

                                          {
                m_r = x;
                m_i = 0;
                Return *this;
        }

Bool Complex::operator==

(

Const Complex &

x

)

[inline]

Equality operator for Complex == Complex.

Definition at line 103 of file Complex.h.

References Return.

                                                {
                Return m_r == x.m_r && m_i == x.m_i;
        }

Bool Complex::operator>

(

Const Complex &

x

)

[inline]

Greater-than operator for Complex < Complex.

Definition at line 128 of file Complex.h.

References Return.

                                               {
                Return m_r > x.m_r && m_i > x.m_i;
        }

Bool Complex::operator>=

(

Const Complex &

x

)

[inline]

Greater-than or equal operator for Complex < Complex.

Definition at line 123 of file Complex.h.

References Return.

                                                {
                Return m_r >= x.m_r && m_i >= x.m_i;
        }

Complex Complex::operator~

(

)

[inline]

Conjugation operator for Complex.

Only imaginary part is negated.

See also:

operator-()

Definition at line 150 of file Complex.h.

References Complex(), and Return.

                           {
                Return Complex(m_r, -m_i);
        }

Void Complex::print

(

String

s = 0

)

[inline]

Print complex value, prepended by String s if not null.

Complex value is printed as "{r,i}".

Parameters:

s

String to prefix to complex number.

Definition at line 233 of file Complex.h.

References If.

                                        {
                If (s)
                        cout << s;
                cout << "{ ";
                cout.precision(2);
                cout << m_r << ", ";
                cout << m_i;
                cout << " }" << endl;
        }

Void Complex::r

(

Real

r

)

[inline]

Set the real part of Complex number.

See also:

r(Void)

Definition at line 89 of file Complex.h.

{ m_r = r; }

Real Complex::r

(

Void

)

[inline]

Get the real part of Complex number as a Real.

Returns:

The real part of the complex number as a Real

Definition at line 77 of file Complex.h.

References Return.

Referenced by Exp(), operator/(), and RealPart().

                     {
                Return m_r;
        }

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	os,
		const Complex &	c
	)			[friend]

Print to output stream.

Complex number is printed as '(' <real_part> ',' <imag_part> ')'

Definition at line 32 of file Complex.h.

                                                                    {
                cout << "(";
                // cout.precision(2); // Use this to set precision, if desired
                cout << c.m_r << ", ";
                cout << c.m_i;
                cout << ")";
                Return os;
        }

istream& operator>>	(	istream &	is,
		Complex &	c
	)			[friend]

Read from input stream.

Complex number is scanned as '{' <real_part> ',' <imag_part> '}' Alternately, parenthesis can be used to bracket complex number.

Definition at line 44 of file Complex.h.

                                                              {
                char ch;
                is >> ch && (ch == '{' || ch == '(')
                        && is >> c.m_r >> ch && ch == ','
                        && is >> c.m_i >> ch && (ch == '}' || ch == '(');
                Return is;
        }

---

The documentation for this class was generated from the following file:

• C:/Musimathics_local/Musimat/include/Complex.h

---