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

An unbounded dense matrix holding floating point values of type float. More...

+ Inheritance diagram for CDPL.Math.FMatrix:

Public Member Functions

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

Properties

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

Detailed Description

An unbounded dense matrix holding floating point values of type float.

Constructor & Destructor Documentation

◆ __init__() [1/8]

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

Initializes a copy of the FMatrix instance m.

Parameters
mThe FMatrix instance to copy.

◆ __init__() [2/8]

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

Initializes the FMatrix instance.

Parameters
m
n

◆ __init__() [3/8]

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

Initializes the FMatrix instance.

Parameters
m
n
v

◆ __init__() [4/8]

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

Initializes the FMatrix instance.

Parameters
e

◆ __init__() [5/8]

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

Initializes the FMatrix instance.

Parameters
e

◆ __init__() [6/8]

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

Initializes the FMatrix instance.

Parameters
e

◆ __init__() [7/8]

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

Initializes the FMatrix instance.

Parameters
e

◆ __init__() [8/8]

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

Initializes the FMatrix instance.

Parameters
a

Member Function Documentation

◆ resize()

None CDPL.Math.FMatrix.resize ( int  m,
int  n,
bool   preserve = True,
float   v = 0.0 
)
Parameters
m
n
preserve
v

◆ clear()

None CDPL.Math.FMatrix.clear ( float   v = 0.0)
Parameters
v

◆ getObjectID()

int CDPL.Math.FMatrix.getObjectID ( )

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

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

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

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

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

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

FMatrix CDPL.Math.FMatrix.assign ( FMatrix  m)

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

Parameters
mThe FMatrix instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize2()

int CDPL.Math.FMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.FMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.FMatrix.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.FMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

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

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

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

◆ __ne__() [2/2]

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

Returns a string representation of the FMatrix instance.

Returns
The generated string representation.

◆ __pos__()

FMatrix CDPL.Math.FMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstFMatrixExpression CDPL.Math.FMatrix.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstFMatrixExpression CDPL.Math.FMatrix.__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.FMatrix.__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.FMatrix.__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.FMatrix.__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.FMatrix.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

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

◆ __setitem__()

None CDPL.Math.FMatrix.__setitem__ ( tuple  ij,
float  v 
)
Parameters
ij
v

◆ __iadd__() [1/2]

FMatrix CDPL.Math.FMatrix.__iadd__ ( FMatrix  m)

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

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

◆ __iadd__() [2/2]

FMatrix CDPL.Math.FMatrix.__iadd__ ( ConstFMatrixExpression  e)

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

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

◆ __isub__() [1/2]

FMatrix CDPL.Math.FMatrix.__isub__ ( FMatrix  m)

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

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

◆ __isub__() [2/2]

FMatrix CDPL.Math.FMatrix.__isub__ ( ConstFMatrixExpression  e)

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

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

◆ __imul__()

FMatrix CDPL.Math.FMatrix.__imul__ ( float  t)

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

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

◆ __idiv__()

FMatrix CDPL.Math.FMatrix.__idiv__ ( float  t)

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

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

◆ __itruediv__()

FMatrix CDPL.Math.FMatrix.__itruediv__ ( float  t)
Parameters
t
Returns