CDPL.Math.DScalarGrid Class Reference

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

Inheritance diagram for CDPL.Math.DScalarGrid:

Public Member Functions
None	__init__ ()
	Constructs an empty scalar grid.
None	__init__ (DScalarGrid g)
	Contructs a copy of the DScalarGrid 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 DScalarGrid 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...
DScalarGrid	assign (DScalarGrid g)
	Copy-assigns the axis sizes and common value from g. More...
None	swap (DScalarGrid 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__ (DScalarGrid g)
	Returns the result of the comparison operation self == g. More...
bool	__eq__ (ConstDGridExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (DScalarGrid g)
	Returns the result of the comparison operation self != g. More...
bool	__ne__ (ConstDGridExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the DScalarGrid instance. More...
DScalarGrid	__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

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

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.DScalarGrid.__init__

(

DScalarGrid

g

)

Contructs a copy of the DScalarGrid instance g.

Parameters

g	The DScalarGrid instance to copy.

__init__() [2/2]

None CDPL.Math.DScalarGrid.__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.DScalarGrid.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.DScalarGrid.getObjectID

(

)

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

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

(

)

Returns the first-axis size.

Returns

The size along the first axis.

getSize2()

int CDPL.Math.DScalarGrid.getSize2

(

)

Returns the second-axis size.

Returns

The size along the second axis.

getSize3()

int CDPL.Math.DScalarGrid.getSize3

(

)

Returns the third-axis size.

Returns

The size along the third axis.

isEmpty()

bool CDPL.Math.DScalarGrid.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.DScalarGrid.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.DScalarGrid.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.DScalarGrid.toArray

(

)

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

Returns

The generated numpy.ndarray object.

See also

[NUMPY]

getSize()

int CDPL.Math.DScalarGrid.getSize

(

)

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

Returns

The total number of elements.

assign()

DScalarGrid CDPL.Math.DScalarGrid.assign

(

DScalarGrid

g

)

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

Parameters

g	The source scalar grid.

Returns

self.

swap()

None CDPL.Math.DScalarGrid.swap

(

DScalarGrid

g

)

Swaps the axis sizes and common value with g.

Parameters

g	The scalar grid to swap with.

__call__() [1/2]

float CDPL.Math.DScalarGrid.__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.DScalarGrid.__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.DScalarGrid.__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.DScalarGrid.__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.DScalarGrid.__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.DScalarGrid.__eq__

(

DScalarGrid

g

)

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

Parameters

g	The DScalarGrid instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

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

bool CDPL.Math.DScalarGrid.__ne__

(

DScalarGrid

g

)

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

Parameters

g	The DScalarGrid instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

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

(

)

Returns a string representation of the DScalarGrid instance.

Returns

The generated string representation.

__pos__()

DScalarGrid CDPL.Math.DScalarGrid.__pos__

(

)

Returns self.

Returns

self.

__neg__()

ConstDGridExpression CDPL.Math.DScalarGrid.__neg__

(

)

Returns the result of the operation self * -1.

Returns

A ConstDGridExpression instance holding the result of the element negation.

__add__()

ConstDGridExpression CDPL.Math.DScalarGrid.__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.DScalarGrid.__sub__

(

ConstDGridExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A DScalarGrid instance holding the result of the subtraction.

__mul__()

ConstDGridExpression CDPL.Math.DScalarGrid.__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.DScalarGrid.__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.DScalarGrid.__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.DScalarGrid.__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.