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

Public Member Functions

None __init__ (DMatrixTranspose mt)
 Initializes a copy of the DMatrixTranspose instance mt. More...
 
None __init__ (DMatrixExpression e)
 Initializes the DMatrixTranspose instance. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
DMatrixTranspose assign (ConstFMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e. More...
 
DMatrixTranspose assign (ConstDMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e. More...
 
DMatrixTranspose assign (ConstLMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e. More...
 
DMatrixTranspose assign (ConstULMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e. More...
 
DMatrixTranspose assign (DMatrixTranspose mt)
 Replaces the current state of self with a copy of the state of the DMatrixTranspose instance mt. 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 (DMatrixTranspose mt)
 
None setElement (int i, int j, float v)
 
DMatrixExpression getData ()
 
float __call__ (int i, int j)
 
float __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (DMatrixTranspose mt)
 Returns the result of the comparison operation self == mt. More...
 
bool __eq__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (DMatrixTranspose mt)
 Returns the result of the comparison operation self != mt. More...
 
bool __ne__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the DMatrixTranspose instance. More...
 
DMatrixTranspose __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)
 
DMatrixTranspose __iadd__ (DMatrixTranspose mt)
 Performs the in-place addition operation self += mt. More...
 
DMatrixTranspose __iadd__ (ConstDMatrixExpression e)
 Performs the in-place addition operation self += e. More...
 
DMatrixTranspose __isub__ (DMatrixTranspose mt)
 Performs the in-place subtraction operation self -= mt. More...
 
DMatrixTranspose __isub__ (ConstDMatrixExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
DMatrixTranspose __imul__ (float t)
 Performs the in-place multiplication operation self *= t. More...
 
DMatrixTranspose __idiv__ (float t)
 Performs the in-place division operation self /= t. More...
 
DMatrixTranspose __itruediv__ (float t)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.DMatrixTranspose.__init__ ( DMatrixTranspose  mt)

Initializes a copy of the DMatrixTranspose instance mt.

Parameters
mtThe DMatrixTranspose instance to copy.

◆ __init__() [2/2]

None CDPL.Math.DMatrixTranspose.__init__ ( DMatrixExpression  e)

Initializes the DMatrixTranspose instance.

Parameters
e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.DMatrixTranspose.getObjectID ( )

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

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

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

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

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

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

DMatrixTranspose CDPL.Math.DMatrixTranspose.assign ( DMatrixTranspose  mt)

Replaces the current state of self with a copy of the state of the DMatrixTranspose instance mt.

Parameters
mtThe DMatrixTranspose instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize2()

int CDPL.Math.DMatrixTranspose.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.DMatrixTranspose.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.DMatrixTranspose.toArray ( )
Returns

◆ swap()

None CDPL.Math.DMatrixTranspose.swap ( DMatrixTranspose  mt)
Parameters
mt

◆ setElement()

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

◆ getData()

DMatrixExpression CDPL.Math.DMatrixTranspose.getData ( )
Returns

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.DMatrixTranspose.__len__ ( )
Returns

◆ __eq__() [1/2]

bool CDPL.Math.DMatrixTranspose.__eq__ ( DMatrixTranspose  mt)

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

Parameters
mtThe DMatrixTranspose instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

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

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

Parameters
mtThe DMatrixTranspose instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

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

Returns a string representation of the DMatrixTranspose instance.

Returns
The generated string representation.

◆ __pos__()

DMatrixTranspose CDPL.Math.DMatrixTranspose.__pos__ ( )
Returns

◆ __neg__()

ConstDMatrixExpression CDPL.Math.DMatrixTranspose.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

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

◆ __rmul__()

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

◆ __setitem__()

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

◆ __iadd__() [1/2]

DMatrixTranspose CDPL.Math.DMatrixTranspose.__iadd__ ( DMatrixTranspose  mt)

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

Parameters
mtSpecifies the second addend.
Returns
The updated DMatrixTranspose instance self.

◆ __iadd__() [2/2]

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

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

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

◆ __isub__() [1/2]

DMatrixTranspose CDPL.Math.DMatrixTranspose.__isub__ ( DMatrixTranspose  mt)

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

Parameters
mtSpecifies the subtrahend.
Returns
The updated DMatrixTranspose instance self.

◆ __isub__() [2/2]

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

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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