CDPL.Math.ConstFGridExpression Class Reference

Inheritance diagram for CDPL.Math.ConstFGridExpression:

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__ (ConstFGridExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (ConstFGridExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the ConstFGridExpression instance. More...
ConstFGridExpression	__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)

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

Member Function Documentation

getObjectID()

int CDPL.Math.ConstFGridExpression.getObjectID

(

)

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

Different Python ConstFGridExpression 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 ConstFGridExpression 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.ConstFGridExpression.getSize1

(

)

Returns

getSize2()

int CDPL.Math.ConstFGridExpression.getSize2

(

)

Returns

getSize3()

int CDPL.Math.ConstFGridExpression.getSize3

(

)

Returns

isEmpty()

bool CDPL.Math.ConstFGridExpression.isEmpty

(

)

Returns

getElement()

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

Parameters

i
j
k

Returns

toArray()

object CDPL.Math.ConstFGridExpression.toArray

(

)

Returns

__call__()

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

Parameters

i
j
k

Returns

__getitem__()

float CDPL.Math.ConstFGridExpression.__getitem__

(

tuple

ijk

)

Parameters

ijk

Returns

__len__()

int CDPL.Math.ConstFGridExpression.__len__

(

)

Returns

__eq__()

bool CDPL.Math.ConstFGridExpression.__eq__

(

ConstFGridExpression

e

)

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

Parameters

e	The ConstFGridExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__()

bool CDPL.Math.ConstFGridExpression.__ne__

(

ConstFGridExpression

e

)

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

Parameters

e	The ConstFGridExpression instance to be compared with.

Returns

The result of the comparison operation.

__str__()

str CDPL.Math.ConstFGridExpression.__str__

(

)

Returns a string representation of the ConstFGridExpression instance.

Returns

The generated string representation.

__pos__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__pos__

(

)

Returns

__neg__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__neg__

(

)

Returns

__add__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__add__

(

ConstFGridExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstFGridExpression instance holding the result of the addition.

__sub__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__sub__

(

ConstFGridExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A ConstFGridExpression instance holding the result of the subtraction.

__mul__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstFGridExpression instance holding the result of the multiplication.

__div__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__div__

(

float

t

)

Returns the result of the division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstFGridExpression instance holding the result of the division.

__truediv__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__truediv__

(

float

t

)

Parameters

t

Returns

__rmul__()

ConstFGridExpression CDPL.Math.ConstFGridExpression.__rmul__

(

float

t

)

Parameters

t

Returns