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

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

+ Inheritance diagram for CDPL.Math.DMatrix:

Public Member Functions

None __init__ ()
 Initializes the DMatrix instance.
 
None __init__ (DMatrix m)
 Initializes a copy of the DMatrix instance m. More...
 
None __init__ (int m, int n)
 Initializes the DMatrix instance. More...
 
None __init__ (int m, int n, float v)
 Initializes the DMatrix instance. More...
 
None __init__ (ConstFMatrixExpression e)
 Initializes the DMatrix instance. More...
 
None __init__ (ConstDMatrixExpression e)
 Initializes the DMatrix instance. More...
 
None __init__ (ConstLMatrixExpression e)
 Initializes the DMatrix instance. More...
 
None __init__ (ConstULMatrixExpression e)
 Initializes the DMatrix instance. More...
 
None __init__ (object a)
 Initializes the DMatrix 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...
 
DMatrix assign (ConstFMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e. More...
 
DMatrix assign (ConstDMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e. More...
 
DMatrix assign (ConstLMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e. More...
 
DMatrix assign (ConstULMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e. More...
 
DMatrix assign (DMatrix m)
 Replaces the current state of self with a copy of the state of the DMatrix 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 (DMatrix m)
 
None setElement (int i, int j, float v)
 
float __call__ (int i, int j)
 
float __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (DMatrix 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__ (DMatrix 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 DMatrix instance. More...
 
DMatrix __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)
 
None __setitem__ (tuple ij, float v)
 
DMatrix __iadd__ (DMatrix m)
 Performs the in-place addition operation self += m. More...
 
DMatrix __iadd__ (ConstDMatrixExpression e)
 Performs the in-place addition operation self += e. More...
 
DMatrix __isub__ (DMatrix m)
 Performs the in-place subtraction operation self -= m. More...
 
DMatrix __isub__ (ConstDMatrixExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
DMatrix __imul__ (float t)
 Performs the in-place multiplication operation self *= t. More...
 
DMatrix __idiv__ (float t)
 Performs the in-place division operation self /= t. More...
 
DMatrix __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 double.

Constructor & Destructor Documentation

◆ __init__() [1/8]

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

Initializes a copy of the DMatrix instance m.

Parameters
mThe DMatrix instance to copy.

◆ __init__() [2/8]

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

Initializes the DMatrix instance.

Parameters
m
n

◆ __init__() [3/8]

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

Initializes the DMatrix instance.

Parameters
m
n
v

◆ __init__() [4/8]

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

Initializes the DMatrix instance.

Parameters
e

◆ __init__() [5/8]

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

Initializes the DMatrix instance.

Parameters
e

◆ __init__() [6/8]

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

Initializes the DMatrix instance.

Parameters
e

◆ __init__() [7/8]

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

Initializes the DMatrix instance.

Parameters
e

◆ __init__() [8/8]

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

Initializes the DMatrix instance.

Parameters
a

Member Function Documentation

◆ resize()

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

◆ clear()

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

◆ getObjectID()

int CDPL.Math.DMatrix.getObjectID ( )

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

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

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

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

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

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

DMatrix CDPL.Math.DMatrix.assign ( DMatrix  m)

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

Parameters
mThe DMatrix instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize2()

int CDPL.Math.DMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.DMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.DMatrix.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.DMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

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

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

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

◆ __ne__() [2/2]

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

Returns a string representation of the DMatrix instance.

Returns
The generated string representation.

◆ __pos__()

DMatrix CDPL.Math.DMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstDMatrixExpression CDPL.Math.DMatrix.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

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

◆ __rmul__()

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

◆ __setitem__()

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

◆ __iadd__() [1/2]

DMatrix CDPL.Math.DMatrix.__iadd__ ( DMatrix  m)

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

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

◆ __iadd__() [2/2]

DMatrix CDPL.Math.DMatrix.__iadd__ ( ConstDMatrixExpression  e)

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

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

◆ __isub__() [1/2]

DMatrix CDPL.Math.DMatrix.__isub__ ( DMatrix  m)

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

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

◆ __isub__() [2/2]

DMatrix CDPL.Math.DMatrix.__isub__ ( ConstDMatrixExpression  e)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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