Matrix expression proxy that views a contiguous rectangular subrange of an underlying matrix. More...

Inheritance diagram for CDPL.Math.FMatrixRange:

Public Member Functions
None	__init__ (FMatrixRange r)
	Initializes a copy of the `FMatrixRange` instance r. More...

None	__init__ (FMatrixExpression e, Range r1, Range r2)
	Initializes the `FMatrixRange` instance. More...

int	getStart1 ()
	Returns the row index range's start index in the wrapped matrix. More...

int	getStart2 ()
	Returns the column index range's start index in the wrapped matrix. More...

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

FMatrixRange	assign (ConstFMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix range without intermediate temporary. More...

FMatrixRange	assign (ConstDMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix range without intermediate temporary. More...

FMatrixRange	assign (ConstLMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix range without intermediate temporary. More...

FMatrixRange	assign (ConstULMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix range without intermediate temporary. More...

FMatrixRange	assign (FMatrixRange r)
	Copy-assigns the contents of r to this matrix range (via a temporary to handle aliasing). More...

None	assign (object a)
	Replaces the current state of self with a copy of the state of the `object` instance a. More...

int	getSize1 ()
	Returns the number of rows in the proxy (size of the row range). More...

int	getSize2 ()
	Returns the number of columns in the proxy (size of the column range). More...

bool	isEmpty ()
	Tells whether the proxy is empty (either range has size zero). More...

float	getElement (int i, int j)

object	toArray ()

None	swap (FMatrixRange r)
	Swaps the contents of this matrix range with those of r (via element-wise swap of the underlying matrix elements). More...

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

FMatrixExpression	getData ()
	Returns a reference to the wrapped matrix (via its stored closure). More...

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

float	__getitem__ (tuple ij)

int	__len__ ()

bool	__eq__ (FMatrixRange r)
	Returns the result of the comparison operation `self == r`. More...

bool	__eq__ (ConstFMatrixExpression e)
	Returns the result of the comparison operation `self == e`. More...

bool	__ne__ (FMatrixRange r)
	Returns the result of the comparison operation `self != r`. More...

bool	__ne__ (ConstFMatrixExpression e)
	Returns the result of the comparison operation `self != e`. More...

str	__str__ ()
	Returns a string representation of the `FMatrixRange` instance. More...

FMatrixRange	__pos__ ()

ConstFMatrixExpression	__neg__ ()

ConstFMatrixExpression	__add__ (ConstFMatrixExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstFMatrixExpression	__sub__ (ConstFMatrixExpression e)
	Returns the result of the subtraction operation `self - e`. More...

ConstFMatrixExpression	__mul__ (float t)
	Returns the result of the multiplication operation `self * t`. More...

ConstFMatrixExpression	__mul__ (ConstFMatrixExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstFVectorExpression	__mul__ (ConstFVectorExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstFMatrixExpression	__div__ (float t)
	Returns the result of the division operation `self // t`. More...

ConstFMatrixExpression	__truediv__ (float t)
	Returns the result of the true division operation `self / t`. More...

ConstFMatrixExpression	__rmul__ (float t)
	Returns the result of the multiplication operation `t * self`. More...

None	__setitem__ (tuple ij, float v)

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

FMatrixRange	__iadd__ (ConstFMatrixExpression e)
	Adds the elements of the matrix expression e to this matrix range (via a temporary to handle aliasing). More...

FMatrixRange	__isub__ (FMatrixRange r)
	Performs the in-place subtraction operation `self -= r`. More...

FMatrixRange	__isub__ (ConstFMatrixExpression e)
	Subtracts the elements of the matrix expression e from this matrix range (via a temporary to handle aliasing). More...

FMatrixRange	__imul__ (float t)
	Multiplies every element of this matrix range by the scalar t. More...

FMatrixRange	__idiv__ (float t)
	Divides every element of this matrix range by the scalar t. More...

FMatrixRange	__itruediv__ (float t)

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

	data = property(getData)

	start1 = property(getStart1)

	start2 = property(getStart2)

Detailed Description

Matrix expression proxy that views a contiguous rectangular subrange of an underlying matrix.

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.FMatrixRange.__init__ ( FMatrixRange r )

Initializes a copy of the FMatrixRange instance r.

Parameters

r	The `FMatrixRange` instance to copy.

◆ init() [2/2]

None CDPL.Math.FMatrixRange.__init__	(	FMatrixExpression	e,
		Range	r1,
		Range	r2
	)

Initializes the FMatrixRange instance.

Parameters

e
r1
r2

Member Function Documentation

◆ getStart1()

int CDPL.Math.FMatrixRange.getStart1 ( )

Returns the row index range's start index in the wrapped matrix.

Returns: The start row index.

◆ getStart2()

int CDPL.Math.FMatrixRange.getStart2 ( )

Returns the column index range's start index in the wrapped matrix.

Returns: The start column index.

◆ getObjectID()

int CDPL.Math.FMatrixRange.getObjectID ( )

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

Different Python FMatrixRange 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 FMatrixRange 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/6]

FMatrixRange CDPL.Math.FMatrixRange.assign ( ConstFMatrixExpression e )

Assigns the elements of the matrix expression e to this matrix range without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [2/6]

FMatrixRange CDPL.Math.FMatrixRange.assign ( ConstDMatrixExpression e )

Assigns the elements of the matrix expression e to this matrix range without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [3/6]

FMatrixRange CDPL.Math.FMatrixRange.assign ( ConstLMatrixExpression e )

Assigns the elements of the matrix expression e to this matrix range without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [4/6]

FMatrixRange CDPL.Math.FMatrixRange.assign ( ConstULMatrixExpression e )

Assigns the elements of the matrix expression e to this matrix range without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [5/6]

FMatrixRange CDPL.Math.FMatrixRange.assign ( FMatrixRange r )

Copy-assigns the contents of r to this matrix range (via a temporary to handle aliasing).

Parameters

r	The source matrix range.

Returns: self

◆ assign() [6/6]

None CDPL.Math.FMatrixRange.assign ( object a )

Replaces the current state of self with a copy of the state of the object instance a.

Parameters

a	The `object` instance to copy.

Returns: self

◆ getSize1()

int CDPL.Math.FMatrixRange.getSize1 ( )

Returns the number of rows in the proxy (size of the row range).

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.FMatrixRange.getSize2 ( )

Returns the number of columns in the proxy (size of the column range).

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.FMatrixRange.isEmpty ( )

Tells whether the proxy is empty (either range has size zero).

Returns: True if either range has zero size, and False otherwise.

◆ swap()

None CDPL.Math.FMatrixRange.swap ( FMatrixRange r )

Swaps the contents of this matrix range with those of r (via element-wise swap of the underlying matrix elements).

Parameters

r	The matrix range to swap with.

◆ getData()

FMatrixExpression CDPL.Math.FMatrixRange.getData ( )

Returns a reference to the wrapped matrix (via its stored closure).

Returns: A reference to the wrapped matrix closure.

◆ call()

float CDPL.Math.FMatrixRange.__call__	(	int	i,
		int	j
	)

Returns a reference to the element at proxy index (i, j).

Parameters

i	The zero-based proxy row index.
j	The zero-based proxy column index.

Returns: A reference to the underlying element m(r1(i), r2(j)).

◆ eq() [1/2]

bool CDPL.Math.FMatrixRange.__eq__ ( FMatrixRange r )

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

Parameters

r	The `FMatrixRange` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.FMatrixRange.__eq__ ( ConstFMatrixExpression e )

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

Parameters

e	The `ConstFMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.FMatrixRange.__ne__ ( FMatrixRange r )

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

Parameters

r	The `FMatrixRange` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.FMatrixRange.__ne__ ( ConstFMatrixExpression e )

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

Parameters

e	The `ConstFMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.FMatrixRange.__str__ ( )

Returns a string representation of the FMatrixRange instance.

Returns: The generated string representation.

◆ add()

ConstFMatrixExpression CDPL.Math.FMatrixRange.__add__ ( ConstFMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns: A ConstFMatrixExpression instance holding the result of the addition.

◆ sub()

ConstFMatrixExpression CDPL.Math.FMatrixRange.__sub__ ( ConstFMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstFMatrixExpression CDPL.Math.FMatrixRange.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A ConstFMatrixExpression instance holding the result of the multiplication.

◆ mul() [2/3]

ConstFMatrixExpression CDPL.Math.FMatrixRange.__mul__ ( ConstFMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstFMatrixExpression instance holding the result of the multiplication.

◆ mul() [3/3]

ConstFVectorExpression CDPL.Math.FMatrixRange.__mul__ ( ConstFVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstFVectorExpression instance holding the result of the multiplication.

◆ div()

ConstFMatrixExpression CDPL.Math.FMatrixRange.__div__ ( float t )

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

Parameters

t	Specifies the divisor.

Returns: A ConstFMatrixExpression instance holding the result of the division.

◆ truediv()

ConstFMatrixExpression CDPL.Math.FMatrixRange.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

Returns: A ConstFMatrixExpression instance holding the result of the division.

◆ rmul()

ConstFMatrixExpression CDPL.Math.FMatrixRange.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstFMatrixExpression instance holding the result of the multiplication.

◆ iadd() [1/2]

FMatrixRange CDPL.Math.FMatrixRange.__iadd__ ( FMatrixRange r )

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

Parameters

r	Specifies the second addend.

Returns: The updated FMatrixRange instance self.

◆ iadd() [2/2]

FMatrixRange CDPL.Math.FMatrixRange.__iadd__ ( ConstFMatrixExpression e )

Adds the elements of the matrix expression e to this matrix range (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self

◆ isub() [1/2]

FMatrixRange CDPL.Math.FMatrixRange.__isub__ ( FMatrixRange r )

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

Parameters

r	Specifies the subtrahend.

Returns: The updated FMatrixRange instance self.

◆ isub() [2/2]

FMatrixRange CDPL.Math.FMatrixRange.__isub__ ( ConstFMatrixExpression e )

Subtracts the elements of the matrix expression e from this matrix range (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self

◆ imul()

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

Multiplies every element of this matrix range by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self

◆ idiv()

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

Divides every element of this matrix range by the scalar t.

Parameters

t	The scalar divisor.

Returns: self

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getStart1()

◆ getStart2()

◆ getObjectID()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ getSize1()

◆ getSize2()

◆ isEmpty()

◆ swap()

◆ getData()

◆ __call__()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __str__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/3]

◆ __mul__() [2/3]

◆ __mul__() [3/3]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ init() [1/2]

◆ init() [2/2]

◆ call()

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ str()

◆ add()

◆ sub()

◆ mul() [1/3]

◆ mul() [2/3]

◆ mul() [3/3]

◆ div()

◆ truediv()

◆ rmul()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()