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

An unbounded dense regular grid in 3D space holding floating point values of type float. More...

+ Inheritance diagram for CDPL.Math.FRegularSpatialGrid:

Classes

class  DataMode
 

Public Member Functions

None __init__ (FRegularSpatialGrid grid)
 Initializes a copy of the FRegularSpatialGrid instance grid. More...
 
None __init__ (FGrid data, float xs, float ys, float zs)
 Initializes the FRegularSpatialGrid instance. More...
 
None __init__ (FGrid data, float s)
 Initializes the FRegularSpatialGrid instance. More...
 
None __init__ (float xs, float ys, float zs)
 Initializes the FRegularSpatialGrid instance. More...
 
None __init__ (float s)
 Initializes the FRegularSpatialGrid instance. More...
 
None resize (int m, int n, int o, bool preserve=True, float v=0.0)
 
None clear (float v=0.0)
 
DataMode getDataMode ()
 
None setDataMode (DataMode mode)
 
float getXExtent ()
 
float getYExtent ()
 
float getZExtent ()
 
float getXStepSize ()
 
float getYStepSize ()
 
float getZStepSize ()
 
None setXStepSize (float xs)
 
None setYStepSize (float ys)
 
None setZStepSize (float zs)
 
FGrid getData ()
 
None setCoordinatesTransform (Matrix4F xform)
 
Matrix4F getCoordinatesTransform ()
 
None getCoordinates (int i, int j, int k, object coords)
 
None getCoordinates (int i, object coords)
 
None getLocalCoordinates (int i, int j, int k, object coords)
 
None getLocalCoordinates (Vector3F world_coords, object local_coords)
 
bool containsPoint (Vector3F pos)
 
bool containsPoint (ConstFVectorExpression pos)
 
bool containsPoint (Vector3D pos)
 
bool containsPoint (ConstDVectorExpression pos)
 
bool containsPoint (Vector3L pos)
 
bool containsPoint (ConstLVectorExpression pos)
 
bool containsPoint (Vector3UL pos)
 
bool containsPoint (ConstULVectorExpression pos)
 
bool containsLocalPoint (Vector3F pos)
 
bool containsLocalPoint (ConstFVectorExpression pos)
 
bool containsLocalPoint (Vector3D pos)
 
bool containsLocalPoint (ConstDVectorExpression pos)
 
bool containsLocalPoint (Vector3L pos)
 
bool containsLocalPoint (ConstLVectorExpression pos)
 
bool containsLocalPoint (Vector3UL pos)
 
bool containsLocalPoint (ConstULVectorExpression pos)
 
None getContainingCell (Vector3F pos, object indices)
 
None getContainingCell (ConstFVectorExpression pos, object indices)
 
None getContainingCell (Vector3D pos, object indices)
 
None getContainingCell (ConstDVectorExpression pos, object indices)
 
None getContainingCell (Vector3L pos, object indices)
 
None getContainingCell (ConstLVectorExpression pos, object indices)
 
None getContainingCell (Vector3UL pos, object indices)
 
None getContainingCell (ConstULVectorExpression pos, object indices)
 
None getLocalContainingCell (Vector3F pos, object indices)
 
None getLocalContainingCell (ConstFVectorExpression pos, object indices)
 
None getLocalContainingCell (Vector3D pos, object indices)
 
None getLocalContainingCell (ConstDVectorExpression pos, object indices)
 
None getLocalContainingCell (Vector3L pos, object indices)
 
None getLocalContainingCell (ConstLVectorExpression pos, object indices)
 
None getLocalContainingCell (Vector3UL pos, object indices)
 
None getLocalContainingCell (ConstULVectorExpression pos, object indices)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
FRegularSpatialGrid assign (ConstFGridExpression e)
 Replaces the current state of self with a copy of the state of the ConstFGridExpression instance e. More...
 
FRegularSpatialGrid assign (ConstDGridExpression e)
 Replaces the current state of self with a copy of the state of the ConstDGridExpression instance e. More...
 
FRegularSpatialGrid assign (object e)
 Replaces the current state of self with a copy of the state of the object instance e. More...
 
FRegularSpatialGrid assign (FRegularSpatialGrid g)
 Replaces the current state of self with a copy of the state of the FRegularSpatialGrid instance g. 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 ()
 
None swap (FRegularSpatialGrid g)
 
None setElement (int i, int j, int k, float v)
 
None setElement (int i, float v)
 
float __call__ (int i, int j, int k)
 
float __call__ (int i)
 
float __getitem__ (tuple ijk)
 
float __getitem__ (int i)
 
int __len__ ()
 
bool __eq__ (FRegularSpatialGrid g)
 Returns the result of the comparison operation self == g. More...
 
bool __eq__ (ConstFGridExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (FRegularSpatialGrid g)
 Returns the result of the comparison operation self != g. More...
 
bool __ne__ (ConstFGridExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the FRegularSpatialGrid instance. More...
 
FRegularSpatialGrid __pos__ ()
 
ConstFGridExpression __neg__ ()
 
ConstFGridExpression __add__ (ConstFGridExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstFGridExpression __sub__ (ConstFGridExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstFGridExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstFGridExpression __div__ (float t)
 Returns the result of the division operation self / t. More...
 
ConstFGridExpression __truediv__ (float t)
 
ConstFGridExpression __rmul__ (float t)
 
None __setitem__ (tuple ijk, float v)
 
None __setitem__ (int i, float v)
 
FRegularSpatialGrid __iadd__ (FRegularSpatialGrid g)
 Performs the in-place addition operation self += g. More...
 
FRegularSpatialGrid __iadd__ (ConstFGridExpression e)
 Performs the in-place addition operation self += e. More...
 
FRegularSpatialGrid __isub__ (FRegularSpatialGrid g)
 Performs the in-place subtraction operation self -= g. More...
 
FRegularSpatialGrid __isub__ (ConstFGridExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
FRegularSpatialGrid __imul__ (float t)
 Performs the in-place multiplication operation self *= t. More...
 
FRegularSpatialGrid __idiv__ (float t)
 Performs the in-place division operation self /= t. More...
 
FRegularSpatialGrid __itruediv__ (float t)
 

Properties

 data = property(getData)
 
 coordsTransform = property(getCoordinatesTransform, setCoordinatesTransform)
 
 dataMode = property(getDataMode, setDataMode)
 
 xStepSize = property(getXStepSize, setXStepSize)
 
 yStepSize = property(getYStepSize, setYStepSize)
 
 zStepSize = property(getZStepSize, setZStepSize)
 
 xExtent = property(getXExtent)
 
 yExtent = property(getYExtent)
 
 zExtent = property(getZExtent)
 
 objectID = property(getObjectID)
 
 size1 = property(getSize1)
 
 size2 = property(getSize2)
 
 size3 = property(getSize3)
 

Detailed Description

An unbounded dense regular grid in 3D space holding floating point values of type float.

Constructor & Destructor Documentation

◆ __init__() [1/5]

None CDPL.Math.FRegularSpatialGrid.__init__ ( FRegularSpatialGrid  grid)

Initializes a copy of the FRegularSpatialGrid instance grid.

Parameters
gridThe FRegularSpatialGrid instance to copy.

◆ __init__() [2/5]

None CDPL.Math.FRegularSpatialGrid.__init__ ( FGrid  data,
float  xs,
float  ys,
float  zs 
)

Initializes the FRegularSpatialGrid instance.

Parameters
data
xs
ys
zs

◆ __init__() [3/5]

None CDPL.Math.FRegularSpatialGrid.__init__ ( FGrid  data,
float  s 
)

Initializes the FRegularSpatialGrid instance.

Parameters
data
s

◆ __init__() [4/5]

None CDPL.Math.FRegularSpatialGrid.__init__ ( float  xs,
float  ys,
float  zs 
)

Initializes the FRegularSpatialGrid instance.

Parameters
xs
ys
zs

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __init__() [5/5]

None CDPL.Math.FRegularSpatialGrid.__init__ ( float  s)

Initializes the FRegularSpatialGrid instance.

Parameters
s

Reimplemented in CDPL.Grid.FRegularGrid.

Member Function Documentation

◆ resize()

None CDPL.Math.FRegularSpatialGrid.resize ( int  m,
int  n,
int  o,
bool   preserve = True,
float   v = 0.0 
)
Parameters
m
n
o
preserve
v

◆ clear()

None CDPL.Math.FRegularSpatialGrid.clear ( float   v = 0.0)
Parameters
v

◆ getDataMode()

DataMode CDPL.Math.FRegularSpatialGrid.getDataMode ( )
Returns

◆ setDataMode()

None CDPL.Math.FRegularSpatialGrid.setDataMode ( DataMode  mode)
Parameters
mode

◆ getXExtent()

float CDPL.Math.FRegularSpatialGrid.getXExtent ( )
Returns

◆ getYExtent()

float CDPL.Math.FRegularSpatialGrid.getYExtent ( )
Returns

◆ getZExtent()

float CDPL.Math.FRegularSpatialGrid.getZExtent ( )
Returns

◆ getXStepSize()

float CDPL.Math.FRegularSpatialGrid.getXStepSize ( )
Returns

◆ getYStepSize()

float CDPL.Math.FRegularSpatialGrid.getYStepSize ( )
Returns

◆ getZStepSize()

float CDPL.Math.FRegularSpatialGrid.getZStepSize ( )
Returns

◆ setXStepSize()

None CDPL.Math.FRegularSpatialGrid.setXStepSize ( float  xs)
Parameters
xs

◆ setYStepSize()

None CDPL.Math.FRegularSpatialGrid.setYStepSize ( float  ys)
Parameters
ys

◆ setZStepSize()

None CDPL.Math.FRegularSpatialGrid.setZStepSize ( float  zs)
Parameters
zs

◆ getData()

FGrid CDPL.Math.FRegularSpatialGrid.getData ( )
Returns

◆ setCoordinatesTransform()

None CDPL.Math.FRegularSpatialGrid.setCoordinatesTransform ( Matrix4F  xform)
Parameters
xform

◆ getCoordinatesTransform()

Matrix4F CDPL.Math.FRegularSpatialGrid.getCoordinatesTransform ( )
Returns

◆ getCoordinates() [1/2]

None CDPL.Math.FRegularSpatialGrid.getCoordinates ( int  i,
int  j,
int  k,
object  coords 
)
Parameters
i
j
k
coords

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getCoordinates() [2/2]

None CDPL.Math.FRegularSpatialGrid.getCoordinates ( int  i,
object  coords 
)
Parameters
i
coords

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getLocalCoordinates() [1/2]

None CDPL.Math.FRegularSpatialGrid.getLocalCoordinates ( int  i,
int  j,
int  k,
object  coords 
)
Parameters
i
j
k
coords

◆ getLocalCoordinates() [2/2]

None CDPL.Math.FRegularSpatialGrid.getLocalCoordinates ( Vector3F  world_coords,
object  local_coords 
)
Parameters
world_coords
local_coords

◆ containsPoint() [1/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( Vector3F  pos)
Parameters
pos
Returns

◆ containsPoint() [2/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( ConstFVectorExpression  pos)
Parameters
pos
Returns

◆ containsPoint() [3/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( Vector3D  pos)
Parameters
pos
Returns

◆ containsPoint() [4/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( ConstDVectorExpression  pos)
Parameters
pos
Returns

◆ containsPoint() [5/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( Vector3L  pos)
Parameters
pos
Returns

◆ containsPoint() [6/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( ConstLVectorExpression  pos)
Parameters
pos
Returns

◆ containsPoint() [7/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( Vector3UL  pos)
Parameters
pos
Returns

◆ containsPoint() [8/8]

bool CDPL.Math.FRegularSpatialGrid.containsPoint ( ConstULVectorExpression  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [1/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( Vector3F  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [2/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( ConstFVectorExpression  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [3/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( Vector3D  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [4/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( ConstDVectorExpression  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [5/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( Vector3L  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [6/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( ConstLVectorExpression  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [7/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( Vector3UL  pos)
Parameters
pos
Returns

◆ containsLocalPoint() [8/8]

bool CDPL.Math.FRegularSpatialGrid.containsLocalPoint ( ConstULVectorExpression  pos)
Parameters
pos
Returns

◆ getContainingCell() [1/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( Vector3F  pos,
object  indices 
)
Parameters
pos
indices

◆ getContainingCell() [2/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( ConstFVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getContainingCell() [3/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( Vector3D  pos,
object  indices 
)
Parameters
pos
indices

◆ getContainingCell() [4/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( ConstDVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getContainingCell() [5/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( Vector3L  pos,
object  indices 
)
Parameters
pos
indices

◆ getContainingCell() [6/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( ConstLVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getContainingCell() [7/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( Vector3UL  pos,
object  indices 
)
Parameters
pos
indices

◆ getContainingCell() [8/8]

None CDPL.Math.FRegularSpatialGrid.getContainingCell ( ConstULVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [1/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( Vector3F  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [2/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( ConstFVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [3/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( Vector3D  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [4/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( ConstDVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [5/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( Vector3L  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [6/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( ConstLVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [7/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( Vector3UL  pos,
object  indices 
)
Parameters
pos
indices

◆ getLocalContainingCell() [8/8]

None CDPL.Math.FRegularSpatialGrid.getLocalContainingCell ( ConstULVectorExpression  pos,
object  indices 
)
Parameters
pos
indices

◆ getObjectID()

int CDPL.Math.FRegularSpatialGrid.getObjectID ( )

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

Different Python FRegularSpatialGrid 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 FRegularSpatialGrid 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/4]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign ( ConstFGridExpression  e)

Replaces the current state of self with a copy of the state of the ConstFGridExpression instance e.

Parameters
eThe ConstFGridExpression instance to copy.
Returns
self

◆ assign() [2/4]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign ( ConstDGridExpression  e)

Replaces the current state of self with a copy of the state of the ConstDGridExpression instance e.

Parameters
eThe ConstDGridExpression instance to copy.
Returns
self

◆ assign() [3/4]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign ( object  e)

Replaces the current state of self with a copy of the state of the object instance e.

Parameters
eThe object instance to copy.
Returns
self

Reimplemented in CDPL.Grid.FRegularGrid.

◆ assign() [4/4]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.assign ( FRegularSpatialGrid  g)

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

Parameters
gThe FRegularSpatialGrid instance to copy.
Returns
self

◆ getSize1()

int CDPL.Math.FRegularSpatialGrid.getSize1 ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getSize2()

int CDPL.Math.FRegularSpatialGrid.getSize2 ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getSize3()

int CDPL.Math.FRegularSpatialGrid.getSize3 ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ isEmpty()

bool CDPL.Math.FRegularSpatialGrid.isEmpty ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getElement() [1/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getElement() [2/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ toArray()

object CDPL.Math.FRegularSpatialGrid.toArray ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getSize()

int CDPL.Math.FRegularSpatialGrid.getSize ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ swap()

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

◆ setElement() [1/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ setElement() [2/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __call__() [1/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __call__() [2/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __getitem__() [1/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __getitem__() [2/2]

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __len__()

int CDPL.Math.FRegularSpatialGrid.__len__ ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.FRegularSpatialGrid.__eq__ ( ConstFGridExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.FRegularSpatialGrid.__ne__ ( ConstFGridExpression  e)

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

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

◆ __str__()

str CDPL.Math.FRegularSpatialGrid.__str__ ( )

Returns a string representation of the FRegularSpatialGrid instance.

Returns
The generated string representation.

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __pos__()

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__pos__ ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __neg__()

ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__neg__ ( )
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __add__()

ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__add__ ( ConstFGridExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__sub__ ( ConstFGridExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__()

ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __div__()

ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__div__ ( float  t)

Returns the result of the division operation self / t.

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __truediv__()

ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__truediv__ ( float  t)
Parameters
t
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __rmul__()

ConstFGridExpression CDPL.Math.FRegularSpatialGrid.__rmul__ ( float  t)
Parameters
t
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __setitem__() [1/2]

None CDPL.Math.FRegularSpatialGrid.__setitem__ ( tuple  ijk,
float  v 
)
Parameters
ijk
v

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __setitem__() [2/2]

None CDPL.Math.FRegularSpatialGrid.__setitem__ ( int  i,
float  v 
)
Parameters
i
v

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __iadd__() [1/2]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__iadd__ ( FRegularSpatialGrid  g)

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

Parameters
gSpecifies the second addend.
Returns
The updated FRegularSpatialGrid instance self.

◆ __iadd__() [2/2]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__iadd__ ( ConstFGridExpression  e)

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

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

◆ __isub__() [1/2]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__isub__ ( FRegularSpatialGrid  g)

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

Parameters
gSpecifies the subtrahend.
Returns
The updated FRegularSpatialGrid instance self.

◆ __isub__() [2/2]

FRegularSpatialGrid CDPL.Math.FRegularSpatialGrid.__isub__ ( ConstFGridExpression  e)

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

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

◆ __imul__()

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

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

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __idiv__()

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

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

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

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __itruediv__()

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

Reimplemented in CDPL.Grid.FRegularGrid.