Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Properties | List of all members
CDPL.Math.FRealQuaternion Class Reference
+ Inheritance diagram for CDPL.Math.FRealQuaternion:

Public Member Functions

None __init__ ()
 Initializes the FRealQuaternion instance.
 
None __init__ (FRealQuaternion q)
 Initializes a copy of the FRealQuaternion instance q. More...
 
None __init__ (float r)
 Initializes the FRealQuaternion instance. More...
 
FRealQuaternion set (float r=0.0)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
float getC1 ()
 
float getC2 ()
 
float getC3 ()
 
float getC4 ()
 
object toArray ()
 
FRealQuaternion assign (FRealQuaternion q)
 Replaces the current state of self with a copy of the state of the FRealQuaternion instance q. More...
 
None swap (FRealQuaternion q)
 
FRealQuaternion __iadd__ (float t)
 Performs the in-place addition operation self += t. More...
 
FRealQuaternion __iadd__ (object q)
 Performs the in-place addition operation self += q. More...
 
FRealQuaternion __isub__ (float t)
 Performs the in-place subtraction operation self -= t. More...
 
FRealQuaternion __isub__ (object q)
 Performs the in-place subtraction operation self -= q. More...
 
FRealQuaternion __imul__ (float t)
 Performs the in-place multiplication operation self *= t. More...
 
FRealQuaternion __imul__ (object q)
 Performs the in-place multiplication operation self *= q. More...
 
FRealQuaternion __idiv__ (float t)
 Performs the in-place division operation self /= t. More...
 
FRealQuaternion __idiv__ (object q)
 Performs the in-place division operation self /= q. More...
 
FRealQuaternion __itruediv__ (float t)
 
FRealQuaternion __itruediv__ (object q)
 
bool __eq__ (FRealQuaternion q)
 Returns the result of the comparison operation self == q. More...
 
bool __eq__ (ConstFQuaternionExpression q)
 Returns the result of the comparison operation self == q. More...
 
bool __ne__ (FRealQuaternion q)
 Returns the result of the comparison operation self != q. More...
 
bool __ne__ (ConstFQuaternionExpression q)
 Returns the result of the comparison operation self != q. More...
 
str __str__ ()
 Returns a string representation of the FRealQuaternion instance. More...
 
FRealQuaternion __pos__ ()
 
ConstFQuaternionExpression __neg__ ()
 
ConstFQuaternionExpression __add__ (float t)
 Returns the result of the addition operation self + t. More...
 
ConstFQuaternionExpression __add__ (ConstFQuaternionExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstFQuaternionExpression __radd__ (float t)
 
ConstFQuaternionExpression __sub__ (float t)
 Returns the result of the subtraction operation self - t. More...
 
ConstFQuaternionExpression __sub__ (ConstFQuaternionExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstFQuaternionExpression __rsub__ (float t)
 
ConstFQuaternionExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstFQuaternionExpression __mul__ (ConstFQuaternionExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstFQuaternionExpression __rmul__ (float t)
 
ConstFQuaternionExpression __div__ (float t)
 Returns the result of the division operation self / t. More...
 
ConstFQuaternionExpression __div__ (ConstFQuaternionExpression e)
 Returns the result of the division operation self / e. More...
 
ConstFQuaternionExpression __truediv__ (float t)
 
ConstFQuaternionExpression __rdiv__ (float t)
 

Properties

 objectID = property(getObjectID)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.FRealQuaternion.__init__ ( FRealQuaternion  q)

Initializes a copy of the FRealQuaternion instance q.

Parameters
qThe FRealQuaternion instance to copy.

◆ __init__() [2/2]

None CDPL.Math.FRealQuaternion.__init__ ( float  r)

Initializes the FRealQuaternion instance.

Parameters
r

Member Function Documentation

◆ set()

FRealQuaternion CDPL.Math.FRealQuaternion.set ( float   r = 0.0)
Parameters
r
Returns

◆ getObjectID()

int CDPL.Math.FRealQuaternion.getObjectID ( )

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python FRealQuaternion instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two FRealQuaternion instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns
The numeric ID of the internally referenced C++ class instance.

◆ getC1()

float CDPL.Math.FRealQuaternion.getC1 ( )
Returns

◆ getC2()

float CDPL.Math.FRealQuaternion.getC2 ( )
Returns

◆ getC3()

float CDPL.Math.FRealQuaternion.getC3 ( )
Returns

◆ getC4()

float CDPL.Math.FRealQuaternion.getC4 ( )
Returns

◆ toArray()

object CDPL.Math.FRealQuaternion.toArray ( )
Returns

◆ assign()

FRealQuaternion CDPL.Math.FRealQuaternion.assign ( FRealQuaternion  q)

Replaces the current state of self with a copy of the state of the FRealQuaternion instance q.

Parameters
qThe FRealQuaternion instance to copy.
Returns
self

◆ swap()

None CDPL.Math.FRealQuaternion.swap ( FRealQuaternion  q)
Parameters
q

◆ __iadd__() [1/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__iadd__ ( float  t)

Performs the in-place addition operation self += t.

Parameters
tSpecifies the second addend.
Returns
The updated FRealQuaternion instance self.

◆ __iadd__() [2/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__iadd__ ( object  q)

Performs the in-place addition operation self += q.

Parameters
qSpecifies the second addend.
Returns
The updated FRealQuaternion instance self.

◆ __isub__() [1/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__isub__ ( float  t)

Performs the in-place subtraction operation self -= t.

Parameters
tSpecifies the subtrahend.
Returns
The updated FRealQuaternion instance self.

◆ __isub__() [2/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__isub__ ( object  q)

Performs the in-place subtraction operation self -= q.

Parameters
qSpecifies the subtrahend.
Returns
The updated FRealQuaternion instance self.

◆ __imul__() [1/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__imul__ ( float  t)

Performs the in-place multiplication operation self *= t.

Parameters
tSpecifies the multiplier.
Returns
The updated FRealQuaternion instance self.

◆ __imul__() [2/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__imul__ ( object  q)

Performs the in-place multiplication operation self *= q.

Parameters
qSpecifies the multiplier.
Returns
The updated FRealQuaternion instance self.

◆ __idiv__() [1/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__idiv__ ( float  t)

Performs the in-place division operation self /= t.

Parameters
tSpecifies the divisor.
Returns
The updated FRealQuaternion instance self.

◆ __idiv__() [2/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__idiv__ ( object  q)

Performs the in-place division operation self /= q.

Parameters
qSpecifies the divisor.
Returns
The updated FRealQuaternion instance self.

◆ __itruediv__() [1/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__itruediv__ ( float  t)
Parameters
t
Returns

◆ __itruediv__() [2/2]

FRealQuaternion CDPL.Math.FRealQuaternion.__itruediv__ ( object  q)
Parameters
q
Returns

◆ __eq__() [1/2]

bool CDPL.Math.FRealQuaternion.__eq__ ( FRealQuaternion  q)

Returns the result of the comparison operation self == q.

Parameters
qThe FRealQuaternion instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

bool CDPL.Math.FRealQuaternion.__eq__ ( ConstFQuaternionExpression  q)

Returns the result of the comparison operation self == q.

Parameters
qThe ConstFQuaternionExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [1/2]

bool CDPL.Math.FRealQuaternion.__ne__ ( FRealQuaternion  q)

Returns the result of the comparison operation self != q.

Parameters
qThe FRealQuaternion instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

bool CDPL.Math.FRealQuaternion.__ne__ ( ConstFQuaternionExpression  q)

Returns the result of the comparison operation self != q.

Parameters
qThe ConstFQuaternionExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __str__()

str CDPL.Math.FRealQuaternion.__str__ ( )

Returns a string representation of the FRealQuaternion instance.

Returns
The generated string representation.

◆ __pos__()

FRealQuaternion CDPL.Math.FRealQuaternion.__pos__ ( )
Returns

◆ __neg__()

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__neg__ ( )
Returns

◆ __add__() [1/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__add__ ( float  t)

Returns the result of the addition operation self + t.

Parameters
tSpecifies the second addend.
Returns
A ConstFQuaternionExpression instance holding the result of the addition.

◆ __add__() [2/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__add__ ( ConstFQuaternionExpression  e)

Returns the result of the addition operation self + e.

Parameters
eSpecifies the second addend.
Returns
A ConstFQuaternionExpression instance holding the result of the addition.

◆ __radd__()

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__radd__ ( float  t)
Parameters
t
Returns

◆ __sub__() [1/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__sub__ ( float  t)

Returns the result of the subtraction operation self - t.

Parameters
tSpecifies the subtrahend.
Returns
A FRealQuaternion instance holding the result of the subtraction.

◆ __sub__() [2/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__sub__ ( ConstFQuaternionExpression  e)

Returns the result of the subtraction operation self - e.

Parameters
eSpecifies the subtrahend.
Returns
A FRealQuaternion instance holding the result of the subtraction.

◆ __rsub__()

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__rsub__ ( float  t)
Parameters
t
Returns

◆ __mul__() [1/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

Parameters
tSpecifies the multiplier.
Returns
A ConstFQuaternionExpression instance holding the result of the multiplication.

◆ __mul__() [2/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__mul__ ( ConstFQuaternionExpression  e)

Returns the result of the multiplication operation self * e.

Parameters
eSpecifies the multiplier.
Returns
A ConstFQuaternionExpression instance holding the result of the multiplication.

◆ __rmul__()

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__rmul__ ( float  t)
Parameters
t
Returns

◆ __div__() [1/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__div__ ( float  t)

Returns the result of the division operation self / t.

Parameters
tSpecifies the divisor.
Returns
A ConstFQuaternionExpression instance holding the result of the division.

◆ __div__() [2/2]

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__div__ ( ConstFQuaternionExpression  e)

Returns the result of the division operation self / e.

Parameters
eSpecifies the divisor.
Returns
A ConstFQuaternionExpression instance holding the result of the division.

◆ __truediv__()

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rdiv__()

ConstFQuaternionExpression CDPL.Math.FRealQuaternion.__rdiv__ ( float  t)
Parameters
t
Returns