Matrix expression that exposes only the upper triangular part of an underlying matrix M. More...

Inheritance diagram for CDPL.Math.ConstUpperTriangularULMatrixAdapter:

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

None	__init__ (ConstULMatrixExpression m)
	Constructs the adapter wrapping m. More...

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

int	getSize1 ()
	Returns the number of rows of the wrapped matrix. More...

int	getSize2 ()
	Returns the number of columns of the wrapped matrix. More...

bool	isEmpty ()
	Tells whether the wrapped matrix is empty (zero rows or zero columns). More...

int	getElement (int i, int j)
	Returns the value of element (i, j) as seen through the upper triangular policy (off-policy entries return the fill value zero). More...

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

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

int	__call__ (int i, int j)
	Returns the value of element (i, j) as seen through the upper triangular policy (off-policy entries return the fill value zero). More...

int	__getitem__ (tuple ij)
	Returns the value of element (i, j) as seen through the upper triangular policy (off-policy entries return the fill value zero). More...

int	__len__ ()
	Returns the number of rows of the wrapped matrix. More...

bool	__eq__ (ConstUpperTriangularULMatrixAdapter ta)
	Returns the result of the comparison operation `self == ta`. More...

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

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

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

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

ConstUpperTriangularULMatrixAdapter	__pos__ ()
	Returns self. More...

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

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)

Detailed Description

Matrix expression that exposes only the upper triangular part of an underlying matrix M.

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.ConstUpperTriangularULMatrixAdapter.__init__ ( ConstUpperTriangularULMatrixAdapter ta )

Contructs a copy of the ConstUpperTriangularULMatrixAdapter instance ta.

Parameters

ta	The `ConstUpperTriangularULMatrixAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.ConstUpperTriangularULMatrixAdapter.__init__ ( ConstULMatrixExpression m )

Constructs the adapter wrapping m.

Parameters

m	The matrix to be viewed through the upper triangular policy.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstUpperTriangularULMatrixAdapter.getObjectID ( )

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

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

Returns the number of rows of the wrapped matrix.

Returns: The row count.

◆ getSize2()

int CDPL.Math.ConstUpperTriangularULMatrixAdapter.getSize2 ( )

Returns the number of columns of the wrapped matrix.

Returns: The column count.

◆ isEmpty()

bool CDPL.Math.ConstUpperTriangularULMatrixAdapter.isEmpty ( )

Tells whether the wrapped matrix is empty (zero rows or zero columns).

Returns: True if the wrapped matrix is empty, and False otherwise.

◆ getElement()

int CDPL.Math.ConstUpperTriangularULMatrixAdapter.getElement	(	int	i,
		int	j
	)

Returns the value of element (i, j) as seen through the upper triangular policy (off-policy entries return the fill value zero).

Parameters

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

Returns: The element value as defined by the upper triangular-view policy.

◆ toArray()

object CDPL.Math.ConstUpperTriangularULMatrixAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ getData()

ConstULMatrixExpression CDPL.Math.ConstUpperTriangularULMatrixAdapter.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ call()

int CDPL.Math.ConstUpperTriangularULMatrixAdapter.__call__	(	int	i,
		int	j
	)

Returns the value of element (i, j) as seen through the upper triangular policy (off-policy entries return the fill value zero).

Parameters

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

Returns: The element value as defined by the upper triangular-view policy.

◆ getitem()

int CDPL.Math.ConstUpperTriangularULMatrixAdapter.__getitem__ ( tuple ij )

Returns the value of element (i, j) as seen through the upper triangular policy (off-policy entries return the fill value zero).

Parameters

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

Returns: The element value as defined by the upper triangular-view policy.

◆ len()

int CDPL.Math.ConstUpperTriangularULMatrixAdapter.__len__ ( )

Returns the number of rows of the wrapped matrix.

Returns: The row count.

◆ eq() [1/2]

bool CDPL.Math.ConstUpperTriangularULMatrixAdapter.__eq__ ( ConstUpperTriangularULMatrixAdapter ta )

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

Parameters

ta	The `ConstUpperTriangularULMatrixAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

ta	The `ConstUpperTriangularULMatrixAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the ConstUpperTriangularULMatrixAdapter instance.

Returns: The generated string representation.

◆ pos()

ConstUpperTriangularULMatrixAdapter CDPL.Math.ConstUpperTriangularULMatrixAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstULMatrixExpression CDPL.Math.ConstUpperTriangularULMatrixAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstULMatrixExpression CDPL.Math.ConstUpperTriangularULMatrixAdapter.__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.ConstUpperTriangularULMatrixAdapter.__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.ConstUpperTriangularULMatrixAdapter.__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.ConstUpperTriangularULMatrixAdapter.__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.ConstUpperTriangularULMatrixAdapter.__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.ConstUpperTriangularULMatrixAdapter.__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

◆ getObjectID()

◆ getSize1()

◆ getSize2()

◆ isEmpty()

◆ getElement()

◆ toArray()

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

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