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

A bounded 3x3 matrix holding floating point values of type float. More...

+ Inheritance diagram for CDPL.Math.Matrix3F:

Public Member Functions

None __init__ ()
 Initializes the Matrix3F instance.
 
None __init__ (float v)
 Initializes the Matrix3F instance. More...
 
None __init__ (Matrix3F m)
 Initializes a copy of the Matrix3F instance m. More...
 
None __init__ (ConstFMatrixExpression e)
 Initializes the Matrix3F instance. More...
 
None __init__ (ConstDMatrixExpression e)
 Initializes the Matrix3F instance. More...
 
None __init__ (ConstLMatrixExpression e)
 Initializes the Matrix3F instance. More...
 
None __init__ (ConstULMatrixExpression e)
 Initializes the Matrix3F instance. More...
 
None __init__ (object a)
 Initializes the Matrix3F instance. More...
 
None clear (float v=0.0)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Matrix3F assign (ConstFMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e. More...
 
Matrix3F assign (ConstDMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e. More...
 
Matrix3F assign (ConstLMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e. More...
 
Matrix3F assign (ConstULMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e. More...
 
Matrix3F assign (Matrix3F m)
 Replaces the current state of self with a copy of the state of the Matrix3F instance m. More...
 
None assign (object a)
 Replaces the current state of self with a copy of the state of the object instance a. More...
 
int getSize1 ()
 
int getSize2 ()
 
bool isEmpty ()
 
float getElement (int i, int j)
 
object toArray ()
 
None swap (Matrix3F m)
 
None setElement (int i, int j, float v)
 
float __call__ (int i, int j)
 
float __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (Matrix3F m)
 Returns the result of the comparison operation self == m. More...
 
bool __eq__ (ConstFMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (Matrix3F m)
 Returns the result of the comparison operation self != m. More...
 
bool __ne__ (ConstFMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the Matrix3F instance. More...
 
Matrix3F __pos__ ()
 
ConstFMatrixExpression __neg__ ()
 
ConstFMatrixExpression __add__ (ConstFMatrixExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstFMatrixExpression __sub__ (ConstFMatrixExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstFMatrixExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstFMatrixExpression __mul__ (ConstFMatrixExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstFVectorExpression __mul__ (ConstFVectorExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstFMatrixExpression __div__ (float t)
 Returns the result of the division operation self / t. More...
 
ConstFMatrixExpression __truediv__ (float t)
 
ConstFMatrixExpression __rmul__ (float t)
 
None __setitem__ (tuple ij, float v)
 
Matrix3F __iadd__ (Matrix3F m)
 Performs the in-place addition operation self += m. More...
 
Matrix3F __iadd__ (ConstFMatrixExpression e)
 Performs the in-place addition operation self += e. More...
 
Matrix3F __isub__ (Matrix3F m)
 Performs the in-place subtraction operation self -= m. More...
 
Matrix3F __isub__ (ConstFMatrixExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
Matrix3F __imul__ (float t)
 Performs the in-place multiplication operation self *= t. More...
 
Matrix3F __idiv__ (float t)
 Performs the in-place division operation self /= t. More...
 
Matrix3F __itruediv__ (float t)
 

Properties

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

Detailed Description

A bounded 3x3 matrix holding floating point values of type float.

Constructor & Destructor Documentation

◆ __init__() [1/7]

None CDPL.Math.Matrix3F.__init__ ( float  v)

Initializes the Matrix3F instance.

Parameters
v

◆ __init__() [2/7]

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

Initializes a copy of the Matrix3F instance m.

Parameters
mThe Matrix3F instance to copy.

◆ __init__() [3/7]

None CDPL.Math.Matrix3F.__init__ ( ConstFMatrixExpression  e)

Initializes the Matrix3F instance.

Parameters
e

◆ __init__() [4/7]

None CDPL.Math.Matrix3F.__init__ ( ConstDMatrixExpression  e)

Initializes the Matrix3F instance.

Parameters
e

◆ __init__() [5/7]

None CDPL.Math.Matrix3F.__init__ ( ConstLMatrixExpression  e)

Initializes the Matrix3F instance.

Parameters
e

◆ __init__() [6/7]

None CDPL.Math.Matrix3F.__init__ ( ConstULMatrixExpression  e)

Initializes the Matrix3F instance.

Parameters
e

◆ __init__() [7/7]

None CDPL.Math.Matrix3F.__init__ ( object  a)

Initializes the Matrix3F instance.

Parameters
a

Member Function Documentation

◆ clear()

None CDPL.Math.Matrix3F.clear ( float   v = 0.0)
Parameters
v

◆ getObjectID()

int CDPL.Math.Matrix3F.getObjectID ( )

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

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

Matrix3F CDPL.Math.Matrix3F.assign ( ConstFMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e.

Parameters
eThe ConstFMatrixExpression instance to copy.
Returns
self

◆ assign() [2/6]

Matrix3F CDPL.Math.Matrix3F.assign ( ConstDMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e.

Parameters
eThe ConstDMatrixExpression instance to copy.
Returns
self

◆ assign() [3/6]

Matrix3F CDPL.Math.Matrix3F.assign ( ConstLMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e.

Parameters
eThe ConstLMatrixExpression instance to copy.
Returns
self

◆ assign() [4/6]

Matrix3F CDPL.Math.Matrix3F.assign ( ConstULMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e.

Parameters
eThe ConstULMatrixExpression instance to copy.
Returns
self

◆ assign() [5/6]

Matrix3F CDPL.Math.Matrix3F.assign ( Matrix3F  m)

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

Parameters
mThe Matrix3F instance to copy.
Returns
self

◆ assign() [6/6]

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

Replaces the current state of self with a copy of the state of the object instance a.

Parameters
aThe object instance to copy.
Returns
self

◆ getSize1()

int CDPL.Math.Matrix3F.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.Matrix3F.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.Matrix3F.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.Matrix3F.toArray ( )
Returns

◆ swap()

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

◆ setElement()

None CDPL.Math.Matrix3F.setElement ( int  i,
int  j,
float  v 
)
Parameters
i
j
v

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.Matrix3F.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.Matrix3F.__eq__ ( ConstFMatrixExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.Matrix3F.__ne__ ( ConstFMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.Matrix3F.__str__ ( )

Returns a string representation of the Matrix3F instance.

Returns
The generated string representation.

◆ __pos__()

Matrix3F CDPL.Math.Matrix3F.__pos__ ( )
Returns

◆ __neg__()

ConstFMatrixExpression CDPL.Math.Matrix3F.__neg__ ( )
Returns

◆ __add__()

ConstFMatrixExpression CDPL.Math.Matrix3F.__add__ ( ConstFMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstFMatrixExpression CDPL.Math.Matrix3F.__sub__ ( ConstFMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstFMatrixExpression CDPL.Math.Matrix3F.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstFMatrixExpression CDPL.Math.Matrix3F.__mul__ ( ConstFMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstFVectorExpression CDPL.Math.Matrix3F.__mul__ ( ConstFVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstFMatrixExpression CDPL.Math.Matrix3F.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstFMatrixExpression CDPL.Math.Matrix3F.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstFMatrixExpression CDPL.Math.Matrix3F.__rmul__ ( float  t)
Parameters
t
Returns

◆ __setitem__()

None CDPL.Math.Matrix3F.__setitem__ ( tuple  ij,
float  v 
)
Parameters
ij
v

◆ __iadd__() [1/2]

Matrix3F CDPL.Math.Matrix3F.__iadd__ ( Matrix3F  m)

Performs the in-place addition operation self += m.

Parameters
mSpecifies the second addend.
Returns
The updated Matrix3F instance self.

◆ __iadd__() [2/2]

Matrix3F CDPL.Math.Matrix3F.__iadd__ ( ConstFMatrixExpression  e)

Performs the in-place addition operation self += e.

Parameters
eSpecifies the second addend.
Returns
The updated Matrix3F instance self.

◆ __isub__() [1/2]

Matrix3F CDPL.Math.Matrix3F.__isub__ ( Matrix3F  m)

Performs the in-place subtraction operation self -= m.

Parameters
mSpecifies the subtrahend.
Returns
The updated Matrix3F instance self.

◆ __isub__() [2/2]

Matrix3F CDPL.Math.Matrix3F.__isub__ ( ConstFMatrixExpression  e)

Performs the in-place subtraction operation self -= e.

Parameters
eSpecifies the subtrahend.
Returns
The updated Matrix3F instance self.

◆ __imul__()

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

Performs the in-place multiplication operation self *= t.

Parameters
tSpecifies the multiplier.
Returns
The updated Matrix3F instance self.

◆ __idiv__()

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

Performs the in-place division operation self /= t.

Parameters
tSpecifies the divisor.
Returns
The updated Matrix3F instance self.

◆ __itruediv__()

Matrix3F CDPL.Math.Matrix3F.__itruediv__ ( float  t)
Parameters
t
Returns