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

Public Member Functions

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

Properties

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the FScalarMatrix instance m.

Parameters
mThe FScalarMatrix instance to copy.

◆ __init__() [2/2]

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

Initializes the FScalarMatrix instance.

Parameters
m
n
v

Member Function Documentation

◆ resize()

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

◆ getObjectID()

int CDPL.Math.FScalarMatrix.getObjectID ( )

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

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

◆ getSize2()

int CDPL.Math.FScalarMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.FScalarMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.FScalarMatrix.toArray ( )
Returns

◆ assign()

FScalarMatrix CDPL.Math.FScalarMatrix.assign ( FScalarMatrix  m)

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

Parameters
mThe FScalarMatrix instance to copy.
Returns
self

◆ swap()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.FScalarMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.FScalarMatrix.__eq__ ( ConstFMatrixExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.FScalarMatrix.__ne__ ( ConstFMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.FScalarMatrix.__str__ ( )

Returns a string representation of the FScalarMatrix instance.

Returns
The generated string representation.

◆ __pos__()

FScalarMatrix CDPL.Math.FScalarMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__neg__ ( )
Returns

◆ __add__()

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__add__ ( ConstFMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__sub__ ( ConstFMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__mul__ ( ConstFMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstFVectorExpression CDPL.Math.FScalarMatrix.__mul__ ( ConstFVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__rmul__ ( float  t)
Parameters
t
Returns