Matrix expression proxy that views a strided rectangular slice of an underlying matrix. More...

Inheritance diagram for CDPL.Math.DMatrixSlice:

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

None	__init__ (DMatrixExpression e, Slice s1, Slice s2)
	Initializes the `DMatrixSlice` instance. More...

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

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

int	getStride1 ()
	Returns the row slice's stride in the wrapped matrix. More...

int	getStride2 ()
	Returns the column slice's stride in the wrapped matrix. More...

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

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

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

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

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

DMatrixSlice	assign (DMatrixSlice s)
	Copy-assigns the contents of s to this matrix slice (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 slice). More...

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

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

float	getElement (int i, int j)

object	toArray ()

None	swap (DMatrixSlice s)
	Swaps the contents of this matrix slice with those of s (via element-wise swap of the underlying matrix elements). More...

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

DMatrixExpression	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__ (DMatrixSlice s)
	Returns the result of the comparison operation `self == s`. More...

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

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

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

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

DMatrixSlice	__pos__ ()

ConstDMatrixExpression	__neg__ ()

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

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

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

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

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

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

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

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

None	__setitem__ (tuple ij, float v)

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

DMatrixSlice	__iadd__ (ConstDMatrixExpression e)
	Adds the elements of the matrix expression e to this matrix slice (via a temporary to handle aliasing). More...

DMatrixSlice	__isub__ (DMatrixSlice s)
	Performs the in-place subtraction operation `self -= s`. More...

DMatrixSlice	__isub__ (ConstDMatrixExpression e)
	Subtracts the elements of the matrix expression e from this matrix slice (via a temporary to handle aliasing). More...

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

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

DMatrixSlice	__itruediv__ (float t)

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

	data = property(getData)

	start1 = property(getStart1)

	start2 = property(getStart2)

	stride1 = property(getStride1)

	stride2 = property(getStride2)

Detailed Description

Matrix expression proxy that views a strided rectangular slice of an underlying matrix.

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.DMatrixSlice.__init__ ( DMatrixSlice s )

Initializes a copy of the DMatrixSlice instance s.

Parameters

s	The `DMatrixSlice` instance to copy.

◆ init() [2/2]

None CDPL.Math.DMatrixSlice.__init__	(	DMatrixExpression	e,
		Slice	s1,
		Slice	s2
	)

Initializes the DMatrixSlice instance.

Parameters

e
s1
s2

Member Function Documentation

◆ getStart1()

int CDPL.Math.DMatrixSlice.getStart1 ( )

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

Returns: The start row index.

◆ getStart2()

int CDPL.Math.DMatrixSlice.getStart2 ( )

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

Returns: The start column index.

◆ getStride1()

int CDPL.Math.DMatrixSlice.getStride1 ( )

Returns the row slice's stride in the wrapped matrix.

Returns: The row stride.

◆ getStride2()

int CDPL.Math.DMatrixSlice.getStride2 ( )

Returns the column slice's stride in the wrapped matrix.

Returns: The column stride.

◆ getObjectID()

int CDPL.Math.DMatrixSlice.getObjectID ( )

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

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

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

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

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [2/6]

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

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

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [3/6]

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

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

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [4/6]

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

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

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [5/6]

DMatrixSlice CDPL.Math.DMatrixSlice.assign ( DMatrixSlice s )

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

Parameters

s	The source matrix slice.

Returns: self

◆ assign() [6/6]

None CDPL.Math.DMatrixSlice.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.DMatrixSlice.getSize1 ( )

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

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.DMatrixSlice.getSize2 ( )

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

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.DMatrixSlice.isEmpty ( )

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

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

◆ swap()

None CDPL.Math.DMatrixSlice.swap ( DMatrixSlice s )

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

Parameters

s	The matrix slice to swap with.

◆ getData()

DMatrixExpression CDPL.Math.DMatrixSlice.getData ( )

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

Returns: A reference to the wrapped matrix closure.

◆ call()

float CDPL.Math.DMatrixSlice.__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(s1(i), s2(j)).

◆ eq() [1/2]

bool CDPL.Math.DMatrixSlice.__eq__ ( DMatrixSlice s )

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

Parameters

s	The `DMatrixSlice` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.DMatrixSlice.__eq__ ( ConstDMatrixExpression e )

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

Parameters

e	The `ConstDMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.DMatrixSlice.__ne__ ( DMatrixSlice s )

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

Parameters

s	The `DMatrixSlice` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.DMatrixSlice.__ne__ ( ConstDMatrixExpression e )

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

Parameters

e	The `ConstDMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.DMatrixSlice.__str__ ( )

Returns a string representation of the DMatrixSlice instance.

Returns: The generated string representation.

◆ add()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__add__ ( ConstDMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__sub__ ( ConstDMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/3]

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__mul__ ( ConstDMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ mul() [3/3]

ConstDVectorExpression CDPL.Math.DMatrixSlice.__mul__ ( ConstDVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__div__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ iadd() [1/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__iadd__ ( DMatrixSlice s )

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

Parameters

s	Specifies the second addend.

Returns: The updated DMatrixSlice instance self.

◆ iadd() [2/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__iadd__ ( ConstDMatrixExpression e )

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

Parameters

e	The source matrix expression.

Returns: self

◆ isub() [1/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__isub__ ( DMatrixSlice s )

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

Parameters

s	Specifies the subtrahend.

Returns: The updated DMatrixSlice instance self.

◆ isub() [2/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__isub__ ( ConstDMatrixExpression e )

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

Parameters

e	The source matrix expression.

Returns: self

◆ imul()

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

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

Parameters

t	The scalar multiplier.

Returns: self

◆ idiv()

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

Divides every element of this matrix slice 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()

◆ getStride1()

◆ getStride2()

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