CDPL.Math.ConstDGridExpression Class Reference

Represents the outcome of mathematical expressions/operations that result in a 3D grid. More...

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 ()
	Returns the first-axis size. More...
int	getSize2 ()
	Returns the second-axis size. More...
int	getSize3 ()
	Returns the third-axis size. More...
bool	isEmpty ()
	Tells whether the grid is empty. More...
float	getElement (int i, int j, int k)
	Returns the element at (i, j, k). More...
object	toArray ()
	Converts the ConstDGridExpression instance into a corresponding numpy.ndarray object. More...
float	__call__ (int i, int j, int k)
	Returns the element at (i, j, k). More...
float	__getitem__ (tuple ijk)
	Returns the element at (i, j, k). More...
int	__len__ ()
	Returns the total element count \( \mathrm{size}_1 \cdot \mathrm{size}_2 \cdot \mathrm{size}_3 \). More...
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__ ()
	Returns self. More...
ConstDGridExpression	__neg__ ()
	Returns the result of the operation self * -1. More...
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)
	Returns the result of the true division operation self / t. More...
ConstDGridExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. More...

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

Detailed Description

Represents the outcome of mathematical expressions/operations that result in a 3D grid.

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 the first-axis size.

Returns

The size along the first axis.

getSize2()

int CDPL.Math.ConstDGridExpression.getSize2

(

)

Returns the second-axis size.

Returns

The size along the second axis.

getSize3()

int CDPL.Math.ConstDGridExpression.getSize3

(

)

Returns the third-axis size.

Returns

The size along the third axis.

isEmpty()

bool CDPL.Math.ConstDGridExpression.isEmpty

(

)

Tells whether the grid is empty.

Returns

True if the underlying storage holds no elements, and False otherwise.

getElement()

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

Returns the element at (i, j, k).

Parameters

i	The zero-based first-axis index.
j	The zero-based second-axis index.
k	The zero-based third-axis index.

Returns

The value of the element.

Exceptions

Base.IndexError

if any of the indices is out of range.

toArray()

object CDPL.Math.ConstDGridExpression.toArray

(

)

Converts the ConstDGridExpression instance into a corresponding numpy.ndarray object.

Returns

The generated numpy.ndarray object.

See also

[NUMPY]

__call__()

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

Returns the element at (i, j, k).

Parameters

i	The zero-based first-axis index.
j	The zero-based second-axis index.
k	The zero-based third-axis index.

Returns

The value of the element.

Exceptions

Base.IndexError

if any of the indices is out of range.

__getitem__()

float CDPL.Math.ConstDGridExpression.__getitem__

(

tuple

ijk

)

Returns the element at (i, j, k).

Parameters

i	The zero-based first-axis index.
j	The zero-based second-axis index.
k	The zero-based third-axis index.

Returns

The value of the element.

Exceptions

Base.IndexError

if any of the indices is out of range.

__len__()

int CDPL.Math.ConstDGridExpression.__len__

(

)

Returns the total element count \( \mathrm{size}_1 \cdot \mathrm{size}_2 \cdot \mathrm{size}_3 \).

Returns

The total number of elements.

__eq__()

bool CDPL.Math.ConstDGridExpression.__eq__

(

ConstDGridExpression

e

)

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

Parameters

e	The 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

e	The 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 self.

Returns

self.

__neg__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__neg__

(

)

Returns the result of the operation self * -1.

Returns

A ConstDGridExpression instance holding the result of the element negation.

__add__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__add__

(

ConstDGridExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies 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

e	Specifies 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

t	Specifies 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

t	Specifies the divisor.

Returns

A ConstDGridExpression instance holding the result of the division.

__truediv__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__truediv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDGridExpression instance holding the result of the division.

__rmul__()

ConstDGridExpression CDPL.Math.ConstDGridExpression.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstDGridExpression instance holding the result of the multiplication.