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

A bounded 2x2 matrix holding signed integers of type long. More...

+ Inheritance diagram for CDPL.Math.Matrix2L:

Public Member Functions

None __init__ ()
 Initializes the Matrix2L instance.
 
None __init__ (int v)
 Initializes the Matrix2L instance. More...
 
None __init__ (Matrix2L m)
 Initializes a copy of the Matrix2L instance m. More...
 
None __init__ (ConstFMatrixExpression e)
 Initializes the Matrix2L instance. More...
 
None __init__ (ConstDMatrixExpression e)
 Initializes the Matrix2L instance. More...
 
None __init__ (ConstLMatrixExpression e)
 Initializes the Matrix2L instance. More...
 
None __init__ (ConstULMatrixExpression e)
 Initializes the Matrix2L instance. More...
 
None __init__ (object a)
 Initializes the Matrix2L instance. More...
 
None clear (int v=0)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Matrix2L assign (ConstFMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e. More...
 
Matrix2L assign (ConstDMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e. More...
 
Matrix2L assign (ConstLMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e. More...
 
Matrix2L assign (ConstULMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e. More...
 
Matrix2L assign (Matrix2L m)
 Replaces the current state of self with a copy of the state of the Matrix2L 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 (Matrix2L m)
 
None setElement (int i, int j, int v)
 
int __call__ (int i, int j)
 
int __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (Matrix2L 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__ (Matrix2L 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 Matrix2L instance. More...
 
Matrix2L __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)
 
None __setitem__ (tuple ij, int v)
 
Matrix2L __iadd__ (Matrix2L m)
 Performs the in-place addition operation self += m. More...
 
Matrix2L __iadd__ (ConstLMatrixExpression e)
 Performs the in-place addition operation self += e. More...
 
Matrix2L __isub__ (Matrix2L m)
 Performs the in-place subtraction operation self -= m. More...
 
Matrix2L __isub__ (ConstLMatrixExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
Matrix2L __imul__ (int t)
 Performs the in-place multiplication operation self *= t. More...
 
Matrix2L __idiv__ (int t)
 Performs the in-place division operation self /= t. More...
 
Matrix2L __itruediv__ (int t)
 

Properties

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

Detailed Description

A bounded 2x2 matrix holding signed integers of type long.

Constructor & Destructor Documentation

◆ __init__() [1/7]

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

Initializes the Matrix2L instance.

Parameters
v

◆ __init__() [2/7]

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

Initializes a copy of the Matrix2L instance m.

Parameters
mThe Matrix2L instance to copy.

◆ __init__() [3/7]

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

Initializes the Matrix2L instance.

Parameters
e

◆ __init__() [4/7]

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

Initializes the Matrix2L instance.

Parameters
e

◆ __init__() [5/7]

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

Initializes the Matrix2L instance.

Parameters
e

◆ __init__() [6/7]

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

Initializes the Matrix2L instance.

Parameters
e

◆ __init__() [7/7]

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

Initializes the Matrix2L instance.

Parameters
a

Member Function Documentation

◆ clear()

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

◆ getObjectID()

int CDPL.Math.Matrix2L.getObjectID ( )

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

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

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

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

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

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

Matrix2L CDPL.Math.Matrix2L.assign ( Matrix2L  m)

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

Parameters
mThe Matrix2L instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize2()

int CDPL.Math.Matrix2L.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.Matrix2L.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.Matrix2L.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.Matrix2L.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

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

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

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

◆ __ne__() [2/2]

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

Returns a string representation of the Matrix2L instance.

Returns
The generated string representation.

◆ __pos__()

Matrix2L CDPL.Math.Matrix2L.__pos__ ( )
Returns

◆ __neg__()

ConstLMatrixExpression CDPL.Math.Matrix2L.__neg__ ( )
Returns

◆ __add__()

ConstLMatrixExpression CDPL.Math.Matrix2L.__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.Matrix2L.__sub__ ( ConstLMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstLMatrixExpression CDPL.Math.Matrix2L.__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.Matrix2L.__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.Matrix2L.__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.Matrix2L.__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.Matrix2L.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

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

◆ __setitem__()

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

◆ __iadd__() [1/2]

Matrix2L CDPL.Math.Matrix2L.__iadd__ ( Matrix2L  m)

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

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

◆ __iadd__() [2/2]

Matrix2L CDPL.Math.Matrix2L.__iadd__ ( ConstLMatrixExpression  e)

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

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

◆ __isub__() [1/2]

Matrix2L CDPL.Math.Matrix2L.__isub__ ( Matrix2L  m)

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

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

◆ __isub__() [2/2]

Matrix2L CDPL.Math.Matrix2L.__isub__ ( ConstLMatrixExpression  e)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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