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

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

None	__init__ (FMatrixExpression e)
	Initializes the `FMatrixTranspose` instance. More...

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

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

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

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

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

FMatrixTranspose	assign (FMatrixTranspose 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...

float	getElement (int i, int j)

object	toArray ()

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

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

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

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

float	__getitem__ (tuple ij)

int	__len__ ()

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

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

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

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

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

FMatrixTranspose	__pos__ ()

ConstFMatrixExpression	__neg__ ()

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)

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

FMatrixTranspose	__iadd__ (ConstFMatrixExpression e)
	Adds the matrix expression e to this transpose view. More...

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

FMatrixTranspose	__isub__ (ConstFMatrixExpression e)
	Subtracts the matrix expression e from this transpose view. More...

FMatrixTranspose	__imul__ (float t)
	Multiplies every element of the wrapped matrix by the scalar t. More...

FMatrixTranspose	__idiv__ (float t)
	Divides every element of the wrapped matrix by the scalar t. More...

FMatrixTranspose	__itruediv__ (float 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.FMatrixTranspose.__init__ ( FMatrixTranspose mt )

Initializes a copy of the FMatrixTranspose instance mt.

Parameters

mt	The `FMatrixTranspose` instance to copy.

◆ init() [2/2]

None CDPL.Math.FMatrixTranspose.__init__ ( FMatrixExpression e )

Initializes the FMatrixTranspose instance.

Parameters

e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.FMatrixTranspose.getObjectID ( )

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

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

FMatrixTranspose CDPL.Math.FMatrixTranspose.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]

FMatrixTranspose CDPL.Math.FMatrixTranspose.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]

FMatrixTranspose CDPL.Math.FMatrixTranspose.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]

FMatrixTranspose CDPL.Math.FMatrixTranspose.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]

FMatrixTranspose CDPL.Math.FMatrixTranspose.assign ( FMatrixTranspose 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.FMatrixTranspose.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.FMatrixTranspose.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.FMatrixTranspose.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.FMatrixTranspose.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.FMatrixTranspose.swap ( FMatrixTranspose mt )

Swaps the underlying matrices of the two transpose views.

Parameters

mt	The transpose view to swap with.

◆ getData()

FMatrixExpression CDPL.Math.FMatrixTranspose.getData ( )

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

Returns: A reference to the wrapped matrix closure.

◆ call()

float CDPL.Math.FMatrixTranspose.__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.FMatrixTranspose.__eq__ ( FMatrixTranspose mt )

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

Parameters

mt	The `FMatrixTranspose` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

mt	The `FMatrixTranspose` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the FMatrixTranspose instance.

Returns: The generated string representation.

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

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

◆ iadd() [1/2]

FMatrixTranspose CDPL.Math.FMatrixTranspose.__iadd__ ( FMatrixTranspose mt )

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

Parameters

mt	Specifies the second addend.

Returns: The updated FMatrixTranspose instance self.

◆ iadd() [2/2]

FMatrixTranspose CDPL.Math.FMatrixTranspose.__iadd__ ( ConstFMatrixExpression e )

Adds the matrix expression e to this transpose view.

Parameters

e	The source matrix expression.

Returns: self

◆ isub() [1/2]

FMatrixTranspose CDPL.Math.FMatrixTranspose.__isub__ ( FMatrixTranspose mt )

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

Parameters

mt	Specifies the subtrahend.

Returns: The updated FMatrixTranspose instance self.

◆ isub() [2/2]

FMatrixTranspose CDPL.Math.FMatrixTranspose.__isub__ ( ConstFMatrixExpression e )

Subtracts the matrix expression e from this transpose view.

Parameters

e	The source matrix expression.

Returns: self

◆ imul()

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

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

Parameters

t	The scalar multiplier.

Returns: self

◆ idiv()

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