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

Public Member Functions

None __init__ (DRotationMatrix m)
 Initializes a copy of the DRotationMatrix instance m. More...
 
None __init__ (int n, float w, float ux, float uy, float uz)
 Initializes the DRotationMatrix instance. More...
 
None set (float w, float ux, float uy, float uz)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getSize1 ()
 
int getSize2 ()
 
bool isEmpty ()
 
float getElement (int i, int j)
 
object toArray ()
 
DRotationMatrix assign (DRotationMatrix m)
 Replaces the current state of self with a copy of the state of the DRotationMatrix instance m. More...
 
None swap (DRotationMatrix m)
 
float __call__ (int i, int j)
 
float __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (DRotationMatrix m)
 Returns the result of the comparison operation self == m. More...
 
bool __eq__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (DRotationMatrix m)
 Returns the result of the comparison operation self != m. More...
 
bool __ne__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the DRotationMatrix instance. More...
 
DRotationMatrix __pos__ ()
 
ConstDMatrixExpression __neg__ ()
 
ConstDMatrixExpression __add__ (ConstDMatrixExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstDMatrixExpression __sub__ (ConstDMatrixExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstDMatrixExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstDMatrixExpression __mul__ (ConstDMatrixExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstDVectorExpression __mul__ (ConstDVectorExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstDMatrixExpression __div__ (float t)
 Returns the result of the division operation self / t. More...
 
ConstDMatrixExpression __truediv__ (float t)
 
ConstDMatrixExpression __rmul__ (float t)
 

Properties

 objectID = property(getObjectID)
 
 size1 = property(getSize1)
 
 size2 = property(getSize2)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.DRotationMatrix.__init__ ( DRotationMatrix  m)

Initializes a copy of the DRotationMatrix instance m.

Parameters
mThe DRotationMatrix instance to copy.

◆ __init__() [2/2]

None CDPL.Math.DRotationMatrix.__init__ ( int  n,
float  w,
float  ux,
float  uy,
float  uz 
)

Initializes the DRotationMatrix instance.

Parameters
n
w
ux
uy
uz

Member Function Documentation

◆ set()

None CDPL.Math.DRotationMatrix.set ( float  w,
float  ux,
float  uy,
float  uz 
)
Parameters
w
ux
uy
uz

◆ getObjectID()

int CDPL.Math.DRotationMatrix.getObjectID ( )

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

Different Python DRotationMatrix 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 DRotationMatrix 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.

◆ getSize1()

int CDPL.Math.DRotationMatrix.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.DRotationMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.DRotationMatrix.isEmpty ( )
Returns

◆ getElement()

float CDPL.Math.DRotationMatrix.getElement ( int  i,
int  j 
)
Parameters
i
j
Returns

◆ toArray()

object CDPL.Math.DRotationMatrix.toArray ( )
Returns

◆ assign()

DRotationMatrix CDPL.Math.DRotationMatrix.assign ( DRotationMatrix  m)

Replaces the current state of self with a copy of the state of the DRotationMatrix instance m.

Parameters
mThe DRotationMatrix instance to copy.
Returns
self

◆ swap()

None CDPL.Math.DRotationMatrix.swap ( DRotationMatrix  m)
Parameters
m

◆ __call__()

float CDPL.Math.DRotationMatrix.__call__ ( int  i,
int  j 
)
Parameters
i
j
Returns

◆ __getitem__()

float CDPL.Math.DRotationMatrix.__getitem__ ( tuple  ij)
Parameters
ij
Returns

◆ __len__()

int CDPL.Math.DRotationMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

bool CDPL.Math.DRotationMatrix.__eq__ ( DRotationMatrix  m)

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

Parameters
mThe DRotationMatrix instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

bool CDPL.Math.DRotationMatrix.__eq__ ( ConstDMatrixExpression  e)

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

Parameters
eThe ConstDMatrixExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [1/2]

bool CDPL.Math.DRotationMatrix.__ne__ ( DRotationMatrix  m)

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

Parameters
mThe DRotationMatrix instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

bool CDPL.Math.DRotationMatrix.__ne__ ( ConstDMatrixExpression  e)

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

Parameters
eThe ConstDMatrixExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __str__()

str CDPL.Math.DRotationMatrix.__str__ ( )

Returns a string representation of the DRotationMatrix instance.

Returns
The generated string representation.

◆ __pos__()

DRotationMatrix CDPL.Math.DRotationMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__neg__ ( )
Returns

◆ __add__()

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__add__ ( ConstDMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__sub__ ( ConstDMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__mul__ ( ConstDMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstDVectorExpression CDPL.Math.DRotationMatrix.__mul__ ( ConstDVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstDMatrixExpression CDPL.Math.DRotationMatrix.__rmul__ ( float  t)
Parameters
t
Returns