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

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

+ Inheritance diagram for CDPL.Math.DQuaternionExpression:

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

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

Member Function Documentation

◆ swap()

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

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

Parameters
eThe quaternion expression to swap with.

◆ assign() [1/6]

DQuaternionExpression CDPL.Math.DQuaternionExpression.assign ( DQuaternionExpression  e)

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

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [2/6]

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

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

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [3/6]

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

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

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [4/6]

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

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

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [5/6]

DQuaternionExpression CDPL.Math.DQuaternionExpression.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.DQuaternionExpression.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.DQuaternionExpression.setC1 ( float  v)

Sets the value of the real component C1 to v.

Parameters
vThe new value of the real component C1.

◆ setC2()

None CDPL.Math.DQuaternionExpression.setC2 ( float  v)

Sets the value of the imaginary component C2 to v.

Parameters
vThe new value of the imaginary component C2.

◆ setC3()

None CDPL.Math.DQuaternionExpression.setC3 ( float  v)

Sets the value of the imaginary component C3 to v.

Parameters
vThe new value of the imaginary component C3.

◆ setC4()

None CDPL.Math.DQuaternionExpression.setC4 ( float  v)

Sets the value of the imaginary component C4 to v.

Parameters
vThe new value of the imaginary component C4.

◆ set()

None CDPL.Math.DQuaternionExpression.set ( float   c1 = 0.0,
float   c2 = 0.0,
float   c3 = 0.0,
float   c4 = 0.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]

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

Adds the scalar t to the real component.

Parameters
tThe scalar addend.
Returns
self.

◆ __iadd__() [2/3]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__iadd__ ( DQuaternionExpression  e)

Adds the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __iadd__() [3/3]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__iadd__ ( ConstDQuaternionExpression  e)

Adds the quaternion expression e to this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __isub__() [1/3]

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

Subtracts the scalar t from the real component.

Parameters
tThe scalar subtrahend.
Returns
self.

◆ __isub__() [2/3]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__isub__ ( DQuaternionExpression  e)

Subtracts the quaternion expression e from this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __isub__() [3/3]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__isub__ ( ConstDQuaternionExpression  e)

Subtracts the quaternion expression e from this expression.

Parameters
eThe source quaternion expression.
Returns
self.

◆ __imul__() [1/3]

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

Multiplies every component by the scalar t.

Parameters
tThe scalar multiplier.
Returns
self.

◆ __imul__() [2/3]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__imul__ ( DQuaternionExpression  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]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__imul__ ( ConstDQuaternionExpression  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]

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

Divides every component by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __idiv__() [2/3]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__idiv__ ( DQuaternionExpression  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]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__idiv__ ( ConstDQuaternionExpression  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]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__itruediv__ ( float  t)

Divides every component by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __itruediv__() [2/3]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__itruediv__ ( DQuaternionExpression  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]

DQuaternionExpression CDPL.Math.DQuaternionExpression.__itruediv__ ( ConstDQuaternionExpression  e)

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

Parameters
eThe right-hand quaternion expression.
Returns
self.