CDPL.Math.FScalarGrid Class Reference

Inheritance diagram for CDPL.Math.FScalarGrid:

Public Member Functions
None	__init__ ()
	Initializes the FScalarGrid instance.
None	__init__ (FScalarGrid g)
	Initializes a copy of the FScalarGrid instance g. More...
None	__init__ (int m, int n, int o, float v=0.0)
	Initializes the FScalarGrid 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 ()
FScalarGrid	assign (FScalarGrid g)
	Replaces the current state of self with a copy of the state of the FScalarGrid instance g. More...
None	swap (FScalarGrid 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__ (FScalarGrid 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__ (FScalarGrid 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 FScalarGrid instance. More...
FScalarGrid	__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)

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.FScalarGrid.__init__

(

FScalarGrid

g

)

Initializes a copy of the FScalarGrid instance g.

Parameters

g	The FScalarGrid instance to copy.

__init__() [2/2]

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

Initializes the FScalarGrid instance.

Parameters

m
n
o
v

Member Function Documentation

resize()

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

Parameters

m
n
o

getObjectID()

int CDPL.Math.FScalarGrid.getObjectID

(

)

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

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

(

)

Returns

getSize2()

int CDPL.Math.FScalarGrid.getSize2

(

)

Returns

getSize3()

int CDPL.Math.FScalarGrid.getSize3

(

)

Returns

isEmpty()

bool CDPL.Math.FScalarGrid.isEmpty

(

)

Returns

getElement() [1/2]

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

Parameters

i
j
k

Returns

getElement() [2/2]

float CDPL.Math.FScalarGrid.getElement

(

int

i

)

Parameters

i

Returns

toArray()

object CDPL.Math.FScalarGrid.toArray

(

)

Returns

getSize()

int CDPL.Math.FScalarGrid.getSize

(

)

Returns

assign()

FScalarGrid CDPL.Math.FScalarGrid.assign

(

FScalarGrid

g

)

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

Parameters

g	The FScalarGrid instance to copy.

Returns

self

swap()

None CDPL.Math.FScalarGrid.swap

(

FScalarGrid

g

)

Parameters

g

__call__() [1/2]

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

Parameters

i
j
k

Returns

__call__() [2/2]

float CDPL.Math.FScalarGrid.__call__

(

int

i

)

Parameters

i

Returns

__getitem__() [1/2]

float CDPL.Math.FScalarGrid.__getitem__

(

tuple

ijk

)

Parameters

ijk

Returns

__getitem__() [2/2]

float CDPL.Math.FScalarGrid.__getitem__

(

int

i

)

Parameters

i

Returns

__len__()

int CDPL.Math.FScalarGrid.__len__

(

)

Returns

__eq__() [1/2]

bool CDPL.Math.FScalarGrid.__eq__

(

FScalarGrid

g

)

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

Parameters

g	The FScalarGrid instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

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

bool CDPL.Math.FScalarGrid.__ne__

(

FScalarGrid

g

)

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

Parameters

g	The FScalarGrid instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.FScalarGrid.__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.FScalarGrid.__str__

(

)

Returns a string representation of the FScalarGrid instance.

Returns

The generated string representation.

__pos__()

FScalarGrid CDPL.Math.FScalarGrid.__pos__

(

)

Returns

__neg__()

ConstFGridExpression CDPL.Math.FScalarGrid.__neg__

(

)

Returns

__add__()

ConstFGridExpression CDPL.Math.FScalarGrid.__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.FScalarGrid.__sub__

(

ConstFGridExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A FScalarGrid instance holding the result of the subtraction.

__mul__()

ConstFGridExpression CDPL.Math.FScalarGrid.__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.FScalarGrid.__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.FScalarGrid.__truediv__

(

float

t

)

Parameters

t

Returns

__rmul__()

ConstFGridExpression CDPL.Math.FScalarGrid.__rmul__

(

float

t

)

Parameters

t

Returns