Matrix expression that exposes only the upper triangular part of an underlying matrix M with the diagonal elements set to one. More...

Inheritance diagram for CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter:

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

None	__init__ (ConstFMatrixExpression 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...

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

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

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

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

float	__getitem__ (tuple ij)
	Returns the value of element (i, j) as seen through the unit-upper triangular policy (off-policy entries return the appropriate fill value: zero or one). More...

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

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

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

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

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

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

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

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 with the diagonal elements set to one.

Constructor & Destructor Documentation

◆ init() [1/2]

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

Contructs a copy of the ConstUnitUpperTriangularFMatrixAdapter instance ta.

Parameters

ta	The `ConstUnitUpperTriangularFMatrixAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.__init__ ( ConstFMatrixExpression m )

Constructs the adapter wrapping m.

Parameters

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

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.getObjectID ( )

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

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

Returns the number of rows of the wrapped matrix.

Returns: The row count.

◆ getSize2()

int CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.getSize2 ( )

Returns the number of columns of the wrapped matrix.

Returns: The column count.

◆ isEmpty()

bool CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.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()

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

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

Parameters

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

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

◆ toArray()

object CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ getData()

ConstFMatrixExpression CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ call()

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

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

Parameters

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

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

◆ getitem()

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

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

Parameters

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

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

◆ len()

int CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.__len__ ( )

Returns the number of rows of the wrapped matrix.

Returns: The row count.

◆ eq() [1/2]

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

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

Parameters

ta	The `ConstUnitUpperTriangularFMatrixAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

ta	The `ConstUnitUpperTriangularFMatrixAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the ConstUnitUpperTriangularFMatrixAdapter instance.

Returns: The generated string representation.

◆ pos()

ConstUnitUpperTriangularFMatrixAdapter CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFMatrixExpression CDPL.Math.ConstUnitUpperTriangularFMatrixAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

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

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