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

Public Member Functions

None __init__ ()
 Initializes the DScalarMatrix instance.
 
None __init__ (DScalarMatrix m)
 Initializes a copy of the DScalarMatrix instance m. More...
 
None __init__ (int m, int n, float v=0.0)
 Initializes the DScalarMatrix 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 ()
 
float getElement (int i, int j)
 
object toArray ()
 
DScalarMatrix assign (DScalarMatrix m)
 Replaces the current state of self with a copy of the state of the DScalarMatrix instance m. More...
 
None swap (DScalarMatrix m)
 
float __call__ (int i, int j)
 
float __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (DScalarMatrix m)
 Returns the result of the comparison operation self == m. More...
 
bool __eq__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (DScalarMatrix m)
 Returns the result of the comparison operation self != m. More...
 
bool __ne__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the DScalarMatrix instance. More...
 
DScalarMatrix __pos__ ()
 
ConstDMatrixExpression __neg__ ()
 
ConstDMatrixExpression __add__ (ConstDMatrixExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstDMatrixExpression __sub__ (ConstDMatrixExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstDMatrixExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstDMatrixExpression __mul__ (ConstDMatrixExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstDVectorExpression __mul__ (ConstDVectorExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstDMatrixExpression __div__ (float t)
 Returns the result of the division operation self / t. More...
 
ConstDMatrixExpression __truediv__ (float t)
 
ConstDMatrixExpression __rmul__ (float t)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the DScalarMatrix instance m.

Parameters
mThe DScalarMatrix instance to copy.

◆ __init__() [2/2]

None CDPL.Math.DScalarMatrix.__init__ ( int  m,
int  n,
float   v = 0.0 
)

Initializes the DScalarMatrix instance.

Parameters
m
n
v

Member Function Documentation

◆ resize()

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

◆ getObjectID()

int CDPL.Math.DScalarMatrix.getObjectID ( )

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

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

◆ getSize2()

int CDPL.Math.DScalarMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.DScalarMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.DScalarMatrix.toArray ( )
Returns

◆ assign()

DScalarMatrix CDPL.Math.DScalarMatrix.assign ( DScalarMatrix  m)

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

Parameters
mThe DScalarMatrix instance to copy.
Returns
self

◆ swap()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.DScalarMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.DScalarMatrix.__eq__ ( ConstDMatrixExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.DScalarMatrix.__ne__ ( ConstDMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.DScalarMatrix.__str__ ( )

Returns a string representation of the DScalarMatrix instance.

Returns
The generated string representation.

◆ __pos__()

DScalarMatrix CDPL.Math.DScalarMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__neg__ ( )
Returns

◆ __add__()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__add__ ( ConstDMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__sub__ ( ConstDMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__mul__ ( ConstDMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstDVectorExpression CDPL.Math.DScalarMatrix.__mul__ ( ConstDVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__rmul__ ( float  t)
Parameters
t
Returns