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)
	Contructs a copy of the `FMatrixTranspose` instance mt. More...

None	__init__ (FMatrixExpression m)
	Constructs the transpose view proxy referring to m. 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 (writes the transpose into the wrapped matrix). More...

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

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

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

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

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

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

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

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

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

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

float	__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__ (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__ ()
	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...

None	__setitem__ (tuple ij, float v)

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

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

FMatrixTranspose	__isub__ (FMatrixTranspose mt)
	Subtracts the matrix transpose mt from this transpose view. 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)
	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.FMatrixTranspose.__init__ ( FMatrixTranspose mt )

Contructs a copy of the FMatrixTranspose instance mt.

Parameters

mt	The `FMatrixTranspose` instance to copy.

◆ init() [2/2]

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

Constructs the transpose view proxy referring to m.

Parameters

m	The wrapped matrix.

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 (writes the transpose into the wrapped matrix).

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 (writes the transpose into the wrapped matrix).

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 (writes the transpose into the wrapped matrix).

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 (writes the transpose into the wrapped matrix).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [5/6]

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

◆ getElement()

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

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ 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.

◆ setElement()

None CDPL.Math.FMatrixTranspose.setElement	(	int	i,
		int	j,
		float	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()

FMatrixExpression CDPL.Math.FMatrixTranspose.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ call()

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

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

◆ pos()

FMatrixTranspose CDPL.Math.FMatrixTranspose.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFMatrixExpression CDPL.Math.FMatrixTranspose.__neg__ ( )

Returns the result of the operation self * -1.

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

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

Adds the matrix transpose mt to this transpose view.

Parameters

mt	The source matrix transpose.

Returns: 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 )

Subtracts the matrix transpose mt from this transpose view.

Parameters

mt	The source matrix transpose.

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

◆ itruediv()

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

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