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

Public Member Functions

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

Properties

 objectID = property(getObjectID)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the ULRealQuaternion instance q.

Parameters
qThe ULRealQuaternion instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ULRealQuaternion.__init__ ( int  r)

Initializes the ULRealQuaternion instance.

Parameters
r

Member Function Documentation

◆ set()

ULRealQuaternion CDPL.Math.ULRealQuaternion.set ( int   r = 0)
Parameters
r
Returns

◆ getObjectID()

int CDPL.Math.ULRealQuaternion.getObjectID ( )

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

Different Python ULRealQuaternion 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 ULRealQuaternion 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()

int CDPL.Math.ULRealQuaternion.getC1 ( )
Returns

◆ getC2()

int CDPL.Math.ULRealQuaternion.getC2 ( )
Returns

◆ getC3()

int CDPL.Math.ULRealQuaternion.getC3 ( )
Returns

◆ getC4()

int CDPL.Math.ULRealQuaternion.getC4 ( )
Returns

◆ toArray()

object CDPL.Math.ULRealQuaternion.toArray ( )
Returns

◆ assign()

ULRealQuaternion CDPL.Math.ULRealQuaternion.assign ( ULRealQuaternion  q)

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

Parameters
qThe ULRealQuaternion instance to copy.
Returns
self

◆ swap()

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

◆ __iadd__() [1/2]

ULRealQuaternion CDPL.Math.ULRealQuaternion.__iadd__ ( int  t)

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

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

◆ __iadd__() [2/2]

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

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

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

◆ __isub__() [1/2]

ULRealQuaternion CDPL.Math.ULRealQuaternion.__isub__ ( int  t)

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

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

◆ __isub__() [2/2]

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

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

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

◆ __imul__() [1/2]

ULRealQuaternion CDPL.Math.ULRealQuaternion.__imul__ ( int  t)

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

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

◆ __imul__() [2/2]

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

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

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

◆ __idiv__() [1/2]

ULRealQuaternion CDPL.Math.ULRealQuaternion.__idiv__ ( int  t)

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

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

◆ __idiv__() [2/2]

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

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

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

◆ __itruediv__() [1/2]

ULRealQuaternion CDPL.Math.ULRealQuaternion.__itruediv__ ( int  t)
Parameters
t
Returns

◆ __itruediv__() [2/2]

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

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.ULRealQuaternion.__eq__ ( ConstULQuaternionExpression  q)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.ULRealQuaternion.__ne__ ( ConstULQuaternionExpression  q)

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

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

◆ __str__()

str CDPL.Math.ULRealQuaternion.__str__ ( )

Returns a string representation of the ULRealQuaternion instance.

Returns
The generated string representation.

◆ __pos__()

ULRealQuaternion CDPL.Math.ULRealQuaternion.__pos__ ( )
Returns

◆ __neg__()

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__neg__ ( )
Returns

◆ __add__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__add__ ( int  t)

Returns the result of the addition operation self + t.

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

◆ __add__() [2/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__add__ ( ConstULQuaternionExpression  e)

Returns the result of the addition operation self + e.

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

◆ __radd__()

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__radd__ ( int  t)
Parameters
t
Returns

◆ __sub__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__sub__ ( int  t)

Returns the result of the subtraction operation self - t.

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

◆ __sub__() [2/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__sub__ ( ConstULQuaternionExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __rsub__()

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__rsub__ ( int  t)
Parameters
t
Returns

◆ __mul__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__mul__ ( ConstULQuaternionExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __rmul__()

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__rmul__ ( int  t)
Parameters
t
Returns

◆ __div__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __div__() [2/2]

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__div__ ( ConstULQuaternionExpression  e)

Returns the result of the division operation self / e.

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

◆ __truediv__()

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rdiv__()

ConstULQuaternionExpression CDPL.Math.ULRealQuaternion.__rdiv__ ( int  t)
Parameters
t
Returns