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

A bounded 3x3 matrix holding unsigned integers of type unsigned long. More...

+ Inheritance diagram for CDPL.Math.Matrix3UL:

Public Member Functions

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

Properties

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

Detailed Description

A bounded 3x3 matrix holding unsigned integers of type unsigned long.

Constructor & Destructor Documentation

◆ __init__() [1/7]

None CDPL.Math.Matrix3UL.__init__ ( int  v)

Initializes the Matrix3UL instance.

Parameters
v

◆ __init__() [2/7]

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

Initializes a copy of the Matrix3UL instance m.

Parameters
mThe Matrix3UL instance to copy.

◆ __init__() [3/7]

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

Initializes the Matrix3UL instance.

Parameters
e

◆ __init__() [4/7]

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

Initializes the Matrix3UL instance.

Parameters
e

◆ __init__() [5/7]

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

Initializes the Matrix3UL instance.

Parameters
e

◆ __init__() [6/7]

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

Initializes the Matrix3UL instance.

Parameters
e

◆ __init__() [7/7]

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

Initializes the Matrix3UL instance.

Parameters
a

Member Function Documentation

◆ clear()

None CDPL.Math.Matrix3UL.clear ( int   v = 0)
Parameters
v

◆ getObjectID()

int CDPL.Math.Matrix3UL.getObjectID ( )

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

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

Matrix3UL CDPL.Math.Matrix3UL.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]

Matrix3UL CDPL.Math.Matrix3UL.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]

Matrix3UL CDPL.Math.Matrix3UL.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]

Matrix3UL CDPL.Math.Matrix3UL.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]

Matrix3UL CDPL.Math.Matrix3UL.assign ( Matrix3UL  m)

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

Parameters
mThe Matrix3UL instance to copy.
Returns
self

◆ assign() [6/6]

None CDPL.Math.Matrix3UL.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.Matrix3UL.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.Matrix3UL.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.Matrix3UL.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.Matrix3UL.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.Matrix3UL.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.Matrix3UL.__eq__ ( ConstULMatrixExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.Matrix3UL.__ne__ ( ConstULMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.Matrix3UL.__str__ ( )

Returns a string representation of the Matrix3UL instance.

Returns
The generated string representation.

◆ __pos__()

Matrix3UL CDPL.Math.Matrix3UL.__pos__ ( )
Returns

◆ __neg__()

ConstULMatrixExpression CDPL.Math.Matrix3UL.__neg__ ( )
Returns

◆ __add__()

ConstULMatrixExpression CDPL.Math.Matrix3UL.__add__ ( ConstULMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstULMatrixExpression CDPL.Math.Matrix3UL.__sub__ ( ConstULMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstULMatrixExpression CDPL.Math.Matrix3UL.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstULMatrixExpression CDPL.Math.Matrix3UL.__mul__ ( ConstULMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstULVectorExpression CDPL.Math.Matrix3UL.__mul__ ( ConstULVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstULMatrixExpression CDPL.Math.Matrix3UL.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstULMatrixExpression CDPL.Math.Matrix3UL.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

ConstULMatrixExpression CDPL.Math.Matrix3UL.__rmul__ ( int  t)
Parameters
t
Returns

◆ __setitem__()

None CDPL.Math.Matrix3UL.__setitem__ ( tuple  ij,
int  v 
)
Parameters
ij
v

◆ __iadd__() [1/2]

Matrix3UL CDPL.Math.Matrix3UL.__iadd__ ( Matrix3UL  m)

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

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

◆ __iadd__() [2/2]

Matrix3UL CDPL.Math.Matrix3UL.__iadd__ ( ConstULMatrixExpression  e)

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

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

◆ __isub__() [1/2]

Matrix3UL CDPL.Math.Matrix3UL.__isub__ ( Matrix3UL  m)

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

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

◆ __isub__() [2/2]

Matrix3UL CDPL.Math.Matrix3UL.__isub__ ( ConstULMatrixExpression  e)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

Matrix3UL CDPL.Math.Matrix3UL.__itruediv__ ( int  t)
Parameters
t
Returns