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

Inheritance diagram for CDPL.Math.FMatrixSlice:

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

None	__init__ (FMatrixExpression m, Slice s1, Slice s2)
	Constructs the matrix slice proxy viewing rows in s1 and columns in s2 of m. 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...

FMatrixSlice	assign (ConstFMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix slice (via a temporary to handle aliasing). More...

FMatrixSlice	assign (ConstDMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix slice (via a temporary to handle aliasing). More...

FMatrixSlice	assign (ConstLMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix slice (via a temporary to handle aliasing). More...

FMatrixSlice	assign (ConstULMatrixExpression e)
	Assigns the elements of the matrix expression e to this matrix slice (via a temporary to handle aliasing). More...

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

None	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this matrix slice. 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)
	Returns the element at proxy index (i, j). More...

object	toArray ()
	Converts the `FMatrixSlice` instance into a corresponding `numpy.ndarray` object. More...

None	swap (FMatrixSlice 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)
	Sets the value of the element at proxy index (i, j) to v. More...

FMatrixExpression	getData ()
	Returns the wrapped matrix. More...

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

float	__getitem__ (tuple ij)
	Returns the element at proxy index (i, j). More...

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

bool	__eq__ (FMatrixSlice s)
	Returns the result of the comparison operation `self == s`. More...

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

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

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

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

FMatrixSlice	__pos__ ()
	Returns self. More...

ConstFMatrixExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

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)
	Sets the value of the element at proxy index (i, j) to v. More...

FMatrixSlice	__iadd__ (FMatrixSlice s)
	Adds the elements of the matrix slice s to this slice (via a temporary to handle aliasing). More...

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

FMatrixSlice	__isub__ (FMatrixSlice s)
	Subtracts the elements of the matrix slice s from this slice (via a temporary to handle aliasing). More...

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

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

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

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

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.FMatrixSlice.__init__ ( FMatrixSlice s )

Contructs a copy of the FMatrixSlice instance s.

Parameters

s	The `FMatrixSlice` instance to copy.

◆ init() [2/2]

None CDPL.Math.FMatrixSlice.__init__	(	FMatrixExpression	m,
		Slice	s1,
		Slice	s2
	)

Constructs the matrix slice proxy viewing rows in s1 and columns in s2 of m.

Parameters

m	The wrapped matrix.
s1	The row slice (start, stride, size).
s2	The column slice (start, stride, size).

Member Function Documentation

◆ getStart1()

int CDPL.Math.FMatrixSlice.getStart1 ( )

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

Returns: The start row index.

◆ getStart2()

int CDPL.Math.FMatrixSlice.getStart2 ( )

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

Returns: The start column index.

◆ getStride1()

int CDPL.Math.FMatrixSlice.getStride1 ( )

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

Returns: The row stride.

◆ getStride2()

int CDPL.Math.FMatrixSlice.getStride2 ( )

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

Returns: The column stride.

◆ getObjectID()

int CDPL.Math.FMatrixSlice.getObjectID ( )

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

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

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

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

◆ assign() [2/6]

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

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

◆ assign() [3/6]

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

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

◆ assign() [4/6]

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

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

◆ assign() [5/6]

FMatrixSlice CDPL.Math.FMatrixSlice.assign ( FMatrixSlice 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.FMatrixSlice.assign ( object a )

Assigns the contents of the numpy.ndarray object a to this matrix slice.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ getSize1()

int CDPL.Math.FMatrixSlice.getSize1 ( )

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

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.FMatrixSlice.getSize2 ( )

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

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.FMatrixSlice.isEmpty ( )

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

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

◆ getElement()

float CDPL.Math.FMatrixSlice.getElement	(	int	i,
		int	j
	)

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

Parameters

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

Returns: The value of the element m(s1(i), s2(j)).

◆ toArray()

object CDPL.Math.FMatrixSlice.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.FMatrixSlice.swap ( FMatrixSlice 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.

◆ setElement()

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

Sets the value of the element at proxy index (i, j) to v.

Parameters

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

Exceptions

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

◆ getData()

FMatrixExpression CDPL.Math.FMatrixSlice.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ call()

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

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

Parameters

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

Returns: The value of the element m(s1(i), s2(j)).

◆ getitem()

float CDPL.Math.FMatrixSlice.__getitem__ ( tuple ij )

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

Parameters

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

Returns: The value of the element m(s1(i), s2(j)).

◆ len()

int CDPL.Math.FMatrixSlice.__len__ ( )

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

Returns: The number of rows.

◆ eq() [1/2]

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

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

Parameters

s	The `FMatrixSlice` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

s	The `FMatrixSlice` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the FMatrixSlice instance.

Returns: The generated string representation.

◆ pos()

FMatrixSlice CDPL.Math.FMatrixSlice.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFMatrixExpression CDPL.Math.FMatrixSlice.__neg__ ( )

Returns the result of the operation self * -1.

Returns: A ConstFMatrixExpression instance holding the result of the element negation.

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstFMatrixExpression CDPL.Math.FMatrixSlice.__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.FMatrixSlice.__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.FMatrixSlice.__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.FMatrixSlice.__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.FMatrixSlice.__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.FMatrixSlice.__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.

◆ setitem()

None CDPL.Math.FMatrixSlice.__setitem__	(	tuple	ij,
		float	v
	)

Sets the value of the element at proxy index (i, j) to v.

Parameters

i	The zero-based proxy row index.
j	The zero-based proxy column index.
v	The new value of the element.

Exceptions

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

◆ iadd() [1/2]

FMatrixSlice CDPL.Math.FMatrixSlice.__iadd__ ( FMatrixSlice s )

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

Parameters

s	The source matrix slice.

Returns: self.

◆ iadd() [2/2]

FMatrixSlice CDPL.Math.FMatrixSlice.__iadd__ ( ConstFMatrixExpression 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]

FMatrixSlice CDPL.Math.FMatrixSlice.__isub__ ( FMatrixSlice s )

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

Parameters

s	The source matrix slice.

Returns: self.

◆ isub() [2/2]

FMatrixSlice CDPL.Math.FMatrixSlice.__isub__ ( ConstFMatrixExpression 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()

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

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

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

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

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

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

FMatrixSlice CDPL.Math.FMatrixSlice.__itruediv__ ( 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()

◆ getElement()

◆ toArray()

◆ swap()

◆ setElement()

◆ getData()

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/3]

◆ __mul__() [2/3]

◆ __mul__() [3/3]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __setitem__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

◆ init() [1/2]

◆ init() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul() [1/3]

◆ mul() [2/3]

◆ mul() [3/3]

◆ div()

◆ truediv()

◆ rmul()

◆ setitem()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()