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

An unbounded dense matrix holding unsigned integers of type unsigned long. More...

+ Inheritance diagram for CDPL.Math.ULMatrix:

Public Member Functions

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

Properties

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

Detailed Description

An unbounded dense matrix holding unsigned integers of type unsigned long.

Constructor & Destructor Documentation

◆ __init__() [1/8]

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

Initializes a copy of the ULMatrix instance m.

Parameters
mThe ULMatrix instance to copy.

◆ __init__() [2/8]

None CDPL.Math.ULMatrix.__init__ ( int  m,
int  n 
)

Initializes the ULMatrix instance.

Parameters
m
n

◆ __init__() [3/8]

None CDPL.Math.ULMatrix.__init__ ( int  m,
int  n,
int  v 
)

Initializes the ULMatrix instance.

Parameters
m
n
v

◆ __init__() [4/8]

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

Initializes the ULMatrix instance.

Parameters
e

◆ __init__() [5/8]

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

Initializes the ULMatrix instance.

Parameters
e

◆ __init__() [6/8]

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

Initializes the ULMatrix instance.

Parameters
e

◆ __init__() [7/8]

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

Initializes the ULMatrix instance.

Parameters
e

◆ __init__() [8/8]

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

Initializes the ULMatrix instance.

Parameters
a

Member Function Documentation

◆ resize()

None CDPL.Math.ULMatrix.resize ( int  m,
int  n,
bool   preserve = True,
int   v = 0 
)
Parameters
m
n
preserve
v

◆ clear()

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

◆ getObjectID()

int CDPL.Math.ULMatrix.getObjectID ( )

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

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

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

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

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

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

ULMatrix CDPL.Math.ULMatrix.assign ( ULMatrix  m)

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

Parameters
mThe ULMatrix instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize2()

int CDPL.Math.ULMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.ULMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.ULMatrix.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.ULMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

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

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

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

◆ __ne__() [2/2]

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

Returns a string representation of the ULMatrix instance.

Returns
The generated string representation.

◆ __pos__()

ULMatrix CDPL.Math.ULMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstULMatrixExpression CDPL.Math.ULMatrix.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

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

◆ __rmul__()

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

◆ __setitem__()

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

◆ __iadd__() [1/2]

ULMatrix CDPL.Math.ULMatrix.__iadd__ ( ULMatrix  m)

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

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

◆ __iadd__() [2/2]

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

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

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

◆ __isub__() [1/2]

ULMatrix CDPL.Math.ULMatrix.__isub__ ( ULMatrix  m)

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

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

◆ __isub__() [2/2]

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

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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