Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | List of all members
CDPL.Math.LQuaternionExpression Class Reference

Represents the outcome of mathematical expressions/operations that result in a quaternion. More...

+ Inheritance diagram for CDPL.Math.LQuaternionExpression:

Public Member Functions

None swap (LQuaternionExpression e)
 Swaps the four components of this quaternion expression with those of e. More...
 
LQuaternionExpression assign (LQuaternionExpression e)
 Assigns the contents of the quaternion expression e to this expression. More...
 
LQuaternionExpression assign (ConstFQuaternionExpression e)
 Assigns the contents of the quaternion expression e to this expression. More...
 
LQuaternionExpression assign (ConstDQuaternionExpression e)
 Assigns the contents of the quaternion expression e to this expression. More...
 
LQuaternionExpression assign (ConstLQuaternionExpression e)
 Assigns the contents of the quaternion expression e to this expression. More...
 
LQuaternionExpression assign (ConstULQuaternionExpression e)
 Assigns the contents of the quaternion expression e to this expression. More...
 
None assign (object a)
 Assigns the contents of the numpy.ndarray object a to this quaternion expression. More...
 
None setC1 (int v)
 Sets the value of the real component C1 to v. More...
 
None setC2 (int v)
 Sets the value of the imaginary component C2 to v. More...
 
None setC3 (int v)
 Sets the value of the imaginary component C3 to v. More...
 
None setC4 (int v)
 Sets the value of the imaginary component C4 to v. More...
 
None set (int c1=0, int c2=0, int c3=0, int c4=0)
 Sets the four quaternion components to the supplied values. More...
 
LQuaternionExpression __iadd__ (int t)
 Adds the scalar t to the real component. More...
 
LQuaternionExpression __iadd__ (LQuaternionExpression e)
 Adds the quaternion expression e to this expression. More...
 
LQuaternionExpression __iadd__ (ConstLQuaternionExpression e)
 Adds the quaternion expression e to this expression. More...
 
LQuaternionExpression __isub__ (int t)
 Subtracts the scalar t from the real component. More...
 
LQuaternionExpression __isub__ (LQuaternionExpression e)
 Subtracts the quaternion expression e from this expression. More...
 
LQuaternionExpression __isub__ (ConstLQuaternionExpression e)
 Subtracts the quaternion expression e from this expression. More...
 
LQuaternionExpression __imul__ (int t)
 Multiplies every component by the scalar t. More...
 
LQuaternionExpression __imul__ (LQuaternionExpression e)
 Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary). More...
 
LQuaternionExpression __imul__ (ConstLQuaternionExpression e)
 Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary). More...
 
LQuaternionExpression __idiv__ (int t)
 Divides every component by the scalar t. More...
 
LQuaternionExpression __idiv__ (LQuaternionExpression e)
 Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
 
LQuaternionExpression __idiv__ (ConstLQuaternionExpression e)
 Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
 
LQuaternionExpression __itruediv__ (int t)
 Divides every component by the scalar t. More...
 
LQuaternionExpression __itruediv__ (LQuaternionExpression e)
 Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
 
LQuaternionExpression __itruediv__ (ConstLQuaternionExpression e)
 Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
 
- Public Member Functions inherited from CDPL.Math.ConstLQuaternionExpression
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getC1 ()
 Returns the real component C1. More...
 
int getC2 ()
 Returns the imaginary component C2. More...
 
int getC3 ()
 Returns the imaginary component C3. More...
 
int getC4 ()
 Returns the imaginary component C4. More...
 
object toArray ()
 Converts the ConstLQuaternionExpression instance into a corresponding numpy.ndarray object. More...
 
bool __eq__ (ConstLQuaternionExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstLQuaternionExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the ConstLQuaternionExpression instance. More...
 
ConstLQuaternionExpression __pos__ ()
 Returns self. More...
 
ConstLQuaternionExpression __neg__ ()
 Returns the result of the operation self * -1. More...
 
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)
 Returns the result of the addition operation t + self. More...
 
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)
 Returns the result of the subtraction operation t - self. More...
 
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)
 Returns the result of the multiplication operation t * self. More...
 
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)
 Returns the result of the true division operation self / t. More...
 
ConstLQuaternionExpression __rdiv__ (int t)
 Returns the result of the division operation t // self. More...
 

Additional Inherited Members

- Properties inherited from CDPL.Math.ConstLQuaternionExpression
 objectID = property(getObjectID)
 

Detailed Description

Represents the outcome of mathematical expressions/operations that result in a quaternion.

Member Function Documentation

◆ swap()

None CDPL.Math.LQuaternionExpression.swap ( LQuaternionExpression  e)

Swaps the four components of this quaternion expression with those of e.

Parameters
eThe quaternion expression to swap with.

◆ assign() [1/6]

LQuaternionExpression CDPL.Math.LQuaternionExpression.assign ( LQuaternionExpression  e)

Assigns the contents of the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [2/6]

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

Assigns the contents of the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [3/6]

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

Assigns the contents of the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [4/6]

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

Assigns the contents of the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [5/6]

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

Assigns the contents of the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [6/6]

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

Assigns the contents of the numpy.ndarray object a to this quaternion expression.

Parameters
aThe numpy.ndarray object.
See also
[NUMPY]

◆ setC1()

None CDPL.Math.LQuaternionExpression.setC1 ( int  v)

Sets the value of the real component C1 to v.

Parameters
vThe new value of the real component C1.

◆ setC2()

None CDPL.Math.LQuaternionExpression.setC2 ( int  v)

Sets the value of the imaginary component C2 to v.

Parameters
vThe new value of the imaginary component C2.

◆ setC3()

None CDPL.Math.LQuaternionExpression.setC3 ( int  v)

Sets the value of the imaginary component C3 to v.

Parameters
vThe new value of the imaginary component C3.

◆ setC4()

None CDPL.Math.LQuaternionExpression.setC4 ( int  v)

Sets the value of the imaginary component C4 to v.

Parameters
vThe new value of the imaginary component C4.

◆ set()

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

Sets the four quaternion components to the supplied values.

Parameters
c1The new real component.
c2The new first imaginary component.
c3The new second imaginary component.
c4The new third imaginary component.

◆ __iadd__() [1/3]

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

Adds the scalar t to the real component.

Parameters
tThe scalar addend.
Returns
self.

◆ __iadd__() [2/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__iadd__ ( LQuaternionExpression  e)

Adds the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __iadd__() [3/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__iadd__ ( ConstLQuaternionExpression  e)

Adds the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __isub__() [1/3]

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

Subtracts the scalar t from the real component.

Parameters
tThe scalar subtrahend.
Returns
self.

◆ __isub__() [2/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__isub__ ( LQuaternionExpression  e)

Subtracts the quaternion expression e from this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __isub__() [3/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__isub__ ( ConstLQuaternionExpression  e)

Subtracts the quaternion expression e from this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __imul__() [1/3]

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

Multiplies every component by the scalar t.

Parameters
tThe scalar multiplier.
Returns
self.

◆ __imul__() [2/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__imul__ ( LQuaternionExpression  e)

Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary).

Parameters
eThe right-hand quaternion expression.
Returns
self.

◆ __imul__() [3/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__imul__ ( ConstLQuaternionExpression  e)

Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary).

Parameters
eThe right-hand quaternion expression.
Returns
self.

◆ __idiv__() [1/3]

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

Divides every component by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __idiv__() [2/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__idiv__ ( LQuaternionExpression  e)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters
eThe right-hand quaternion expression.
Returns
self.

◆ __idiv__() [3/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__idiv__ ( ConstLQuaternionExpression  e)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters
eThe right-hand quaternion expression.
Returns
self.

◆ __itruediv__() [1/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__itruediv__ ( int  t)

Divides every component by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __itruediv__() [2/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__itruediv__ ( LQuaternionExpression  e)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters
eThe right-hand quaternion expression.
Returns
self.

◆ __itruediv__() [3/3]

LQuaternionExpression CDPL.Math.LQuaternionExpression.__itruediv__ ( ConstLQuaternionExpression  e)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters
eThe right-hand quaternion expression.
Returns
self.