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

Public Member Functions

None __init__ ()
 Initializes the ULScalarMatrix instance.
 
None __init__ (ULScalarMatrix m)
 Initializes a copy of the ULScalarMatrix instance m. More...
 
None __init__ (int m, int n, int v=0)
 Initializes the ULScalarMatrix instance. More...
 
None resize (int m, int n)
 
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 ()
 
ULScalarMatrix assign (ULScalarMatrix m)
 Replaces the current state of self with a copy of the state of the ULScalarMatrix instance m. More...
 
None swap (ULScalarMatrix m)
 
int __call__ (int i, int j)
 
int __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (ULScalarMatrix 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__ (ULScalarMatrix 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 ULScalarMatrix instance. More...
 
ULScalarMatrix __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)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the ULScalarMatrix instance m.

Parameters
mThe ULScalarMatrix instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ULScalarMatrix.__init__ ( int  m,
int  n,
int   v = 0 
)

Initializes the ULScalarMatrix instance.

Parameters
m
n
v

Member Function Documentation

◆ resize()

None CDPL.Math.ULScalarMatrix.resize ( int  m,
int  n 
)
Parameters
m
n

◆ getObjectID()

int CDPL.Math.ULScalarMatrix.getObjectID ( )

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

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

◆ getSize2()

int CDPL.Math.ULScalarMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.ULScalarMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.ULScalarMatrix.toArray ( )
Returns

◆ assign()

ULScalarMatrix CDPL.Math.ULScalarMatrix.assign ( ULScalarMatrix  m)

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

Parameters
mThe ULScalarMatrix instance to copy.
Returns
self

◆ swap()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.ULScalarMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

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

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

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

◆ __ne__() [2/2]

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

Returns a string representation of the ULScalarMatrix instance.

Returns
The generated string representation.

◆ __pos__()

ULScalarMatrix CDPL.Math.ULScalarMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstULMatrixExpression CDPL.Math.ULScalarMatrix.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

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

◆ __rmul__()

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