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

Public Member Functions

None __init__ ()
 Initializes the DScalarGrid instance.
 
None __init__ (DScalarGrid g)
 Initializes a copy of the DScalarGrid instance g. More...
 
None __init__ (int m, int n, int o, float v=0.0)
 Initializes the DScalarGrid instance. More...
 
None resize (int m, int n, int o)
 
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)
 
float getElement (int i)
 
object toArray ()
 
int getSize ()
 
DScalarGrid assign (DScalarGrid g)
 Replaces the current state of self with a copy of the state of the DScalarGrid instance g. More...
 
None swap (DScalarGrid g)
 
float __call__ (int i, int j, int k)
 
float __call__ (int i)
 
float __getitem__ (tuple ijk)
 
float __getitem__ (int i)
 
int __len__ ()
 
bool __eq__ (DScalarGrid g)
 Returns the result of the comparison operation self == g. More...
 
bool __eq__ (ConstDGridExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (DScalarGrid g)
 Returns the result of the comparison operation self != g. More...
 
bool __ne__ (ConstDGridExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the DScalarGrid instance. More...
 
DScalarGrid __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)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.DScalarGrid.__init__ ( DScalarGrid  g)

Initializes a copy of the DScalarGrid instance g.

Parameters
gThe DScalarGrid instance to copy.

◆ __init__() [2/2]

None CDPL.Math.DScalarGrid.__init__ ( int  m,
int  n,
int  o,
float   v = 0.0 
)

Initializes the DScalarGrid instance.

Parameters
m
n
o
v

Member Function Documentation

◆ resize()

None CDPL.Math.DScalarGrid.resize ( int  m,
int  n,
int  o 
)
Parameters
m
n
o

◆ getObjectID()

int CDPL.Math.DScalarGrid.getObjectID ( )

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

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

◆ getSize2()

int CDPL.Math.DScalarGrid.getSize2 ( )
Returns

◆ getSize3()

int CDPL.Math.DScalarGrid.getSize3 ( )
Returns

◆ isEmpty()

bool CDPL.Math.DScalarGrid.isEmpty ( )
Returns

◆ getElement() [1/2]

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

◆ getElement() [2/2]

float CDPL.Math.DScalarGrid.getElement ( int  i)
Parameters
i
Returns

◆ toArray()

object CDPL.Math.DScalarGrid.toArray ( )
Returns

◆ getSize()

int CDPL.Math.DScalarGrid.getSize ( )
Returns

◆ assign()

DScalarGrid CDPL.Math.DScalarGrid.assign ( DScalarGrid  g)

Replaces the current state of self with a copy of the state of the DScalarGrid instance g.

Parameters
gThe DScalarGrid instance to copy.
Returns
self

◆ swap()

None CDPL.Math.DScalarGrid.swap ( DScalarGrid  g)
Parameters
g

◆ __call__() [1/2]

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

◆ __call__() [2/2]

float CDPL.Math.DScalarGrid.__call__ ( int  i)
Parameters
i
Returns

◆ __getitem__() [1/2]

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

◆ __getitem__() [2/2]

float CDPL.Math.DScalarGrid.__getitem__ ( int  i)
Parameters
i
Returns

◆ __len__()

int CDPL.Math.DScalarGrid.__len__ ( )
Returns

◆ __eq__() [1/2]

bool CDPL.Math.DScalarGrid.__eq__ ( DScalarGrid  g)

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

Parameters
gThe DScalarGrid instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

bool CDPL.Math.DScalarGrid.__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__() [1/2]

bool CDPL.Math.DScalarGrid.__ne__ ( DScalarGrid  g)

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

Parameters
gThe DScalarGrid instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

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

Returns a string representation of the DScalarGrid instance.

Returns
The generated string representation.

◆ __pos__()

DScalarGrid CDPL.Math.DScalarGrid.__pos__ ( )
Returns

◆ __neg__()

ConstDGridExpression CDPL.Math.DScalarGrid.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__()

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

◆ __rmul__()

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