Class for defining a complex number. More...

#include <LauComplex.hh>

Public Member Functions
	LauComplex ()
	Default Constructor.

	LauComplex (Double_t a, Double_t b)
	Constructor. More...

virtual	~LauComplex ()
	Destructor.

	LauComplex (const LauComplex &other)
	Copy constructor. More...

LauComplex &	operator= (const LauComplex &other)
	Copy assignment operator. More...

LauComplex	operator- () const
	Unary minus operator. More...

LauComplex	operator+ (const LauComplex &other) const
	Addition operator. More...

LauComplex	operator- (const LauComplex &other) const
	Subtraction operator. More...

LauComplex	operator* (const LauComplex &other) const
	Multiplication operator. More...

LauComplex	operator/ (const LauComplex &other) const
	Division operator. More...

LauComplex	operator+= (const LauComplex &other)
	Addition assignment operator. More...

LauComplex	operator-= (const LauComplex &other)
	Subtraction assignment operator. More...

LauComplex	operator*= (const LauComplex &other)
	Multiplication assignment operator. More...

LauComplex	operator/= (const LauComplex &other)
	Division assignment operator. More...

Bool_t	operator== (const LauComplex &other) const
	Boolean comparison operator. More...

Double_t	re () const
	Get the real part. More...

Double_t	im () const
	Get the imaginary part. More...

Double_t	abs () const
	Obtain the absolute value of the complex number. More...

Double_t	abs2 () const
	Obtain the square of the absolute value of the complex number. More...

Double_t	arg () const
	Obtain the phase angle of the complex number. More...

LauComplex	exp () const
	Obtain the exponential of the complex number. More...

LauComplex	conj () const
	Obtain the complex conjugate. More...

void	makeConj ()
	Transform this to its complex conjugate.

LauComplex	scale (Double_t scaleVal) const
	Obtain the complex number scaled by some factor. More...

void	rescale (Double_t scaleVal)
	Scale this by a factor. More...

void	setRealPart (Double_t realpart)
	Set the real part. More...

void	setImagPart (Double_t imagpart)
	Set the imaginary part. More...

void	setRealImagPart (Double_t realpart, Double_t imagpart)
	Set both real and imaginary part. More...

void	zero ()
	Set both real and imaginary part to zero.

void	print () const
	Print the complex number.

Private Attributes
Double_t	re_
	The real part.

Double_t	im_
	The imaginary part.

Detailed Description

Class for defining a complex number.

Class for complex number manipulation. In the function descriptions, the form (a,b) is used to represent a complex number. This is equivalent to the mathematical expression a + ib.

Definition at line 61 of file LauComplex.hh.

Constructor & Destructor Documentation

◆ LauComplex() [1/2]

LauComplex::LauComplex	(	Double_t	a,
		Double_t	b
	)

inline

Constructor.

Parameters

[in]	a	the value corresponding to the real part of the complex number
[in]	b	the value corresponding to the imaginary part of the complex number

Definition at line 90 of file LauComplex.hh.

◆ LauComplex() [2/2]

LauComplex::LauComplex ( const LauComplex & other )

inline

Copy constructor.

Parameters

[in] other the complex number to be copied

Definition at line 103 of file LauComplex.hh.

Member Function Documentation

◆ abs()

Double_t LauComplex::abs ( ) const

inline

Obtain the absolute value of the complex number.

Returns: the absolute value (magnitude)

Definition at line 254 of file LauComplex.hh.

◆ abs2()

Double_t LauComplex::abs2 ( ) const

inline

Obtain the square of the absolute value of the complex number.

Returns: the square of the absolute value (magnitude^2)

Definition at line 260 of file LauComplex.hh.

◆ arg()

Double_t LauComplex::arg ( ) const

inline

Obtain the phase angle of the complex number.

Returns: the phase angle of the complex number

Definition at line 266 of file LauComplex.hh.

◆ conj()

LauComplex LauComplex::conj ( ) const

inline

Obtain the complex conjugate.

Returns: the complex conjugate

Definition at line 282 of file LauComplex.hh.

◆ exp()

LauComplex LauComplex::exp ( ) const

inline

Obtain the exponential of the complex number.

Returns: the exponential of the complex number

Definition at line 272 of file LauComplex.hh.

◆ im()

Double_t LauComplex::im ( ) const

inline

Get the imaginary part.

Returns: the imaginary part of the complex number

Definition at line 248 of file LauComplex.hh.

◆ operator*()

LauComplex LauComplex::operator* ( const LauComplex & other ) const

inline

Multiplication operator.

Parameters

[in] other the object this one is to be multiplied by

Returns: the product of the two complex numbers

Definition at line 158 of file LauComplex.hh.

◆ operator*=()

LauComplex LauComplex::operator*= ( const LauComplex & other )

inline

Multiplication assignment operator.

Parameters

[in] other the object this one is to be multiplied by

Returns: the result of the multiplication

Definition at line 206 of file LauComplex.hh.

◆ operator+()

LauComplex LauComplex::operator+ ( const LauComplex & other ) const

inline

Addition operator.

Parameters

[in] other the object to added to this one

Returns: the sum of the two complex numbers

Definition at line 134 of file LauComplex.hh.

◆ operator+=()

LauComplex LauComplex::operator+= ( const LauComplex & other )

inline

Addition assignment operator.

Parameters

[in] other the object to be added to this one

Returns: the result of the addition

Definition at line 182 of file LauComplex.hh.

◆ operator-() [1/2]

LauComplex LauComplex::operator- ( ) const

inline

Unary minus operator.

Returns: the negated complex number

Definition at line 127 of file LauComplex.hh.

◆ operator-() [2/2]

LauComplex LauComplex::operator- ( const LauComplex & other ) const

inline

Subtraction operator.

Parameters

[in] other the object to be subtracted from this one

Returns: the difference of the two complex numbers

Definition at line 146 of file LauComplex.hh.

◆ operator-=()

LauComplex LauComplex::operator-= ( const LauComplex & other )

inline

Subtraction assignment operator.

Parameters

[in] other the object to be subtracted from this one

Returns: the result of the subtraction

Definition at line 194 of file LauComplex.hh.

◆ operator/()

LauComplex LauComplex::operator/ ( const LauComplex & other ) const

inline

Division operator.

Parameters

[in] other the object this one is to be divided by

Returns: the ratio of the two complex numbers

Definition at line 170 of file LauComplex.hh.

◆ operator/=()

LauComplex LauComplex::operator/= ( const LauComplex & other )

inline

Division assignment operator.

Parameters

[in] other the object this one is to be divided by

Returns: the results of the division

Definition at line 219 of file LauComplex.hh.

◆ operator=()

LauComplex& LauComplex::operator= ( const LauComplex & other )

inline

Copy assignment operator.

Parameters

[in] other the complex number to be copied

Returns: the assigned complex number

Definition at line 114 of file LauComplex.hh.

◆ operator==()

Bool_t LauComplex::operator== ( const LauComplex & other ) const

inline

Boolean comparison operator.

Parameters

[in] other the object to compared with this one

Returns: true/false for the comparison

Definition at line 233 of file LauComplex.hh.

◆ re()

Double_t LauComplex::re ( ) const

inline

Get the real part.

Returns: the real part of the complex number

Definition at line 242 of file LauComplex.hh.

◆ rescale()

void LauComplex::rescale ( Double_t scaleVal )

inline

Scale this by a factor.

Parameters

[in] scaleVal the value used to scale the complex number

Definition at line 301 of file LauComplex.hh.

◆ scale()

LauComplex LauComplex::scale ( Double_t scaleVal ) const

inline

Obtain the complex number scaled by some factor.

Parameters

[in] scaleVal the value used to scale the complex number

Returns: the complex number scaled by the scaleVal

Definition at line 292 of file LauComplex.hh.

◆ setImagPart()

void LauComplex::setImagPart ( Double_t imagpart )

inline

Set the imaginary part.

Parameters

[in] imagpart the value to be set as the imaginary part

Definition at line 317 of file LauComplex.hh.

◆ setRealImagPart()

void LauComplex::setRealImagPart	(	Double_t	realpart,
		Double_t	imagpart
	)

inline

Set both real and imaginary part.

Parameters

[in]	realpart	the value to be set as the real part
[in]	imagpart	the value to be set as the imaginary part

Definition at line 324 of file LauComplex.hh.

◆ setRealPart()

void LauComplex::setRealPart ( Double_t realpart )

inline

Set the real part.

Parameters

[in] realpart the value to be set as the real part

Definition at line 311 of file LauComplex.hh.

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

/home/epp/phsdba/Development/Laura++/master-dev/laura/inc/LauComplex.hh
/home/epp/phsdba/Development/Laura++/master-dev/laura/src/LauComplex.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LauComplex() [1/2]

◆ LauComplex() [2/2]

Member Function Documentation

◆ abs()

◆ abs2()

◆ arg()

◆ conj()

◆ exp()

◆ im()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator=()

◆ operator==()

◆ re()

◆ rescale()

◆ scale()

◆ setImagPart()

◆ setRealImagPart()

◆ setRealPart()