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

Public Member Functions

None __init__ (ConstDMatrixRange r)
 Initializes a copy of the ConstDMatrixRange instance r. More...
 
None __init__ (ConstDMatrixExpression e, Range r1, Range r2)
 Initializes the ConstDMatrixRange instance. More...
 
int getStart1 ()
 
int getStart2 ()
 
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 ()
 
ConstDMatrixExpression getData ()
 
float __call__ (int i, int j)
 
float __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (ConstDMatrixRange r)
 Returns the result of the comparison operation self == r. More...
 
bool __eq__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstDMatrixRange r)
 Returns the result of the comparison operation self != r. More...
 
bool __ne__ (ConstDMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the ConstDMatrixRange instance. More...
 
ConstDMatrixRange __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)
 

Properties

 objectID = property(getObjectID)
 
 size1 = property(getSize1)
 
 size2 = property(getSize2)
 
 data = property(getData)
 
 start1 = property(getStart1)
 
 start2 = property(getStart2)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.ConstDMatrixRange.__init__ ( ConstDMatrixRange  r)

Initializes a copy of the ConstDMatrixRange instance r.

Parameters
rThe ConstDMatrixRange instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ConstDMatrixRange.__init__ ( ConstDMatrixExpression  e,
Range  r1,
Range  r2 
)

Initializes the ConstDMatrixRange instance.

Parameters
e
r1
r2

Member Function Documentation

◆ getStart1()

int CDPL.Math.ConstDMatrixRange.getStart1 ( )
Returns

◆ getStart2()

int CDPL.Math.ConstDMatrixRange.getStart2 ( )
Returns

◆ getObjectID()

int CDPL.Math.ConstDMatrixRange.getObjectID ( )

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

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

◆ getSize2()

int CDPL.Math.ConstDMatrixRange.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.ConstDMatrixRange.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.ConstDMatrixRange.toArray ( )
Returns

◆ getData()

ConstDMatrixExpression CDPL.Math.ConstDMatrixRange.getData ( )
Returns

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.ConstDMatrixRange.__len__ ( )
Returns

◆ __eq__() [1/2]

bool CDPL.Math.ConstDMatrixRange.__eq__ ( ConstDMatrixRange  r)

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

Parameters
rThe ConstDMatrixRange instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

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

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

Parameters
rThe ConstDMatrixRange instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

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

Returns a string representation of the ConstDMatrixRange instance.

Returns
The generated string representation.

◆ __pos__()

ConstDMatrixRange CDPL.Math.ConstDMatrixRange.__pos__ ( )
Returns

◆ __neg__()

ConstDMatrixExpression CDPL.Math.ConstDMatrixRange.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

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

◆ __rmul__()

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