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

Public Member Functions

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

Properties

 objectID = property(getObjectID)
 

Constructor & Destructor Documentation

◆ __init__() [1/7]

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

Initializes a copy of the LQuaternion instance q.

Parameters
qThe LQuaternion instance to copy.

◆ __init__() [2/7]

None CDPL.Math.LQuaternion.__init__ ( int  c1,
int   c2 = 0,
int   c3 = 0,
int   c4 = 0 
)

Initializes the LQuaternion instance.

Parameters
c1
c2
c3
c4

◆ __init__() [3/7]

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

Initializes the LQuaternion instance.

Parameters
e

◆ __init__() [4/7]

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

Initializes the LQuaternion instance.

Parameters
e

◆ __init__() [5/7]

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

Initializes the LQuaternion instance.

Parameters
e

◆ __init__() [6/7]

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

Initializes the LQuaternion instance.

Parameters
e

◆ __init__() [7/7]

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

Initializes the LQuaternion instance.

Parameters
a

Member Function Documentation

◆ getObjectID()

int CDPL.Math.LQuaternion.getObjectID ( )

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

Different Python LQuaternion 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 LQuaternion 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]

LQuaternion CDPL.Math.LQuaternion.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]

LQuaternion CDPL.Math.LQuaternion.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]

LQuaternion CDPL.Math.LQuaternion.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]

LQuaternion CDPL.Math.LQuaternion.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]

LQuaternion CDPL.Math.LQuaternion.assign ( LQuaternion  q)

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

Parameters
qThe LQuaternion instance to copy.
Returns
self

◆ assign() [6/6]

None CDPL.Math.LQuaternion.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()

int CDPL.Math.LQuaternion.getC1 ( )
Returns

◆ getC2()

int CDPL.Math.LQuaternion.getC2 ( )
Returns

◆ getC3()

int CDPL.Math.LQuaternion.getC3 ( )
Returns

◆ getC4()

int CDPL.Math.LQuaternion.getC4 ( )
Returns

◆ toArray()

object CDPL.Math.LQuaternion.toArray ( )
Returns

◆ swap()

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

◆ setC1()

None CDPL.Math.LQuaternion.setC1 ( int  v)
Parameters
v

◆ setC2()

None CDPL.Math.LQuaternion.setC2 ( int  v)
Parameters
v

◆ setC3()

None CDPL.Math.LQuaternion.setC3 ( int  v)
Parameters
v

◆ setC4()

None CDPL.Math.LQuaternion.setC4 ( int  v)
Parameters
v

◆ set()

None CDPL.Math.LQuaternion.set ( int   c1 = 0,
int   c2 = 0,
int   c3 = 0,
int   c4 = 0 
)
Parameters
c1
c2
c3
c4

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.LQuaternion.__eq__ ( ConstLQuaternionExpression  q)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.LQuaternion.__ne__ ( ConstLQuaternionExpression  q)

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

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

◆ __str__()

str CDPL.Math.LQuaternion.__str__ ( )

Returns a string representation of the LQuaternion instance.

Returns
The generated string representation.

◆ __pos__()

LQuaternion CDPL.Math.LQuaternion.__pos__ ( )
Returns

◆ __neg__()

ConstLQuaternionExpression CDPL.Math.LQuaternion.__neg__ ( )
Returns

◆ __add__() [1/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__add__ ( int  t)

Returns the result of the addition operation self + t.

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

◆ __add__() [2/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__add__ ( ConstLQuaternionExpression  e)

Returns the result of the addition operation self + e.

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

◆ __radd__()

ConstLQuaternionExpression CDPL.Math.LQuaternion.__radd__ ( int  t)
Parameters
t
Returns

◆ __sub__() [1/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__sub__ ( int  t)

Returns the result of the subtraction operation self - t.

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

◆ __sub__() [2/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__sub__ ( ConstLQuaternionExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __rsub__()

ConstLQuaternionExpression CDPL.Math.LQuaternion.__rsub__ ( int  t)
Parameters
t
Returns

◆ __mul__() [1/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__mul__ ( ConstLQuaternionExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __rmul__()

ConstLQuaternionExpression CDPL.Math.LQuaternion.__rmul__ ( int  t)
Parameters
t
Returns

◆ __div__() [1/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __div__() [2/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__div__ ( ConstLQuaternionExpression  e)

Returns the result of the division operation self / e.

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

◆ __truediv__()

ConstLQuaternionExpression CDPL.Math.LQuaternion.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rdiv__()

ConstLQuaternionExpression CDPL.Math.LQuaternion.__rdiv__ ( int  t)
Parameters
t
Returns

◆ __iadd__() [1/3]

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

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

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

◆ __iadd__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__iadd__ ( LQuaternion  q)

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

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

◆ __iadd__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__iadd__ ( ConstLQuaternionExpression  q)

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

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

◆ __isub__() [1/3]

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

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

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

◆ __isub__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__isub__ ( LQuaternion  q)

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

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

◆ __isub__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__isub__ ( ConstLQuaternionExpression  q)

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

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

◆ __imul__() [1/3]

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

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

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

◆ __imul__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__imul__ ( LQuaternion  q)

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

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

◆ __imul__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__imul__ ( ConstLQuaternionExpression  q)

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

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

◆ __idiv__() [1/3]

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

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

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

◆ __idiv__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__idiv__ ( LQuaternion  q)

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

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

◆ __idiv__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__idiv__ ( ConstLQuaternionExpression  q)

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

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

◆ __itruediv__() [1/3]

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

◆ __itruediv__() [2/3]

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

◆ __itruediv__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__itruediv__ ( ConstLQuaternionExpression  q)
Parameters
q
Returns