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

Public Member Functions

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

Properties

 objectID = property(getObjectID)
 

Constructor & Destructor Documentation

◆ __init__() [1/7]

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

Initializes a copy of the DQuaternion instance q.

Parameters
qThe DQuaternion instance to copy.

◆ __init__() [2/7]

None CDPL.Math.DQuaternion.__init__ ( float  c1,
float   c2 = 0.0,
float   c3 = 0.0,
float   c4 = 0.0 
)

Initializes the DQuaternion instance.

Parameters
c1
c2
c3
c4

◆ __init__() [3/7]

None CDPL.Math.DQuaternion.__init__ ( ConstFQuaternionExpression  e)

Initializes the DQuaternion instance.

Parameters
e

◆ __init__() [4/7]

None CDPL.Math.DQuaternion.__init__ ( ConstDQuaternionExpression  e)

Initializes the DQuaternion instance.

Parameters
e

◆ __init__() [5/7]

None CDPL.Math.DQuaternion.__init__ ( ConstLQuaternionExpression  e)

Initializes the DQuaternion instance.

Parameters
e

◆ __init__() [6/7]

None CDPL.Math.DQuaternion.__init__ ( ConstULQuaternionExpression  e)

Initializes the DQuaternion instance.

Parameters
e

◆ __init__() [7/7]

None CDPL.Math.DQuaternion.__init__ ( object  a)

Initializes the DQuaternion instance.

Parameters
a

Member Function Documentation

◆ getObjectID()

int CDPL.Math.DQuaternion.getObjectID ( )

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

Different Python DQuaternion 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 DQuaternion 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.

◆ assign() [1/6]

DQuaternion CDPL.Math.DQuaternion.assign ( ConstFQuaternionExpression  e)

Replaces the current state of self with a copy of the state of the ConstFQuaternionExpression instance e.

Parameters
eThe ConstFQuaternionExpression instance to copy.
Returns
self

◆ assign() [2/6]

DQuaternion CDPL.Math.DQuaternion.assign ( ConstDQuaternionExpression  e)

Replaces the current state of self with a copy of the state of the ConstDQuaternionExpression instance e.

Parameters
eThe ConstDQuaternionExpression instance to copy.
Returns
self

◆ assign() [3/6]

DQuaternion CDPL.Math.DQuaternion.assign ( ConstLQuaternionExpression  e)

Replaces the current state of self with a copy of the state of the ConstLQuaternionExpression instance e.

Parameters
eThe ConstLQuaternionExpression instance to copy.
Returns
self

◆ assign() [4/6]

DQuaternion CDPL.Math.DQuaternion.assign ( ConstULQuaternionExpression  e)

Replaces the current state of self with a copy of the state of the ConstULQuaternionExpression instance e.

Parameters
eThe ConstULQuaternionExpression instance to copy.
Returns
self

◆ assign() [5/6]

DQuaternion CDPL.Math.DQuaternion.assign ( DQuaternion  q)

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

Parameters
qThe DQuaternion instance to copy.
Returns
self

◆ assign() [6/6]

None CDPL.Math.DQuaternion.assign ( object  a)

Replaces the current state of self with a copy of the state of the object instance a.

Parameters
aThe object instance to copy.
Returns
self

◆ getC1()

float CDPL.Math.DQuaternion.getC1 ( )
Returns

◆ getC2()

float CDPL.Math.DQuaternion.getC2 ( )
Returns

◆ getC3()

float CDPL.Math.DQuaternion.getC3 ( )
Returns

◆ getC4()

float CDPL.Math.DQuaternion.getC4 ( )
Returns

◆ toArray()

object CDPL.Math.DQuaternion.toArray ( )
Returns

◆ swap()

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

◆ setC1()

None CDPL.Math.DQuaternion.setC1 ( float  v)
Parameters
v

◆ setC2()

None CDPL.Math.DQuaternion.setC2 ( float  v)
Parameters
v

◆ setC3()

None CDPL.Math.DQuaternion.setC3 ( float  v)
Parameters
v

◆ setC4()

None CDPL.Math.DQuaternion.setC4 ( float  v)
Parameters
v

◆ set()

None CDPL.Math.DQuaternion.set ( float   c1 = 0.0,
float   c2 = 0.0,
float   c3 = 0.0,
float   c4 = 0.0 
)
Parameters
c1
c2
c3
c4

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.DQuaternion.__eq__ ( ConstDQuaternionExpression  q)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.DQuaternion.__ne__ ( ConstDQuaternionExpression  q)

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

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

◆ __str__()

str CDPL.Math.DQuaternion.__str__ ( )

Returns a string representation of the DQuaternion instance.

Returns
The generated string representation.

◆ __pos__()

DQuaternion CDPL.Math.DQuaternion.__pos__ ( )
Returns

◆ __neg__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__neg__ ( )
Returns

◆ __add__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__add__ ( float  t)

Returns the result of the addition operation self + t.

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

◆ __add__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__add__ ( ConstDQuaternionExpression  e)

Returns the result of the addition operation self + e.

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

◆ __radd__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__radd__ ( float  t)
Parameters
t
Returns

◆ __sub__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__sub__ ( float  t)

Returns the result of the subtraction operation self - t.

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

◆ __sub__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__sub__ ( ConstDQuaternionExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __rsub__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__rsub__ ( float  t)
Parameters
t
Returns

◆ __mul__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__mul__ ( ConstDQuaternionExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __rmul__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__rmul__ ( float  t)
Parameters
t
Returns

◆ __div__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __div__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__div__ ( ConstDQuaternionExpression  e)

Returns the result of the division operation self / e.

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

◆ __truediv__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rdiv__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__rdiv__ ( float  t)
Parameters
t
Returns

◆ __iadd__() [1/3]

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

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

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

◆ __iadd__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__iadd__ ( DQuaternion  q)

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

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

◆ __iadd__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__iadd__ ( ConstDQuaternionExpression  q)

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

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

◆ __isub__() [1/3]

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

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

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

◆ __isub__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__isub__ ( DQuaternion  q)

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

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

◆ __isub__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__isub__ ( ConstDQuaternionExpression  q)

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

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

◆ __imul__() [1/3]

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

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

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

◆ __imul__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__imul__ ( DQuaternion  q)

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

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

◆ __imul__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__imul__ ( ConstDQuaternionExpression  q)

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

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

◆ __idiv__() [1/3]

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

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

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

◆ __idiv__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__idiv__ ( DQuaternion  q)

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

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

◆ __idiv__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__idiv__ ( ConstDQuaternionExpression  q)

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

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

◆ __itruediv__() [1/3]

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

◆ __itruediv__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__itruediv__ ( DQuaternion  q)
Parameters
q
Returns

◆ __itruediv__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__itruediv__ ( ConstDQuaternionExpression  q)
Parameters
q
Returns