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

Mutable view adapter that exposes the transpose of a matrix M as a matrix expression ( \( (i, j) \to M(j, i) \)). More...

+ Inheritance diagram for CDPL.Math.ConstLMatrixTranspose:

Public Member Functions

None __init__ (ConstLMatrixTranspose mt)
 Initializes a copy of the ConstLMatrixTranspose instance mt. More...
 
None __init__ (ConstLMatrixExpression e)
 Initializes the ConstLMatrixTranspose instance. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getSize1 ()
 Returns the number of rows of the transpose view (= number of columns of the wrapped matrix). More...
 
int getSize2 ()
 Returns the number of columns of the transpose view (= number of rows of the wrapped matrix). More...
 
bool isEmpty ()
 Tells whether the view is empty (the wrapped matrix has zero rows or zero columns). More...
 
int getElement (int i, int j)
 
object toArray ()
 
ConstLMatrixExpression getData ()
 Returns a reference to the wrapped matrix (via its stored closure). More...
 
int __call__ (int i, int j)
 Returns a reference to the wrapped matrix's element at (j, i). More...
 
int __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (ConstLMatrixTranspose mt)
 Returns the result of the comparison operation self == mt. More...
 
bool __eq__ (ConstLMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstLMatrixTranspose mt)
 Returns the result of the comparison operation self != mt. More...
 
bool __ne__ (ConstLMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the ConstLMatrixTranspose instance. More...
 
ConstLMatrixTranspose __pos__ ()
 
ConstLMatrixExpression __neg__ ()
 
ConstLMatrixExpression __add__ (ConstLMatrixExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstLMatrixExpression __sub__ (ConstLMatrixExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstLMatrixExpression __mul__ (int t)
 Returns the result of the multiplication operation self * t. More...
 
ConstLMatrixExpression __mul__ (ConstLMatrixExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstLVectorExpression __mul__ (ConstLVectorExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstLMatrixExpression __div__ (int t)
 Returns the result of the division operation self // t. More...
 
ConstLMatrixExpression __truediv__ (int t)
 Returns the result of the true division operation self / t. More...
 
ConstLMatrixExpression __rmul__ (int t)
 Returns the result of the multiplication operation t * self. More...
 

Properties

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

Detailed Description

Mutable view adapter that exposes the transpose of a matrix M as a matrix expression ( \( (i, j) \to M(j, i) \)).

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the ConstLMatrixTranspose instance mt.

Parameters
mtThe ConstLMatrixTranspose instance to copy.

◆ __init__() [2/2]

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

Initializes the ConstLMatrixTranspose instance.

Parameters
e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstLMatrixTranspose.getObjectID ( )

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

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

Returns the number of rows of the transpose view (= number of columns of the wrapped matrix).

Returns
The number of rows.

◆ getSize2()

int CDPL.Math.ConstLMatrixTranspose.getSize2 ( )

Returns the number of columns of the transpose view (= number of rows of the wrapped matrix).

Returns
The number of columns.

◆ isEmpty()

bool CDPL.Math.ConstLMatrixTranspose.isEmpty ( )

Tells whether the view is empty (the wrapped matrix has zero rows or zero columns).

Returns
True if the wrapped matrix is empty, and False otherwise.

◆ getData()

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.getData ( )

Returns a reference to the wrapped matrix (via its stored closure).

Returns
A reference to the wrapped matrix closure.

◆ __call__()

int CDPL.Math.ConstLMatrixTranspose.__call__ ( int  i,
int  j 
)

Returns a reference to the wrapped matrix's element at (j, i).

Parameters
iThe zero-based row index in the transposed view.
jThe zero-based column index in the transposed view.
Returns
A reference to m(j, i).

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.ConstLMatrixTranspose.__eq__ ( ConstLMatrixExpression  e)

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

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

◆ __ne__() [1/2]

bool CDPL.Math.ConstLMatrixTranspose.__ne__ ( ConstLMatrixTranspose  mt)

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

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

◆ __ne__() [2/2]

bool CDPL.Math.ConstLMatrixTranspose.__ne__ ( ConstLMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.ConstLMatrixTranspose.__str__ ( )

Returns a string representation of the ConstLMatrixTranspose instance.

Returns
The generated string representation.

◆ __add__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.__add__ ( ConstLMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.__sub__ ( ConstLMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.__mul__ ( ConstLMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstLVectorExpression CDPL.Math.ConstLMatrixTranspose.__mul__ ( ConstLVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.__div__ ( int  t)

Returns the result of the division operation self // t.

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

◆ __truediv__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.__truediv__ ( int  t)

Returns the result of the true division operation self / t.

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

◆ __rmul__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixTranspose.__rmul__ ( int  t)

Returns the result of the multiplication operation t * self.

Parameters
tSpecifies the multiplicand.
Returns
A ConstLMatrixExpression instance holding the result of the multiplication.