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

Quaternion expression that exposes a 4-element vector as a quaternion (component indices 0-3 map to C1-C4). More...

+ Inheritance diagram for CDPL.Math.ULVectorQuaternionAdapter:

Public Member Functions

None __init__ (ULVectorQuaternionAdapter va)
 Contructs a copy of the ULVectorQuaternionAdapter instance va. More...
 
None __init__ (ULVectorExpression v)
 Constructs the adapter wrapping the 4-element vector v. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
ULVectorQuaternionAdapter assign (ConstFQuaternionExpression e)
 Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...
 
ULVectorQuaternionAdapter assign (ConstDQuaternionExpression e)
 Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...
 
ULVectorQuaternionAdapter assign (ConstLQuaternionExpression e)
 Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...
 
ULVectorQuaternionAdapter assign (ConstULQuaternionExpression e)
 Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...
 
None assign (object a)
 Assigns the contents of the numpy.ndarray object a to this view. More...
 
ULVectorQuaternionAdapter assign (ULVectorQuaternionAdapter va)
 Copies the components of va into this view (writing through to the wrapped vector). 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 ULVectorQuaternionAdapter instance into a corresponding numpy.ndarray object. More...
 
None swap (ULVectorQuaternionAdapter va)
 Swaps the components of this view with those of va. 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)
 Assigns the four supplied component values to this view (writing through to the wrapped vector). More...
 
ULVectorExpression getData ()
 Returns the wrapped vector. More...
 
bool __eq__ (ULVectorQuaternionAdapter va)
 Returns the result of the comparison operation self == va. More...
 
bool __eq__ (ConstULQuaternionExpression q)
 Returns the result of the comparison operation self == q. More...
 
bool __ne__ (ULVectorQuaternionAdapter va)
 Returns the result of the comparison operation self != va. More...
 
bool __ne__ (ConstULQuaternionExpression q)
 Returns the result of the comparison operation self != q. More...
 
str __str__ ()
 Returns a string representation of the ULVectorQuaternionAdapter instance. More...
 
ULVectorQuaternionAdapter __pos__ ()
 Returns self. More...
 
ConstULQuaternionExpression __neg__ ()
 Returns the result of the operation self * -1. More...
 
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)
 Returns the result of the addition operation t + self. More...
 
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)
 Returns the result of the subtraction operation t - self. More...
 
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)
 Returns the result of the multiplication operation t * self. More...
 
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)
 Returns the result of the true division operation self / t. More...
 
ConstULQuaternionExpression __rdiv__ (int t)
 Returns the result of the division operation t // self. More...
 
ULVectorQuaternionAdapter __iadd__ (int t)
 Adds the scalar t to component C1 of this view. More...
 
ULVectorQuaternionAdapter __iadd__ (ULVectorQuaternionAdapter va)
 Adds the vector adapter va componentwise to this view. More...
 
ULVectorQuaternionAdapter __iadd__ (ConstULQuaternionExpression e)
 Adds the quaternion expression e componentwise to this view. More...
 
ULVectorQuaternionAdapter __isub__ (int t)
 Subtracts the scalar t from component C1 of this view. More...
 
ULVectorQuaternionAdapter __isub__ (ULVectorQuaternionAdapter va)
 Subtracts the vector adapter va componentwise from this view. More...
 
ULVectorQuaternionAdapter __isub__ (ConstULQuaternionExpression e)
 Subtracts the quaternion expression e componentwise from this view. More...
 
ULVectorQuaternionAdapter __imul__ (int t)
 Multiplies every component of this view by the scalar t. More...
 
ULVectorQuaternionAdapter __imul__ (ULVectorQuaternionAdapter va)
 Multiplies this view by the vector adapter va (Hamilton-product semantics). More...
 
ULVectorQuaternionAdapter __imul__ (ConstULQuaternionExpression e)
 Multiplies this view by the quaternion expression e (Hamilton-product semantics). More...
 
ULVectorQuaternionAdapter __idiv__ (int t)
 Divides every component of this view by the scalar t. More...
 
ULVectorQuaternionAdapter __idiv__ (ULVectorQuaternionAdapter va)
 Divides this view by the vector adapter va (Hamilton-quotient semantics). More...
 
ULVectorQuaternionAdapter __idiv__ (ConstULQuaternionExpression e)
 Divides this view by the quaternion expression e (Hamilton-quotient semantics). More...
 
ULVectorQuaternionAdapter __itruediv__ (int t)
 Divides every component of this view by the scalar t. More...
 
ULVectorQuaternionAdapter __itruediv__ (ULVectorQuaternionAdapter va)
 Divides this view by the vector adapter va (Hamilton-quotient semantics). More...
 
ULVectorQuaternionAdapter __itruediv__ (ConstULQuaternionExpression e)
 Divides this view by the quaternion expression e (Hamilton-quotient semantics). More...
 

Properties

 objectID = property(getObjectID)
 
 data = property(getData)
 

Detailed Description

Quaternion expression that exposes a 4-element vector as a quaternion (component indices 0-3 map to C1-C4).

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.ULVectorQuaternionAdapter.__init__ ( ULVectorQuaternionAdapter  va)

Contructs a copy of the ULVectorQuaternionAdapter instance va.

Parameters
vaThe ULVectorQuaternionAdapter instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ULVectorQuaternionAdapter.__init__ ( ULVectorExpression  v)

Constructs the adapter wrapping the 4-element vector v.

Parameters
vThe 4-element vector to be viewed as a quaternion.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ULVectorQuaternionAdapter.getObjectID ( )

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

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

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [2/6]

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [3/6]

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [4/6]

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters
eThe source quaternion expression.
Returns
self.

◆ assign() [5/6]

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

Assigns the contents of the numpy.ndarray object a to this view.

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

◆ assign() [6/6]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.assign ( ULVectorQuaternionAdapter  va)

Copies the components of va into this view (writing through to the wrapped vector).

Parameters
vaThe source adapter.
Returns
self.

◆ getC1()

int CDPL.Math.ULVectorQuaternionAdapter.getC1 ( )

Returns the real component C1.

Returns
The value of C1.

◆ getC2()

int CDPL.Math.ULVectorQuaternionAdapter.getC2 ( )

Returns the imaginary component C2.

Returns
The value of C2.

◆ getC3()

int CDPL.Math.ULVectorQuaternionAdapter.getC3 ( )

Returns the imaginary component C3.

Returns
The value of C3.

◆ getC4()

int CDPL.Math.ULVectorQuaternionAdapter.getC4 ( )

Returns the imaginary component C4.

Returns
The value of C4.

◆ toArray()

object CDPL.Math.ULVectorQuaternionAdapter.toArray ( )

Converts the ULVectorQuaternionAdapter instance into a corresponding numpy.ndarray object.

Returns
The generated numpy.ndarray object.
See also
[NUMPY]

◆ swap()

None CDPL.Math.ULVectorQuaternionAdapter.swap ( ULVectorQuaternionAdapter  va)

Swaps the components of this view with those of va.

Parameters
vaThe adapter to swap with.

◆ setC1()

None CDPL.Math.ULVectorQuaternionAdapter.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.ULVectorQuaternionAdapter.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.ULVectorQuaternionAdapter.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.ULVectorQuaternionAdapter.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.ULVectorQuaternionAdapter.set ( int   c1 = 0,
int   c2 = 0,
int   c3 = 0,
int   c4 = 0 
)

Assigns the four supplied component values to this view (writing through to the wrapped vector).

Parameters
c1The C1 component value.
c2The C2 component value.
c3The C3 component value.
c4The C4 component value.

◆ getData()

ULVectorExpression CDPL.Math.ULVectorQuaternionAdapter.getData ( )

Returns the wrapped vector.

Returns
The wrapped vector closure.

◆ __eq__() [1/2]

bool CDPL.Math.ULVectorQuaternionAdapter.__eq__ ( ULVectorQuaternionAdapter  va)

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

Parameters
vaThe ULVectorQuaternionAdapter instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

bool CDPL.Math.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__ne__ ( ULVectorQuaternionAdapter  va)

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

Parameters
vaThe ULVectorQuaternionAdapter instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

bool CDPL.Math.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the ULVectorQuaternionAdapter instance.

Returns
The generated string representation.

◆ __pos__()

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__pos__ ( )

Returns self.

Returns
self.

◆ __neg__()

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__neg__ ( )

Returns the result of the operation self * -1.

Returns
A ConstULQuaternionExpression instance holding the result of the element negation.

◆ __add__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__radd__ ( int  t)

Returns the result of the addition operation t + self.

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

◆ __sub__() [1/2]

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

Returns the result of the subtraction operation self - t.

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

◆ __sub__() [2/2]

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

Returns the result of the subtraction operation self - e.

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

◆ __rsub__()

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__rsub__ ( int  t)

Returns the result of the subtraction operation t - self.

Parameters
tSpecifies the minuend.
Returns
A ULVectorQuaternionAdapter instance holding the result of the subtraction.

◆ __mul__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__rmul__ ( int  t)

Returns the result of the multiplication operation t * self.

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

◆ __div__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__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.ULVectorQuaternionAdapter.__truediv__ ( int  t)

Returns the result of the true division operation self / t.

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

◆ __rdiv__()

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__rdiv__ ( int  t)

Returns the result of the division operation t // self.

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

◆ __iadd__() [1/3]

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

Adds the scalar t to component C1 of this view.

Parameters
tThe scalar summand.
Returns
self.

◆ __iadd__() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__iadd__ ( ULVectorQuaternionAdapter  va)

Adds the vector adapter va componentwise to this view.

Parameters
vaThe vector adapter to add.
Returns
self.

◆ __iadd__() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__iadd__ ( ConstULQuaternionExpression  e)

Adds the quaternion expression e componentwise to this view.

Parameters
eThe quaternion expression to add.
Returns
self.

◆ __isub__() [1/3]

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

Subtracts the scalar t from component C1 of this view.

Parameters
tThe scalar subtrahend.
Returns
self.

◆ __isub__() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__isub__ ( ULVectorQuaternionAdapter  va)

Subtracts the vector adapter va componentwise from this view.

Parameters
vaThe vector adapter to subtract.
Returns
self.

◆ __isub__() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__isub__ ( ConstULQuaternionExpression  e)

Subtracts the quaternion expression e componentwise from this view.

Parameters
eThe quaternion expression to subtract.
Returns
self.

◆ __imul__() [1/3]

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

Multiplies every component of this view by the scalar t.

Parameters
tThe scalar multiplier.
Returns
self.

◆ __imul__() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__imul__ ( ULVectorQuaternionAdapter  va)

Multiplies this view by the vector adapter va (Hamilton-product semantics).

Parameters
vaThe vector adapter to multiply by.
Returns
self.

◆ __imul__() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__imul__ ( ConstULQuaternionExpression  e)

Multiplies this view by the quaternion expression e (Hamilton-product semantics).

Parameters
eThe quaternion expression to multiply by.
Returns
self.

◆ __idiv__() [1/3]

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

Divides every component of this view by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __idiv__() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__idiv__ ( ULVectorQuaternionAdapter  va)

Divides this view by the vector adapter va (Hamilton-quotient semantics).

Parameters
vaThe vector adapter to divide by.
Returns
self.

◆ __idiv__() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__idiv__ ( ConstULQuaternionExpression  e)

Divides this view by the quaternion expression e (Hamilton-quotient semantics).

Parameters
eThe quaternion expression to divide by.
Returns
self.

◆ __itruediv__() [1/3]

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

Divides every component of this view by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __itruediv__() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__itruediv__ ( ULVectorQuaternionAdapter  va)

Divides this view by the vector adapter va (Hamilton-quotient semantics).

Parameters
vaThe vector adapter to divide by.
Returns
self.

◆ __itruediv__() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__itruediv__ ( ConstULQuaternionExpression  e)

Divides this view by the quaternion expression e (Hamilton-quotient semantics).

Parameters
eThe quaternion expression to divide by.
Returns
self.