Unbounded dense grid storing floating point values of type float. More...

Inheritance diagram for CDPL.Math.FGrid:

Public Member Functions
None	__init__ ()
	Constructs an empty grid (zero size on every axis).

None	__init__ (FGrid g)
	Move-constructs a grid from g (g is left in a valid empty state). More...

None	__init__ (int m, int n, int o)
	Constructs an m × n × o grid with default-initialized elements. More...

None	__init__ (int m, int n, int o, float v)
	Constructs an m × n × o grid with every element initialized to v. More...

None	__init__ (ConstFGridExpression e)
	Initializes the `FGrid` instance. More...

None	__init__ (ConstDGridExpression e)
	Initializes the `FGrid` instance. More...

None	__init__ (object e)
	Initializes the `FGrid` instance. More...

None	resize (int m, int n, int o, bool preserve=True, float v=0.0)
	Resizes the grid to \( m \times n \times o \) cells. More...

None	clear (float v=0.0)
	Sets every cell of the grid to the value v. More...

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

FGrid	assign (ConstFGridExpression e)
	Resizes this grid to match e and assigns its cells without intermediate temporary. More...

FGrid	assign (ConstDGridExpression e)
	Resizes this grid to match e and assigns its cells without intermediate temporary. More...

FGrid	assign (object e)
	Resizes this grid to match e and assigns its cells without intermediate temporary. More...

FGrid	assign (FGrid g)
	Move-assigns the contents of g to this grid. 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)

float	getElement (int i)

object	toArray ()

int	getSize ()
	Returns the total cell count \( \mathrm{size}_1 \cdot \mathrm{size}_2 \cdot \mathrm{size}_3 \). More...

None	swap (FGrid g)
	Swaps the contents of this grid with those of g. More...

None	setElement (int i, int j, int k, float v)

None	setElement (int i, float v)

float	__call__ (int i, int j, int k)
	Returns a reference to the element at (i, j, k). More...

float	__call__ (int i)
	Returns a reference to the element at linear index i. More...

float	__getitem__ (tuple ijk)

float	__getitem__ (int i)

int	__len__ ()

bool	__eq__ (FGrid 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__ (FGrid 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 `FGrid` instance. More...

FGrid	__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)
	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...

None	__setitem__ (tuple ijk, float v)

None	__setitem__ (int i, float v)

FGrid	__iadd__ (FGrid g)
	Performs the in-place addition operation `self += g`. More...

FGrid	__iadd__ (ConstFGridExpression e)
	Performs the in-place addition operation `self += e`. More...

FGrid	__isub__ (FGrid g)
	Performs the in-place subtraction operation `self -= g`. More...

FGrid	__isub__ (ConstFGridExpression e)
	Performs the in-place subtraction operation `self -= e`. More...

FGrid	__imul__ (float t)
	Performs the in-place multiplication operation `self *= t`. More...

FGrid	__idiv__ (float t)
	Performs the in-place division operation `self /= t`. More...

FGrid	__itruediv__ (float t)

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

	size3 = property(getSize3)

Detailed Description

Unbounded dense grid storing floating point values of type float.

Constructor & Destructor Documentation

◆ init() [1/6]

None CDPL.Math.FGrid.__init__ ( FGrid g )

Move-constructs a grid from g (g is left in a valid empty state).

Parameters

g	The grid to move from.

◆ init() [2/6]

None CDPL.Math.FGrid.__init__	(	int	m,
		int	n,
		int	o
	)

Constructs an m × n × o grid with default-initialized elements.

Parameters

m	The size along the first axis.
n	The size along the second axis.
o	The size along the third axis.

◆ init() [3/6]

None CDPL.Math.FGrid.__init__	(	int	m,
		int	n,
		int	o,
		float	v
	)

Constructs an m × n × o grid with every element initialized to v.

Parameters

m	The size along the first axis.
n	The size along the second axis.
o	The size along the third axis.
v	The element value used to initialize every cell.

◆ init() [4/6]

None CDPL.Math.FGrid.__init__ ( ConstFGridExpression e )

Initializes the FGrid instance.

Parameters

e

◆ init() [5/6]

None CDPL.Math.FGrid.__init__ ( ConstDGridExpression e )

Initializes the FGrid instance.

Parameters

e

◆ init() [6/6]

None CDPL.Math.FGrid.__init__ ( object e )

Initializes the FGrid instance.

Parameters

e

Member Function Documentation

◆ resize()

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

Resizes the grid to \( m \times n \times o \) cells.

Parameters

m	The new first-axis size.
n	The new second-axis size.
o	The new third-axis size.
preserve	If `True`, existing cell values at indices that remain valid are kept. If `False`, all cells are set to v.
v	The fill value for newly added cells (or for all cells when preserve is `False`).

◆ clear()

None CDPL.Math.FGrid.clear ( float v = 0.0 )

Sets every cell of the grid to the value v.

Parameters

v	The fill value.

◆ getObjectID()

int CDPL.Math.FGrid.getObjectID ( )

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

Different Python FGrid 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 FGrid 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]

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

Resizes this grid to match e and assigns its cells without intermediate temporary.

Parameters

e	The source grid expression.

Returns: self

◆ assign() [2/4]

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

Resizes this grid to match e and assigns its cells without intermediate temporary.

Parameters

e	The source grid expression.

Returns: self

◆ assign() [3/4]

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

Resizes this grid to match e and assigns its cells without intermediate temporary.

Parameters

e	The source grid expression.

Returns: self

◆ assign() [4/4]

FGrid CDPL.Math.FGrid.assign ( FGrid g )

Move-assigns the contents of g to this grid.

Parameters

g	The source grid (left in a valid but unspecified state).

Returns: self

◆ getSize1()

int CDPL.Math.FGrid.getSize1 ( )

Returns the first-axis size.

Returns: The size along the first axis.

◆ getSize2()

int CDPL.Math.FGrid.getSize2 ( )

Returns the second-axis size.

Returns: The size along the second axis.

◆ getSize3()

int CDPL.Math.FGrid.getSize3 ( )

Returns the third-axis size.

Returns: The size along the third axis.

◆ isEmpty()

bool CDPL.Math.FGrid.isEmpty ( )

Tells whether the grid is empty.

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

◆ getElement() [1/2]

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

Parameters

i
j
k

Returns

◆ getElement() [2/2]

float CDPL.Math.FGrid.getElement ( int i )

Parameters

i

Returns

◆ toArray()

object CDPL.Math.FGrid.toArray ( )

Returns

◆ getSize()

int CDPL.Math.FGrid.getSize ( )

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

Returns: The total number of cells.

◆ swap()

None CDPL.Math.FGrid.swap ( FGrid g )

Swaps the contents of this grid with those of g.

Parameters

g	The grid to swap with.

◆ setElement() [1/2]

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

Parameters

i
j
k
v

◆ setElement() [2/2]

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

Parameters

i
v

◆ call() [1/2]

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

Returns a reference to 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: A reference to the cell.

Exceptions

Base.IndexError if any of the indices is out of range.

◆ call() [2/2]

float CDPL.Math.FGrid.__call__ ( int i )

Returns a reference to the element at linear index i.

Parameters

i	The zero-based linear index.

Returns: A reference to the cell.

Exceptions

Base.IndexError if i is out of range.

◆ getitem() [1/2]

float CDPL.Math.FGrid.__getitem__ ( tuple ijk )

Parameters

ijk

Returns

◆ getitem() [2/2]

float CDPL.Math.FGrid.__getitem__ ( int i )

Parameters

i

Returns

◆ len()

int CDPL.Math.FGrid.__len__ ( )

Returns

◆ eq() [1/2]

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

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

Parameters

g	The `FGrid` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.FGrid.__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.FGrid.__ne__ ( FGrid g )

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

Parameters

g	The `FGrid` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.FGrid.__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.FGrid.__str__ ( )

Returns a string representation of the FGrid instance.

Returns: The generated string representation.

◆ pos()

FGrid CDPL.Math.FGrid.__pos__ ( )

Returns

◆ neg()

ConstFGridExpression CDPL.Math.FGrid.__neg__ ( )

Returns

◆ add()

ConstFGridExpression CDPL.Math.FGrid.__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.FGrid.__sub__ ( ConstFGridExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns: A FGrid instance holding the result of the subtraction.

◆ mul()

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

◆ setitem() [1/2]

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

Parameters

ijk
v

◆ setitem() [2/2]

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

Parameters

i
v

◆ iadd() [1/2]

FGrid CDPL.Math.FGrid.__iadd__ ( FGrid g )

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

Parameters

g	Specifies the second addend.

Returns: The updated FGrid instance self.

◆ iadd() [2/2]

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

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

Parameters

e	Specifies the second addend.

Returns: The updated FGrid instance self.

◆ isub() [1/2]

FGrid CDPL.Math.FGrid.__isub__ ( FGrid g )

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

Parameters

g	Specifies the subtrahend.

Returns: The updated FGrid instance self.

◆ isub() [2/2]

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

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

Parameters

e	Specifies the subtrahend.

Returns: The updated FGrid instance self.

◆ imul()

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

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

Parameters

t	Specifies the multiplier.

Returns: The updated FGrid instance self.

◆ idiv()

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

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

Parameters

t	Specifies the divisor.

Returns: The updated FGrid instance self.

◆ itruediv()

FGrid CDPL.Math.FGrid.__itruediv__ ( float t )

Parameters

t

Returns

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/6]

◆ __init__() [2/6]

◆ __init__() [3/6]

◆ __init__() [4/6]

◆ __init__() [5/6]

◆ __init__() [6/6]

Member Function Documentation

◆ resize()

◆ clear()

◆ getObjectID()

◆ assign() [1/4]

◆ assign() [2/4]

◆ assign() [3/4]

◆ assign() [4/4]

◆ getSize1()

◆ getSize2()

◆ getSize3()

◆ isEmpty()

◆ getElement() [1/2]

◆ getElement() [2/2]

◆ toArray()

◆ getSize()

◆ swap()

◆ setElement() [1/2]

◆ setElement() [2/2]

◆ __call__() [1/2]

◆ __call__() [2/2]

◆ __getitem__() [1/2]

◆ __getitem__() [2/2]

◆ __len__()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__()

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __setitem__() [1/2]

◆ __setitem__() [2/2]

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

◆ init() [1/6]

◆ init() [2/6]

◆ init() [3/6]

◆ init() [4/6]

◆ init() [5/6]

◆ init() [6/6]

◆ call() [1/2]

◆ call() [2/2]

◆ getitem() [1/2]

◆ getitem() [2/2]

◆ len()

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul()

◆ div()

◆ truediv()

◆ rmul()

◆ setitem() [1/2]

◆ setitem() [2/2]

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()