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

Public Member Functions

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

Properties

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the LTranslationMatrix instance m.

Parameters
mThe LTranslationMatrix instance to copy.

◆ __init__() [2/2]

None CDPL.Math.LTranslationMatrix.__init__ ( int  n,
int   tx = 0,
int   ty = 0,
int   tz = 0 
)

Initializes the LTranslationMatrix instance.

Parameters
n
tx
ty
tz

Member Function Documentation

◆ set()

None CDPL.Math.LTranslationMatrix.set ( int   tx = 0,
int   ty = 0,
int   tz = 0 
)
Parameters
tx
ty
tz

◆ getObjectID()

int CDPL.Math.LTranslationMatrix.getObjectID ( )

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

Different Python LTranslationMatrix 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 LTranslationMatrix 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.LTranslationMatrix.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.LTranslationMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.LTranslationMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.LTranslationMatrix.toArray ( )
Returns

◆ assign()

LTranslationMatrix CDPL.Math.LTranslationMatrix.assign ( LTranslationMatrix  m)

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

Parameters
mThe LTranslationMatrix instance to copy.
Returns
self

◆ swap()

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

◆ __call__()

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

◆ __getitem__()

int CDPL.Math.LTranslationMatrix.__getitem__ ( tuple  ij)
Parameters
ij
Returns

◆ __len__()

int CDPL.Math.LTranslationMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.LTranslationMatrix.__eq__ ( ConstLMatrixExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.LTranslationMatrix.__ne__ ( ConstLMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.LTranslationMatrix.__str__ ( )

Returns a string representation of the LTranslationMatrix instance.

Returns
The generated string representation.

◆ __pos__()

LTranslationMatrix CDPL.Math.LTranslationMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__neg__ ( )
Returns

◆ __add__()

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__add__ ( ConstLMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__sub__ ( ConstLMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__mul__ ( ConstLMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstLVectorExpression CDPL.Math.LTranslationMatrix.__mul__ ( ConstLVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

ConstLMatrixExpression CDPL.Math.LTranslationMatrix.__rmul__ ( int  t)
Parameters
t
Returns