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

Inheritance diagram for CDPL.Math.ConstULMatrixRange:

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

None	__init__ (ConstULMatrixExpression e, Range r1, Range r2)
	Initializes the `ConstULMatrixRange` 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...

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

int	getElement (int i, int j)

object	toArray ()

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

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

int	__getitem__ (tuple ij)

int	__len__ ()

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

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

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

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

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

ConstULMatrixRange	__pos__ ()

ConstULMatrixExpression	__neg__ ()

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

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

ConstULMatrixExpression	__mul__ (int t)
	Returns the result of the multiplication operation `self * t`. More...

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

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

ConstULMatrixExpression	__div__ (int t)
	Returns the result of the division operation `self // t`. More...

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

ConstULMatrixExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

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.ConstULMatrixRange.__init__ ( ConstULMatrixRange r )

Initializes a copy of the ConstULMatrixRange instance r.

Parameters

r	The `ConstULMatrixRange` instance to copy.

◆ init() [2/2]

None CDPL.Math.ConstULMatrixRange.__init__	(	ConstULMatrixExpression	e,
		Range	r1,
		Range	r2
	)

Initializes the ConstULMatrixRange instance.

Parameters

e
r1
r2

Member Function Documentation

◆ getStart1()

int CDPL.Math.ConstULMatrixRange.getStart1 ( )

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

Returns: The start row index.

◆ getStart2()

int CDPL.Math.ConstULMatrixRange.getStart2 ( )

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

Returns: The start column index.

◆ getObjectID()

int CDPL.Math.ConstULMatrixRange.getObjectID ( )

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

Different Python ConstULMatrixRange 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 ConstULMatrixRange 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.ConstULMatrixRange.getSize1 ( )

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

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.ConstULMatrixRange.getSize2 ( )

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

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.ConstULMatrixRange.isEmpty ( )

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

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

◆ getData()

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.getData ( )

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

Returns: A reference to the wrapped matrix closure.

◆ call()

int CDPL.Math.ConstULMatrixRange.__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.ConstULMatrixRange.__eq__ ( ConstULMatrixRange r )

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

Parameters

r	The `ConstULMatrixRange` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.ConstULMatrixRange.__eq__ ( ConstULMatrixExpression e )

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

Parameters

e	The `ConstULMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

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

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

Parameters

r	The `ConstULMatrixRange` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.ConstULMatrixRange.__ne__ ( ConstULMatrixExpression e )

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

Parameters

e	The `ConstULMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.ConstULMatrixRange.__str__ ( )

Returns a string representation of the ConstULMatrixRange instance.

Returns: The generated string representation.

◆ add()

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.__add__ ( ConstULMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.__sub__ ( ConstULMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/3]

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.__mul__ ( ConstULMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ mul() [3/3]

ConstULVectorExpression CDPL.Math.ConstULMatrixRange.__mul__ ( ConstULVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstULMatrixExpression CDPL.Math.ConstULMatrixRange.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getStart1()

◆ getStart2()

◆ getObjectID()

◆ getSize1()

◆ getSize2()

◆ isEmpty()

◆ 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__()

◆ 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()