CComplex Class Reference

This class for complex operation and saving value. More...

#include "Complex.h"

Collaboration diagram for CComplex:

Public Member Functions
	CComplex ()
	~CComplex ()
void	GetComplexNumber (double *fReal, double *fImaginary)
	Get Complex number real part and imaginary part concurrently. More...
void	SetComplexNumber (double fReal, double fImaginaray)
	Set Complex number using real part and imaginary part. More...
double	GetRealNumber () const
	Get real part. More...
double	GetImaginaryNumber () const
	Get imaginary part. More...
CComplex	GetConjugate ()
	Get conjugate complex number. More...
double	GetAbsolute ()
	Get Absolute value of complex number. More...
void	SetRealNumber (double fRealNumber)
	Set real part. More...
void	SetImaginaryNumber (double fImaginaryNumber)
	Set imagenary part. More...
double	GetNorm ()
	Get norm of complex number. More...
void	Add (CComplex complex)
	Adding operation to this class. More...
void	Minus (CComplex complex)
	Minus operation to this class. More...
void	Division (double fScalar)
	Scalar division operation. More...
void	Multiple (double fScalar)
	Scalar Multiply operation. More...
void	operator= (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator+ (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator+= (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator- (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator-= (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator* (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator* (double fScalar)
	operation overload for subsitution with reference parameter More...
CComplex	operator*= (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator*= (double fScalar)
	operation overload for subsitution with reference parameter More...
CComplex	operator/ (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator/ (double fScalar)
	operation overload for subsitution with reference parameter More...
CComplex	operator/= (const CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...
CComplex	operator/= (double fScalar)
	operation overload for subsitution with reference parameter More...
bool	operator== (double fScalar)
	operation overload for subsitution with reference parameter More...
bool	operator== (CComplex &complexSrc)
	operation overload for subsitution with reference parameter More...

Static Public Member Functions
static CComplex	AddComplex (CComplex complex1, CComplex complex2)
	Adding operation between complex numbers. More...
static CComplex	MinusComplex (CComplex complex1, CComplex complex2)
	Minus operation between complex numbers. More...
static CComplex	MulltiplyComplex (CComplex complex1, CComplex complex2)
	Multiple operation between complex numbers. More...
static CComplex	DivideComplex (CComplex complex1, CComplex complex2)
	Divide operation between complex numbers. More...
static bool	IsSame (CComplex complex1, CComplex complex2)

Public Attributes
double	m_fRealNumber
	Real part of complex number. More...
double	m_fImaginaryNumber
	Imaginary part of complex number. More...

Detailed Description

This class for complex operation and saving value.

Date

27/May/2014

Definition at line 16 of file Complex.h.

Constructor & Destructor Documentation

CComplex::CComplex

(

)

Definition at line 10 of file Complex.cpp.

References m_fImaginaryNumber, and m_fRealNumber.

{
    m_fRealNumber = 0.;
    m_fImaginaryNumber = 0.;
}

CComplex::~CComplex

(

)

Definition at line 16 of file Complex.cpp.

{
}

Member Function Documentation

void CComplex::Add

(

CComplex

complex

)

Adding operation to this class.

Parameters

complex

operand

Definition at line 67 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), m_fImaginaryNumber, and m_fRealNumber.

Referenced by CMatrixOperation::MMMul(), and CMatrixOperation::MVMul().

{
    double      fReal, fImaginary;

    fReal = complex.GetRealNumber();
    m_fRealNumber += fReal;
    fImaginary = complex.GetImaginaryNumber();
    m_fImaginaryNumber += fImaginary;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CComplex CComplex::AddComplex ( CComplex  complex1, CComplex  complex2  )

static

Adding operation between complex numbers.

Parameters

complex1	operand 1
complex2	operand 2

Returns

Calculation result

Definition at line 98 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

Referenced by operator+(), and operator+=().

{
    CComplex        rtnNumber;

    rtnNumber.SetComplexNumber(complex1.GetRealNumber() + complex2.GetRealNumber(), 
                                complex1.GetImaginaryNumber() + complex2.GetImaginaryNumber());
    return rtnNumber;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CComplex CComplex::DivideComplex ( CComplex  complex1, CComplex  complex2  )

static

Divide operation between complex numbers.

Parameters

complex1	operand 1
complex2	operand 2

Returns

Calculation result

Definition at line 143 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

Referenced by operator/(), and operator/=().

{
    CComplex        rtnNumber;

    double          realNumber, imaginaryNumber, d;

    d = complex2.GetRealNumber() * complex2.GetRealNumber() + complex2.GetImaginaryNumber() * complex2.GetImaginaryNumber();

    realNumber = complex1.GetRealNumber() * complex2.GetRealNumber() + complex1.GetImaginaryNumber() * complex2.GetImaginaryNumber();
    realNumber /= d;

    imaginaryNumber = complex1.GetImaginaryNumber() * complex2.GetRealNumber() - complex1.GetRealNumber() * complex2.GetImaginaryNumber();
    imaginaryNumber /= d;

    rtnNumber.SetComplexNumber(realNumber, imaginaryNumber);
    return rtnNumber;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CComplex::Division

(

double

fScalar

)

Scalar division operation.

Definition at line 86 of file Complex.cpp.

References m_fImaginaryNumber, and m_fRealNumber.

{
    m_fRealNumber /= fScalar;
    m_fImaginaryNumber /= fScalar;
}

double CComplex::GetAbsolute

(

)

Get Absolute value of complex number.

Returns

Absolute of complex number

Definition at line 23 of file Complex.cpp.

References GetImaginaryNumber(), and GetRealNumber().

Referenced by CLanczosMethod::BuildWaveFunction(), and CLanczosMethod::RecalcuWaveFunction().

{
    double      fRealNumber = GetRealNumber();
    double      fImginaryNumber = GetImaginaryNumber();

    return sqrt( fRealNumber*fRealNumber + fImginaryNumber*fImginaryNumber );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CComplex::GetComplexNumber	(	double *	fReal,
		double *	fImaginary
	)

Get Complex number real part and imaginary part concurrently.

Parameters

[out]	fReal	Real part
[out]	fImaginary	Imaginary part

Definition at line 48 of file Complex.cpp.

References m_fImaginaryNumber, and m_fRealNumber.

{
    *fReal = m_fRealNumber;
    *fImaginary = m_fImaginaryNumber;
}

CComplex CComplex::GetConjugate

(

)

Get conjugate complex number.

Returns

Conjugate complex number

Definition at line 34 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), SetImaginaryNumber(), and SetRealNumber().

{
    CComplex        rtnNumber;

    rtnNumber.SetRealNumber(GetRealNumber());
    rtnNumber.SetImaginaryNumber(GetImaginaryNumber() * -1);

    return rtnNumber;
}

Here is the call graph for this function:

double CComplex::GetImaginaryNumber ( ) const

inline

Get imaginary part.

Definition at line 25 of file Complex.h.

References m_fImaginaryNumber.

Referenced by Add(), AddComplex(), CMPIManager::AllReduceComlex(), CMatrixOperation::CDMatrix::AppendMatrix(), CMatrixOperation::BuildLocalCSR(), DivideComplex(), GetAbsolute(), GetConjugate(), CMatrixOperation::CCSR::InsertMatrix(), CMatrixOperation::CVector::InsertVector(), IsSame(), CMatrixOperation::IsSame(), Minus(), MinusComplex(), CMatrixOperation::CVector::MinusVector(), MulltiplyComplex(), operator*(), operator*=(), operator/(), operator/=(), operator=(), CMatrixOperation::CVector::PlusVector(), CMatrixOperation::CCSR::PushMatrix(), CMatrixOperation::CCSR::PushMatrixConcurrent(), CMatrixOperation::CCSR::PushMatrixConcurrentPE(), CGeometricShape::RefillPeriodicBinding(), CMatrixOperation::CVector::ReorthogonalizationVector(), CLanczosMethod::SaveLanczosResult(), CMatrixOperation::CVector::ScalarDivision(), CMatrixOperation::CVector::ScalarMultiple(), CMatrixOperation::ScalarMulVectors(), CMatrixOperation::CVector::SetAt(), CMatrixOperation::CCSR::SetAt(), CMatrixOperation::CVector::SetAtEx(), CMatrixOperation::CDMatrix::SetElement(), CUtility::ShowComplex(), CUtility::ShowCSR(), CUtility::ShowDenseMatrix(), CUtility::ShowDoubleVector(), and CMatrixOperation::UpdateLocalCSR().

Here is the caller graph for this function:

double CComplex::GetNorm ( )

inline

Get norm of complex number.

Definition at line 32 of file Complex.h.

References m_fImaginaryNumber, and m_fRealNumber.

Referenced by CLanczosResultAudit::AuditResult_WF().

Here is the caller graph for this function:

double CComplex::GetRealNumber ( ) const

inline

Get real part.

Definition at line 24 of file Complex.h.

References m_fRealNumber.

Referenced by Add(), AddComplex(), CMPIManager::AllReduceComlex(), CMatrixOperation::CDMatrix::AppendMatrix(), CMatrixOperation::BuildLocalCSR(), CHamiltonianBuilder::BuildOffsiteMatrixFor10Band(), CGeometricShape::BuildPEBiasVector(), CGeometricShape::BuildPEWaveVector(), CZincblendeParam::CalculateLatticeCoonstants(), DivideComplex(), CSPLoop::executeSPLoop(), CHamiltonianBuilder::FillMatrixFor10Band(), GetAbsolute(), GetConjugate(), CMatrixOperation::Gram_schmidt(), CMatrixOperation::CCSR::InsertMatrix(), CMatrixOperation::CVector::InsertVector(), IsSame(), CMatrixOperation::IsSame(), CLanczosMethod::LanczosIterationLoop(), CLanczosMethod::MergeDegeneratedEigenvalues(), Minus(), MinusComplex(), CMatrixOperation::CVector::MinusVector(), MulltiplyComplex(), operator*(), operator*=(), operator/(), operator/=(), operator=(), CMatrixOperation::CVector::PlusVector(), CMatrixOperation::CCSR::PushMatrix(), CMatrixOperation::CCSR::PushMatrixConcurrent(), CMatrixOperation::CCSR::PushMatrixConcurrentPE(), CGeometricShape::RefillPeriodicBinding(), CMatrixOperation::CVector::ReorthogonalizationVector(), IGeometricUnitCellInfo::RotateAxis(), IGeometricUnitCellInfo::RotateNeighbor(), CHamiltonianBuilder::RotateTransMatrixFor10Band(), CLanczosMethod::SaveLanczosResult(), CMatrixOperation::CVector::ScalarDivision(), CMatrixOperation::CVector::ScalarMultiple(), CMatrixOperation::ScalarMulVectors(), CMatrixOperation::CVector::SetAt(), CMatrixOperation::CCSR::SetAt(), CMatrixOperation::CVector::SetAtEx(), CMatrixOperation::CDMatrix::SetElement(), CUtility::ShowComplex(), CUtility::ShowCSR(), CUtility::ShowDenseMatrix(), CUtility::ShowDoubleVector(), and CMatrixOperation::UpdateLocalCSR().

bool CComplex::IsSame ( CComplex  complex1, CComplex  complex2  )

static

Parameters

complex1	Comparing source 1
complex2	Comparing source 2

Returns

Comparing result

Definition at line 323 of file Complex.cpp.

References GENERAL_TOLERANCE, GetImaginaryNumber(), and GetRealNumber().

Referenced by operator==().

{
    bool            bRtn = false;

    if (fabs(complex1.GetRealNumber()- complex2.GetRealNumber()) > GENERAL_TOLERANCE)
        return bRtn;

    if (fabs(complex1.GetImaginaryNumber()- complex2.GetImaginaryNumber()) < GENERAL_TOLERANCE)
        bRtn = true;

    return bRtn;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CComplex::Minus

(

CComplex

complex

)

Minus operation to this class.

Parameters

complex

operand

Definition at line 80 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), m_fImaginaryNumber, and m_fRealNumber.

{
    m_fRealNumber -= complex.GetRealNumber();
    m_fImaginaryNumber -= complex.GetImaginaryNumber();
}

Here is the call graph for this function:

CComplex CComplex::MinusComplex ( CComplex  complex1, CComplex  complex2  )

static

Minus operation between complex numbers.

Parameters

complex1	operand 1
complex2	operand 2

Returns

Calculation result

Definition at line 112 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

Referenced by operator-(), and operator-=().

{
    CComplex        rtnNumber;

    rtnNumber.SetComplexNumber(complex1.GetRealNumber() - complex2.GetRealNumber(), 
                                complex1.GetImaginaryNumber() - complex2.GetImaginaryNumber());
    return rtnNumber;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CComplex CComplex::MulltiplyComplex ( CComplex  complex1, CComplex  complex2  )

static

Multiple operation between complex numbers.

Parameters

complex1	operand 1
complex2	operand 2

Returns

Calculation result

Definition at line 126 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

Referenced by CMatrixOperation::MMMul(), CMatrixOperation::MVMul(), operator*(), and operator*=().

{
    CComplex        rtnNumber;

    double          realNumber, imaginaryNumber;

    realNumber = complex1.GetRealNumber() * complex2.GetRealNumber() - complex1.GetImaginaryNumber() * complex2.GetImaginaryNumber();
    imaginaryNumber = complex1.GetRealNumber() * complex2.GetImaginaryNumber() + complex1.GetImaginaryNumber() * complex2.GetRealNumber();
    rtnNumber.SetComplexNumber(realNumber, imaginaryNumber);
    return rtnNumber;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CComplex::Multiple

(

double

fScalar

)

Scalar Multiply operation.

CComplex CComplex::operator*

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 209 of file Complex.cpp.

References MulltiplyComplex().

{
    CComplex        rtnValue;

    return MulltiplyComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator*

(

double

fScalar

)

operation overload for subsitution with reference parameter

Parameters

fScalar

Scalar number that want to multiply

Returns

Calculation result

Definition at line 220 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

{
    CComplex        rtnValue;

    rtnValue.SetComplexNumber(this->GetRealNumber() * fScalar, this->GetImaginaryNumber() * fScalar);
    return rtnValue;
}

Here is the call graph for this function:

CComplex CComplex::operator*=

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 232 of file Complex.cpp.

References MulltiplyComplex().

{
    CComplex        rtnValue;

    return MulltiplyComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator*=

(

double

fScalar

)

operation overload for subsitution with reference parameter

Parameters

fScalar

Scalar number that want to multiply

Returns

Calculation result

Definition at line 243 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

{
    CComplex        rtnValue;

    rtnValue.SetComplexNumber(this->GetRealNumber() * fScalar, this->GetImaginaryNumber() * fScalar);
    return rtnValue;
}

Here is the call graph for this function:

CComplex CComplex::operator+

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 173 of file Complex.cpp.

References AddComplex().

{
    return AddComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator+=

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 182 of file Complex.cpp.

References AddComplex().

{
    return AddComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator-

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 191 of file Complex.cpp.

References MinusComplex().

{
    return MinusComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator-=

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 200 of file Complex.cpp.

References MinusComplex().

{
    return MinusComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator/

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 255 of file Complex.cpp.

References DivideComplex().

{
    CComplex        rtnValue;

    return DivideComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator/

(

double

fScalar

)

operation overload for subsitution with reference parameter

Parameters

fScalar

Scalar number that want to divide

Returns

Calculation result

Definition at line 266 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

{
    CComplex        rtnValue;

    rtnValue.SetComplexNumber(this->GetRealNumber() / fScalar, this->GetImaginaryNumber() / fScalar);
    return rtnValue;
}

Here is the call graph for this function:

CComplex CComplex::operator/=

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Returns

Calculation result

Definition at line 278 of file Complex.cpp.

References DivideComplex().

{
    CComplex        rtnValue;

    return DivideComplex((*this), complexSrc);
}

Here is the call graph for this function:

CComplex CComplex::operator/=

(

double

fScalar

)

operation overload for subsitution with reference parameter

Parameters

fScalar

Scalar number that want to divide

Returns

Calculation result

Definition at line 289 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

{
    CComplex        rtnValue;

    rtnValue.SetComplexNumber(this->GetRealNumber() / fScalar, this->GetImaginaryNumber() / fScalar);
    return rtnValue;
}

Here is the call graph for this function:

void CComplex::operator=

(

const CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

opperand

Definition at line 164 of file Complex.cpp.

References GetImaginaryNumber(), GetRealNumber(), and SetComplexNumber().

{
    SetComplexNumber(complexSrc.GetRealNumber(), complexSrc.GetImaginaryNumber());
}

Here is the call graph for this function:

bool CComplex::operator==

(

double

fScalar

)

operation overload for subsitution with reference parameter

Parameters

fScalar

Scalar number that want to compare

Returns

Comparing result

Definition at line 301 of file Complex.cpp.

References IsSame(), and SetComplexNumber().

{
    CComplex            complex;

    complex.SetComplexNumber(fScalar, 0);
    return IsSame(*this, complex);
}

Here is the call graph for this function:

bool CComplex::operator==

(

CComplex &

complexSrc

)

operation overload for subsitution with reference parameter

Parameters

complexSrc

Complex number that want to divide

Returns

Comparing result

Definition at line 313 of file Complex.cpp.

References IsSame().

{
    return IsSame(*this, complexSrc);
}

Here is the call graph for this function:

void CComplex::SetComplexNumber	(	double	fReal,
		double	fImaginaray
	)

Set Complex number using real part and imaginary part.

Parameters

fReal	Real part
fImaginary	Imaginary part

Definition at line 58 of file Complex.cpp.

References SetImaginaryNumber(), and SetRealNumber().

Referenced by AddComplex(), CMPIManager::AllReduceComlex(), CLanczosResultAudit::AuditResult_WF(), DivideComplex(), CMatrixOperation::CVector::GetAt(), CMatrixOperation::CCSR::GetElement(), MinusComplex(), MulltiplyComplex(), operator*(), operator*=(), operator/(), operator/=(), operator=(), operator==(), CGeometricShape::RefillPeriodicBinding(), CMatrixOperation::CVector::ScalarDivision(), CMatrixOperation::CVector::ScalarMultiple(), and CMatrixOperation::VVDot().

{
    SetRealNumber(fReal);
    SetImaginaryNumber(fImaginaray);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CComplex::SetImaginaryNumber ( double  fImaginaryNumber )

inline

Set imagenary part.

Definition at line 30 of file Complex.h.

References m_fImaginaryNumber.

Referenced by GetConjugate(), SetComplexNumber(), and CMatrixOperation::UpdateLocalCSR().

Here is the caller graph for this function:

void CComplex::SetRealNumber ( double  fRealNumber )

inline

Set real part.

Definition at line 29 of file Complex.h.

References m_fRealNumber.

Referenced by CTBMS_Solver::ApplyPhPotential(), CHamiltonianBuilder::FillMatrixFor10Band(), GetConjugate(), SetComplexNumber(), and CMatrixOperation::UpdateLocalCSR().

Here is the caller graph for this function:

Member Data Documentation

double CComplex::m_fImaginaryNumber

Imaginary part of complex number.

Definition at line 70 of file Complex.h.

Referenced by Add(), CComplex(), Division(), GetComplexNumber(), GetImaginaryNumber(), GetNorm(), Minus(), and SetImaginaryNumber().

double CComplex::m_fRealNumber

Real part of complex number.

Definition at line 69 of file Complex.h.

Referenced by Add(), CComplex(), Division(), GetComplexNumber(), GetNorm(), GetRealNumber(), Minus(), and SetRealNumber().

---

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

• D:/For Doxygen/Complex.h
• D:/For Doxygen/Complex.cpp