All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Mathematics Class CATMathComplexf

CATMathComplexf
 

Usage: you must use this class as is. You should never derive it.


public class CATMathComplexf

Class representing a complex number in float.

z = iReal+j*iImag with j*j = -1.


Constructor and Destructor Index


o CATMathComplexf()
Construct the z = 0+j*0 complex number.
o CATMathComplexf(CATMathComplexf&)
Copy constructor.
o CATMathComplexf(float&,float&)
Constructs a complex number from iReal and iImag.
o CATMathComplexf(float)
Constructs a complex number from iReal and Imag=0.
o CATMathComplexf(float[2])
Constructs a complex number from an array of two coordinates.

Method Index


o Conjugate()
Computes the conjugate of this complex number.
o GetCoord(float&,float&)
Retrieves the real and imaginary parts of this complex number.
o GetImag()
Returns the imaginary part of this complex number.
o GetReal()
Returns the real part of this complex number.
o Inverse()
Computes the inverse of this complex number.
o Modulus()
Returns the modulus of this complex number.
o Normalize()
Normalizes this complex number.
o SetCoord(float&,float&)
Sets the real and imaginary parts of this complex number.
o SetImag(float&)
Sets the imaginary part of this complex number.
o SetReal(float&)
Sets the real part of this complex number.
o SquareModulus()
Returns the square modulus of this complex number.
o operator *(CATMathComplexf&)
Multiplication operator.
o operator *=(CATMathComplexf&)
Multiplication assignment operator.
o operator +(CATMathComplexf&)
Addition operator.
o operator +=(CATMathComplexf&)
Addition assignment operator.
o operator -(CATMathComplexf&)
Subtraction operator.
o operator -=(CATMathComplexf&)
Subtraction assignment operator.
o operator /(CATMathComplexf&)
Division operator.
o operator /=(CATMathComplexf&)
Division assignment operator.

Constructor and Destructor


o CATMathComplexf
public CATMathComplexf()
Construct the z = 0+j*0 complex number.
o CATMathComplexf
public CATMathComplexf( const CATMathComplexf& iComplex)
Copy constructor.
o CATMathComplexf
public INLINE CATMathComplexf( const float& iReal,
const float& iImag)
Constructs a complex number from iReal and iImag.
z = iReal+j*iImag.
o CATMathComplexf
public CATMathComplexf(float iReal)
Constructs a complex number from iReal and Imag=0.
z = iReal.
o CATMathComplexf
public CATMathComplexf( const float[2] iCoord)
Constructs a complex number from an array of two coordinates.
z = iCoord[0]+j*iCoord[1].

Methods


o Conjugate
public INLINE void Conjugate()
Computes the conjugate of this complex number.
o GetCoord
public INLINE void GetCoord(float& ioReal,
float& ioImag) const
Retrieves the real and imaginary parts of this complex number.
z = ioReal+j*ioImag.
o GetImag
public INLINE float GetImag()const
Returns the imaginary part of this complex number.
Returns:
The imaginary part.
o GetReal
public INLINE float GetReal()const
Returns the real part of this complex number.
Returns:
The real part.
o Inverse
public void Inverse()
Computes the inverse of this complex number.
If the norm is null, this is set to null.
o Modulus
public float Modulus()const
Returns the modulus of this complex number.
Returns:
sqrt(iReal^2 + iImag^2).
o Normalize
public void Normalize()
Normalizes this complex number.
o SetCoord
public INLINE void SetCoord( const float& iReal,
const float& iImag)
Sets the real and imaginary parts of this complex number.
o SetImag
public INLINE void SetImag( const float& iImag)
Sets the imaginary part of this complex number.
o SetReal
public INLINE void SetReal( const float& iReal)
Sets the real part of this complex number.
o SquareModulus
public float SquareModulus()const
Returns the square modulus of this complex number.
Returns:
iReal^2 + iImag^2.
o operator *
public CATMathComplexf operator *( const CATMathComplexf& iComp2) const
Multiplication operator.
o operator *=
public CATMathComplexf& operator *=( const CATMathComplexf& iComp)
Multiplication assignment operator.
The operator modifies this complex number.
o operator +
public CATMathComplexf operator +( const CATMathComplexf& iComp2) const
Addition operator.
o operator +=
public CATMathComplexf & operator +=( const CATMathComplexf& iComp)
Addition assignment operator.
The operator modifies this complex number.
o operator -
public CATMathComplexf operator -( const CATMathComplexf& iComp2) const
Subtraction operator.
o operator -=
public CATMathComplexf & operator -=( const CATMathComplexf& iComp)
Subtraction assignment operator.
The operator modifies this complex number.
o operator /
public CATMathComplexf operator /( const CATMathComplexf& iComp2) const
Division operator.
o operator /=
public CATMathComplexf & operator /=( const CATMathComplexf& iComp)
Division assignment operator.
The operator modifies this complex number.

This object is included in the file: CATMathComplexf.h
If needed, your Imakefile.mk should include the module: CATMathematics

Copyright © 2003, Dassault Systèmes. All rights reserved.