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

Public Member Functions

int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getSize1 ()
 
int getSize2 ()
 
int getSize3 ()
 
bool isEmpty ()
 
float getElement (int i, int j, int k)
 
object toArray ()
 
float __call__ (int i, int j, int k)
 
float __getitem__ (tuple ijk)
 
int __len__ ()
 
bool __eq__ (ConstDGridExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstDGridExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the ConstDGridExpression instance. More...
 
ConstDGridExpression __pos__ ()
 
ConstDGridExpression __neg__ ()
 
ConstDGridExpression __add__ (ConstDGridExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstDGridExpression __sub__ (ConstDGridExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstDGridExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstDGridExpression __div__ (float t)
 Returns the result of the division operation self / t. More...
 
ConstDGridExpression __truediv__ (float t)
 
ConstDGridExpression __rmul__ (float t)
 

Properties

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

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstDGridExpression.getObjectID ( )

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

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

◆ getSize2()

int CDPL.Math.ConstDGridExpression.getSize2 ( )
Returns

◆ getSize3()

int CDPL.Math.ConstDGridExpression.getSize3 ( )
Returns

◆ isEmpty()

bool CDPL.Math.ConstDGridExpression.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.ConstDGridExpression.toArray ( )
Returns

◆ __call__()

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

◆ __getitem__()

float CDPL.Math.ConstDGridExpression.__getitem__ ( tuple  ijk)
Parameters
ijk
Returns

◆ __len__()

int CDPL.Math.ConstDGridExpression.__len__ ( )
Returns

◆ __eq__()

bool CDPL.Math.ConstDGridExpression.__eq__ ( ConstDGridExpression  e)

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

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

◆ __ne__()

bool CDPL.Math.ConstDGridExpression.__ne__ ( ConstDGridExpression  e)

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

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

◆ __str__()

str CDPL.Math.ConstDGridExpression.__str__ ( )

Returns a string representation of the ConstDGridExpression instance.

Returns
The generated string representation.

◆ __pos__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__pos__ ( )
Returns

◆ __neg__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__neg__ ( )
Returns

◆ __add__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__add__ ( ConstDGridExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__sub__ ( ConstDGridExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __div__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__rmul__ ( float  t)
Parameters
t
Returns