Mutable view adapter that exposes the transpose of a matrix M as a matrix expression ( \( (i, j) \to M(j, i) \)). More...

Inheritance diagram for CDPL.Math.ULMatrixTranspose:

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

None	__init__ (ULMatrixExpression m)
	Constructs the transpose view proxy referring to m. More...

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

ULMatrixTranspose	assign (ConstFMatrixExpression e)
	Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix). More...

ULMatrixTranspose	assign (ConstDMatrixExpression e)
	Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix). More...

ULMatrixTranspose	assign (ConstLMatrixExpression e)
	Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix). More...

ULMatrixTranspose	assign (ConstULMatrixExpression e)
	Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix). More...

ULMatrixTranspose	assign (ULMatrixTranspose mt)
	Copy-assigns the wrapped matrix from the contents of mt's wrapped matrix. More...

None	assign (object a)
	Assigns the contents of the 2D `numpy.ndarray` object a to this transpose view. More...

int	getSize1 ()
	Returns the number of rows of the transpose view (= number of columns of the wrapped matrix). More...

int	getSize2 ()
	Returns the number of columns of the transpose view (= number of rows of the wrapped matrix). More...

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

int	getElement (int i, int j)
	Returns the wrapped matrix's element at (j, i). More...

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

None	swap (ULMatrixTranspose mt)
	Swaps the underlying matrices of the two transpose views. More...

None	setElement (int i, int j, int v)
	Sets the value of the wrapped matrix's element at (j, i) to v. More...

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

int	__call__ (int i, int j)
	Returns the wrapped matrix's element at (j, i). More...

int	__getitem__ (tuple ij)
	Returns the wrapped matrix's element at (j, i). More...

int	__len__ ()
	Returns the number of rows of the transpose view (= number of columns of the wrapped matrix). More...

bool	__eq__ (ULMatrixTranspose mt)
	Returns the result of the comparison operation `self == mt`. More...

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

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

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

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

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

None	__setitem__ (tuple ij, int v)

ULMatrixTranspose	__iadd__ (ULMatrixTranspose mt)
	Adds the matrix transpose mt to this transpose view. More...

ULMatrixTranspose	__iadd__ (ConstULMatrixExpression e)
	Adds the matrix expression e to this transpose view. More...

ULMatrixTranspose	__isub__ (ULMatrixTranspose mt)
	Subtracts the matrix transpose mt from this transpose view. More...

ULMatrixTranspose	__isub__ (ConstULMatrixExpression e)
	Subtracts the matrix expression e from this transpose view. More...

ULMatrixTranspose	__imul__ (int t)
	Multiplies every element of the wrapped matrix by the scalar t. More...

ULMatrixTranspose	__idiv__ (int t)
	Divides every element of the wrapped matrix by the scalar t. More...

ULMatrixTranspose	__itruediv__ (int t)
	Divides every element of the wrapped matrix by the scalar t. More...

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

	data = property(getData)

Detailed Description

Mutable view adapter that exposes the transpose of a matrix M as a matrix expression ( \( (i, j) \to M(j, i) \)).

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.ULMatrixTranspose.__init__ ( ULMatrixTranspose mt )

Contructs a copy of the ULMatrixTranspose instance mt.

Parameters

mt	The `ULMatrixTranspose` instance to copy.

◆ init() [2/2]

None CDPL.Math.ULMatrixTranspose.__init__ ( ULMatrixExpression m )

Constructs the transpose view proxy referring to m.

Parameters

m	The wrapped matrix.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ULMatrixTranspose.getObjectID ( )

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

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

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

Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [2/6]

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

Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [3/6]

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

Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [4/6]

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

Assigns the matrix expression e to this transpose view (writes the transpose into the wrapped matrix).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [5/6]

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.assign ( ULMatrixTranspose mt )

Copy-assigns the wrapped matrix from the contents of mt's wrapped matrix.

Parameters

mt	The source transpose view.

Returns: self.

◆ assign() [6/6]

None CDPL.Math.ULMatrixTranspose.assign ( object a )

Assigns the contents of the 2D numpy.ndarray object a to this transpose view.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ getSize1()

int CDPL.Math.ULMatrixTranspose.getSize1 ( )

Returns the number of rows of the transpose view (= number of columns of the wrapped matrix).

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.ULMatrixTranspose.getSize2 ( )

Returns the number of columns of the transpose view (= number of rows of the wrapped matrix).

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.ULMatrixTranspose.isEmpty ( )

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

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

◆ getElement()

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

Returns the wrapped matrix's element at (j, i).

Parameters

i	The zero-based row index in the transposed view.
j	The zero-based column index in the transposed view.

Returns: The wrapped matrix value m(j, i).

◆ toArray()

object CDPL.Math.ULMatrixTranspose.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.ULMatrixTranspose.swap ( ULMatrixTranspose mt )

Swaps the underlying matrices of the two transpose views.

Parameters

mt	The transpose view to swap with.

◆ setElement()

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

Sets the value of the wrapped matrix's element at (j, i) to v.

Parameters

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

Exceptions

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

◆ getData()

ULMatrixExpression CDPL.Math.ULMatrixTranspose.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ call()

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

Returns the wrapped matrix's element at (j, i).

Parameters

i	The zero-based row index in the transposed view.
j	The zero-based column index in the transposed view.

Returns: The wrapped matrix value m(j, i).

◆ getitem()

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

Returns the wrapped matrix's element at (j, i).

Parameters

i	The zero-based row index in the transposed view.
j	The zero-based column index in the transposed view.

Returns: The wrapped matrix value m(j, i).

◆ len()

int CDPL.Math.ULMatrixTranspose.__len__ ( )

Returns the number of rows of the transpose view (= number of columns of the wrapped matrix).

Returns: The number of rows.

◆ eq() [1/2]

bool CDPL.Math.ULMatrixTranspose.__eq__ ( ULMatrixTranspose mt )

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

Parameters

mt	The `ULMatrixTranspose` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

mt	The `ULMatrixTranspose` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the ULMatrixTranspose instance.

Returns: The generated string representation.

◆ pos()

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstULMatrixExpression CDPL.Math.ULMatrixTranspose.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

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

◆ iadd() [1/2]

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__iadd__ ( ULMatrixTranspose mt )

Adds the matrix transpose mt to this transpose view.

Parameters

mt	The source matrix transpose.

Returns: self.

◆ iadd() [2/2]

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__iadd__ ( ConstULMatrixExpression e )

Adds the matrix expression e to this transpose view.

Parameters

e	The source matrix expression.

Returns: self.

◆ isub() [1/2]

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__isub__ ( ULMatrixTranspose mt )

Subtracts the matrix transpose mt from this transpose view.

Parameters

mt	The source matrix transpose.

Returns: self.

◆ isub() [2/2]

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__isub__ ( ConstULMatrixExpression e )

Subtracts the matrix expression e from this transpose view.

Parameters

e	The source matrix expression.

Returns: self.

◆ imul()

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__imul__ ( int t )

Multiplies every element of the wrapped matrix by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__idiv__ ( int t )

Divides every element of the wrapped matrix by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

ULMatrixTranspose CDPL.Math.ULMatrixTranspose.__itruediv__ ( int t )

Divides every element of the wrapped matrix 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

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

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

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()