CDPL.Math.FScalarGrid Class Reference

Immutable grid where all elements have the same value of type float. More...

Inheritance diagram for CDPL.Math.FScalarGrid:

Public Member Functions
None	__init__ ()
	Constructs an empty scalar grid.
None	__init__ (FScalarGrid g)
	Contructs a copy of the FScalarGrid instance g. More...
None	__init__ (int m, int n, int o, float v=0.0)
	Constructs a scalar grid of size m×n×o in which every element equals v. More...
None	resize (int m, int n, int o)
	Resizes the grid axes to (m, n, o). More...
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 (any axis has zero size). More...
float	getElement (int i, int j, int k)
	Returns the common element value. More...
float	getElement (int i)
	Returns the common element value. More...
object	toArray ()
	Converts the FScalarGrid instance into a corresponding numpy.ndarray object. More...
int	getSize ()
	Returns the total element count \( \mathrm{size}_1 \cdot \mathrm{size}_2 \cdot \mathrm{size}_3 \). More...
FScalarGrid	assign (FScalarGrid g)
	Copy-assigns the axis sizes and common value from g. More...
None	swap (FScalarGrid g)
	Swaps the axis sizes and common value with g. More...
float	__call__ (int i, int j, int k)
	Returns the common element value. More...
float	__call__ (int i)
	Returns the common element value. More...
float	__getitem__ (tuple ijk)
	Returns the common element value. More...
float	__getitem__ (int i)
	Returns the common element value. More...
int	__len__ ()
	Returns the total element count \( \mathrm{size}_1 \cdot \mathrm{size}_2 \cdot \mathrm{size}_3 \). More...
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__ ()
	Returns self. More...
ConstFGridExpression	__neg__ ()
	Returns the result of the operation self * -1. More...
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)
	Returns the result of the true division operation self / t. More...
ConstFGridExpression	__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

Immutable grid where all elements have the same value of type float.

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.FScalarGrid.__init__

(

FScalarGrid

g

)

Contructs 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
	)

Constructs a scalar grid of size m×n×o in which every element equals v.

Parameters

m	The first-axis size.
n	The second-axis size.
o	The third-axis size.
v	The common element value.

Member Function Documentation

resize()

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

Resizes the grid axes to (m, n, o).

Parameters

m	The new first-axis size.
n	The new second-axis size.
o	The new third-axis size.

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

Returns

The size along the first axis.

getSize2()

int CDPL.Math.FScalarGrid.getSize2

(

)

Returns the second-axis size.

Returns

The size along the second axis.

getSize3()

int CDPL.Math.FScalarGrid.getSize3

(

)

Returns the third-axis size.

Returns

The size along the third axis.

isEmpty()

bool CDPL.Math.FScalarGrid.isEmpty

(

)

Tells whether the grid is empty (any axis has zero size).

Returns

True if any axis is zero, and False otherwise.

getElement() [1/2]

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

Returns the common element value.

Parameters

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

Returns

The common element value.

Exceptions

Base.IndexError

if any of the indices is out of range.

getElement() [2/2]

float CDPL.Math.FScalarGrid.getElement

(

int

i

)

Returns the common element value.

Parameters

i	The zero-based linear index.

Returns

The common element value.

Exceptions

Base.IndexError

if i is out of range.

toArray()

object CDPL.Math.FScalarGrid.toArray

(

)

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

Returns

The generated numpy.ndarray object.

See also

[NUMPY]

getSize()

int CDPL.Math.FScalarGrid.getSize

(

)

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

Returns

The total number of elements.

assign()

FScalarGrid CDPL.Math.FScalarGrid.assign

(

FScalarGrid

g

)

Copy-assigns the axis sizes and common value from g.

Parameters

g	The source scalar grid.

Returns

self.

swap()

None CDPL.Math.FScalarGrid.swap

(

FScalarGrid

g

)

Swaps the axis sizes and common value with g.

Parameters

g	The scalar grid to swap with.

__call__() [1/2]

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

Returns the common element value.

Parameters

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

Returns

The common element value.

Exceptions

Base.IndexError

if any of the indices is out of range.

__call__() [2/2]

float CDPL.Math.FScalarGrid.__call__

(

int

i

)

Returns the common element value.

Parameters

i	The zero-based linear index.

Returns

The common element value.

Exceptions

Base.IndexError

if i is out of range.

__getitem__() [1/2]

float CDPL.Math.FScalarGrid.__getitem__

(

tuple

ijk

)

Returns the common element value.

Parameters

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

Returns

The common element value.

Exceptions

Base.IndexError

if any of the indices is out of range.

__getitem__() [2/2]

float CDPL.Math.FScalarGrid.__getitem__

(

int

i

)

Returns the common element value.

Parameters

i	The zero-based linear index.

Returns

The common element value.

Exceptions

Base.IndexError

if i is out of range.

__len__()

int CDPL.Math.FScalarGrid.__len__

(

)

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

Returns

The total number of elements.

__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 self.

Returns

self.

__neg__()

ConstFGridExpression CDPL.Math.FScalarGrid.__neg__

(

)

Returns the result of the operation self * -1.

Returns

A ConstFGridExpression instance holding the result of the element negation.

__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

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstFGridExpression instance holding the result of the division.

__rmul__()

ConstFGridExpression CDPL.Math.FScalarGrid.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstFGridExpression instance holding the result of the multiplication.