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.LMatrixTranspose:

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

None	__init__ (LMatrixExpression e)
	Initializes the `LMatrixTranspose` instance. More...

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

LMatrixTranspose	assign (ConstFMatrixExpression e)
	Assigns the matrix expression e to this transpose view without intermediate temporary. More...

LMatrixTranspose	assign (ConstDMatrixExpression e)
	Assigns the matrix expression e to this transpose view without intermediate temporary. More...

LMatrixTranspose	assign (ConstLMatrixExpression e)
	Assigns the matrix expression e to this transpose view without intermediate temporary. More...

LMatrixTranspose	assign (ConstULMatrixExpression e)
	Assigns the matrix expression e to this transpose view without intermediate temporary. More...

LMatrixTranspose	assign (LMatrixTranspose mt)
	Assigns the wrapped matrix from mt's wrapped matrix (possibly differing types). 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 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)

object	toArray ()

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

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

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

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

int	__getitem__ (tuple ij)

int	__len__ ()

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

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

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

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

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

LMatrixTranspose	__pos__ ()

ConstLMatrixExpression	__neg__ ()

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

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

ConstLMatrixExpression	__mul__ (int t)
	Returns the result of the multiplication operation `self * t`. More...

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

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

ConstLMatrixExpression	__div__ (int t)
	Returns the result of the division operation `self // t`. More...

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

ConstLMatrixExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

None	__setitem__ (tuple ij, int v)

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

LMatrixTranspose	__iadd__ (ConstLMatrixExpression e)
	Adds the matrix expression e to this transpose view. More...

LMatrixTranspose	__isub__ (LMatrixTranspose mt)
	Performs the in-place subtraction operation `self -= mt`. More...

LMatrixTranspose	__isub__ (ConstLMatrixExpression e)
	Subtracts the matrix expression e from this transpose view. More...

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

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

LMatrixTranspose	__itruediv__ (int t)

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.LMatrixTranspose.__init__ ( LMatrixTranspose mt )

Initializes a copy of the LMatrixTranspose instance mt.

Parameters

mt	The `LMatrixTranspose` instance to copy.

◆ init() [2/2]

None CDPL.Math.LMatrixTranspose.__init__ ( LMatrixExpression e )

Initializes the LMatrixTranspose instance.

Parameters

e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.LMatrixTranspose.getObjectID ( )

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

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

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

Assigns the matrix expression e to this transpose view without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [2/6]

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

Assigns the matrix expression e to this transpose view without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [3/6]

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

Assigns the matrix expression e to this transpose view without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [4/6]

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

Assigns the matrix expression e to this transpose view without intermediate temporary.

Parameters

e	The source matrix expression.

Returns: self

◆ assign() [5/6]

LMatrixTranspose CDPL.Math.LMatrixTranspose.assign ( LMatrixTranspose mt )

Assigns the wrapped matrix from mt's wrapped matrix (possibly differing types).

Parameters

mt	The source transpose view.

Returns: self

◆ assign() [6/6]

None CDPL.Math.LMatrixTranspose.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.LMatrixTranspose.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.LMatrixTranspose.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.LMatrixTranspose.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.

◆ swap()

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

Swaps the underlying matrices of the two transpose views.

Parameters

mt	The transpose view to swap with.

◆ getData()

LMatrixExpression CDPL.Math.LMatrixTranspose.getData ( )

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

Returns: A reference to the wrapped matrix closure.

◆ call()

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

Returns a reference to 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: A reference to m(j, i).

◆ eq() [1/2]

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

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

Parameters

mt	The `LMatrixTranspose` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.LMatrixTranspose.__eq__ ( ConstLMatrixExpression e )

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

Parameters

e	The `ConstLMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.LMatrixTranspose.__ne__ ( LMatrixTranspose mt )

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

Parameters

mt	The `LMatrixTranspose` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.LMatrixTranspose.__ne__ ( ConstLMatrixExpression e )

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

Parameters

e	The `ConstLMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.LMatrixTranspose.__str__ ( )

Returns a string representation of the LMatrixTranspose instance.

Returns: The generated string representation.

◆ add()

ConstLMatrixExpression CDPL.Math.LMatrixTranspose.__add__ ( ConstLMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstLMatrixExpression CDPL.Math.LMatrixTranspose.__sub__ ( ConstLMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstLMatrixExpression CDPL.Math.LMatrixTranspose.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/3]

ConstLMatrixExpression CDPL.Math.LMatrixTranspose.__mul__ ( ConstLMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ mul() [3/3]

ConstLVectorExpression CDPL.Math.LMatrixTranspose.__mul__ ( ConstLVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstLMatrixExpression CDPL.Math.LMatrixTranspose.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstLMatrixExpression CDPL.Math.LMatrixTranspose.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstLMatrixExpression CDPL.Math.LMatrixTranspose.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ iadd() [1/2]

LMatrixTranspose CDPL.Math.LMatrixTranspose.__iadd__ ( LMatrixTranspose mt )

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

Parameters

mt	Specifies the second addend.

Returns: The updated LMatrixTranspose instance self.

◆ iadd() [2/2]

LMatrixTranspose CDPL.Math.LMatrixTranspose.__iadd__ ( ConstLMatrixExpression e )

Adds the matrix expression e to this transpose view.

Parameters

e	The source matrix expression.

Returns: self

◆ isub() [1/2]

LMatrixTranspose CDPL.Math.LMatrixTranspose.__isub__ ( LMatrixTranspose mt )

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

Parameters

mt	Specifies the subtrahend.

Returns: The updated LMatrixTranspose instance self.

◆ isub() [2/2]

LMatrixTranspose CDPL.Math.LMatrixTranspose.__isub__ ( ConstLMatrixExpression e )

Subtracts the matrix expression e from this transpose view.

Parameters

e	The source matrix expression.

Returns: self

◆ imul()

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

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

Parameters

t	The scalar multiplier.

Returns: self

◆ idiv()

LMatrixTranspose CDPL.Math.LMatrixTranspose.__idiv__ ( 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()

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