Unbounded dense matrix holding floating-point values of type float. More...

Inheritance diagram for CDPL.Math.FMatrix:

Public Member Functions
None	__init__ ()
	Constructs an empty matrix (zero rows and zero columns).

None	__init__ (FMatrix m)
	Constructs a copy of the matrix m. More...

None	__init__ (int m, int n)
	Constructs an m×n matrix with default-initialized elements. More...

None	__init__ (int m, int n, float v)
	Constructs an m×n matrix with every element initialized to v. More...

None	__init__ (ConstFMatrixExpression e)
	Constructs the matrix from the matrix expression e (materializing the expression result). More...

None	__init__ (ConstDMatrixExpression e)
	Constructs the matrix from the matrix expression e (materializing the expression result). More...

None	__init__ (ConstLMatrixExpression e)
	Constructs the matrix from the matrix expression e (materializing the expression result). More...

None	__init__ (ConstULMatrixExpression e)
	Constructs the matrix from the matrix expression e (materializing the expression result). More...

None	__init__ (object a)
	Constructs the matrix from the 2D `numpy.ndarray` object a. More...

None	resize (int m, int n, bool preserve=True, float v=0.0)
	Resizes the matrix to m×n elements. More...

None	clear (float v=0.0)
	Sets every element of the matrix to the value v. More...

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

FMatrix	assign (ConstFMatrixExpression e)
	Assigns the matrix expression e to this matrix (via a temporary to handle aliasing). More...

FMatrix	assign (ConstDMatrixExpression e)
	Assigns the matrix expression e to this matrix (via a temporary to handle aliasing). More...

FMatrix	assign (ConstLMatrixExpression e)
	Assigns the matrix expression e to this matrix (via a temporary to handle aliasing). More...

FMatrix	assign (ConstULMatrixExpression e)
	Assigns the matrix expression e to this matrix (via a temporary to handle aliasing). More...

FMatrix	assign (FMatrix m)
	Copy-assigns the contents of m to this matrix. More...

FMatrix	assign (object a)
	Assigns the contents of the 2D `numpy.ndarray` object a to this matrix. More...

int	getSize1 ()
	Returns the number of rows. More...

int	getSize2 ()
	Returns the number of columns. More...

bool	isEmpty ()
	Tells whether the matrix is empty. More...

float	getElement (int i, int j)
	Returns the element at (i, j). More...

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

None	swap (FMatrix m)
	Swaps the contents of this matrix with those of m. More...

None	setElement (int i, int j, float v)
	Sets the value of the element (i, j) to v. More...

float	__call__ (int i, int j)
	Returns the element at (i, j). More...

float	__getitem__ (tuple ij)
	Returns the element at (i, j). More...

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

bool	__eq__ (FMatrix m)
	Returns the result of the comparison operation `self == m`. More...

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

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

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

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

FMatrix	__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)
	Sets the value of the element (i, j) to v. More...

FMatrix	__iadd__ (FMatrix m)
	Adds the contents of the matrix m element-wise to this matrix (no alias check needed). More...

FMatrix	__iadd__ (ConstFMatrixExpression e)
	Adds the matrix expression e element-wise to this matrix (via a temporary to handle aliasing). More...

FMatrix	__isub__ (FMatrix m)
	Subtracts the contents of the matrix m element-wise from this matrix (no alias check needed). More...

FMatrix	__isub__ (ConstFMatrixExpression e)
	Subtracts the matrix expression e element-wise from this matrix (via a temporary to handle aliasing). More...

FMatrix	__imul__ (float t)
	Multiplies every element by the scalar t. More...

FMatrix	__idiv__ (float t)
	Divides every element by the scalar t. More...

FMatrix	__itruediv__ (float t)
	Divides every element by the scalar t. More...

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

Detailed Description

Unbounded dense matrix holding floating-point values of type float.

Constructor & Destructor Documentation

◆ init() [1/8]

None CDPL.Math.FMatrix.__init__ ( FMatrix m )

Constructs a copy of the matrix m.

Parameters

m	The matrix to copy.

◆ init() [2/8]

None CDPL.Math.FMatrix.__init__	(	int	m,
		int	n
	)

Constructs an m×n matrix with default-initialized elements.

Parameters

m	The number of rows.
n	The number of columns.

◆ init() [3/8]

None CDPL.Math.FMatrix.__init__	(	int	m,
		int	n,
		float	v
	)

Constructs an m×n matrix with every element initialized to v.

Parameters

m	The number of rows.
n	The number of columns.
v	The value used for element initialization.

◆ init() [4/8]

None CDPL.Math.FMatrix.__init__ ( ConstFMatrixExpression e )

Constructs the matrix from the matrix expression e (materializing the expression result).

Parameters

e	The matrix expression to materialize.

◆ init() [5/8]

None CDPL.Math.FMatrix.__init__ ( ConstDMatrixExpression e )

Constructs the matrix from the matrix expression e (materializing the expression result).

Parameters

e	The matrix expression to materialize.

◆ init() [6/8]

None CDPL.Math.FMatrix.__init__ ( ConstLMatrixExpression e )

Constructs the matrix from the matrix expression e (materializing the expression result).

Parameters

e	The matrix expression to materialize.

◆ init() [7/8]

None CDPL.Math.FMatrix.__init__ ( ConstULMatrixExpression e )

Constructs the matrix from the matrix expression e (materializing the expression result).

Parameters

e	The matrix expression to materialize.

◆ init() [8/8]

None CDPL.Math.FMatrix.__init__ ( object a )

Constructs the matrix from the 2D numpy.ndarray object a.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

Member Function Documentation

◆ resize()

None CDPL.Math.FMatrix.resize	(	int	m,
		int	n,
		bool	preserve = `True`,
		float	v = `0.0`
	)

Resizes the matrix to m×n elements.

Parameters

m	The new row count.
n	The new column count.
preserve	If `True`, existing element values at indices that remain valid are kept. If `False`, all elements are set to v.
v	The fill value for newly added elements (or for all elements when preserve is `False`).

◆ clear()

None CDPL.Math.FMatrix.clear ( float v = 0.0 )

Sets every element of the matrix to the value v.

Parameters

v	The fill value.

◆ getObjectID()

int CDPL.Math.FMatrix.getObjectID ( )

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

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

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

Assigns the matrix expression e to this matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [2/6]

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

Assigns the matrix expression e to this matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [3/6]

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

Assigns the matrix expression e to this matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [4/6]

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

Assigns the matrix expression e to this matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [5/6]

FMatrix CDPL.Math.FMatrix.assign ( FMatrix m )

Copy-assigns the contents of m to this matrix.

Parameters

m	The source matrix.

Returns: self.

◆ assign() [6/6]

FMatrix CDPL.Math.FMatrix.assign ( object a )

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

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ getSize1()

int CDPL.Math.FMatrix.getSize1 ( )

Returns the number of rows.

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.FMatrix.getSize2 ( )

Returns the number of columns.

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.FMatrix.isEmpty ( )

Tells whether the matrix is empty.

Returns: True if the underlying storage holds no elements, and False otherwise.

◆ getElement()

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

Returns the element at (i, j).

Parameters

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

Returns: The value of the element.

Exceptions

Base.IndexError if either index is out of range.

◆ toArray()

object CDPL.Math.FMatrix.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.FMatrix.swap ( FMatrix m )

Swaps the contents of this matrix with those of m.

Parameters

m	The matrix to swap with.

◆ setElement()

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

Sets the value of the element (i, j) to v.

Parameters

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

Exceptions

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

◆ call()

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

Returns the element at (i, j).

Parameters

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

Returns: The value of the element.

Exceptions

Base.IndexError if either index is out of range.

◆ getitem()

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

Returns the element at (i, j).

Parameters

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

Returns: The value of the element.

Exceptions

Base.IndexError if either index is out of range.

◆ len()

int CDPL.Math.FMatrix.__len__ ( )

Returns the number of rows.

Returns: The number of rows.

◆ eq() [1/2]

bool CDPL.Math.FMatrix.__eq__ ( FMatrix m )

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

Parameters

m	The `FMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

m	The `FMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the FMatrix instance.

Returns: The generated string representation.

◆ pos()

FMatrix CDPL.Math.FMatrix.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFMatrixExpression CDPL.Math.FMatrix.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

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

◆ setitem()

None CDPL.Math.FMatrix.__setitem__	(	tuple	ij,
		float	v
	)

Sets the value of the element (i, j) to v.

Parameters

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

Exceptions

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

◆ iadd() [1/2]

FMatrix CDPL.Math.FMatrix.__iadd__ ( FMatrix m )

Adds the contents of the matrix m element-wise to this matrix (no alias check needed).

Parameters

m	The source matrix.

Returns: self.

◆ iadd() [2/2]

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

Adds the matrix expression e element-wise to this matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self.

◆ isub() [1/2]

FMatrix CDPL.Math.FMatrix.__isub__ ( FMatrix m )

Subtracts the contents of the matrix m element-wise from this matrix (no alias check needed).

Parameters

m	The source matrix.

Returns: self.

◆ isub() [2/2]

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

Subtracts the matrix expression e element-wise from this matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns: self.

◆ imul()

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

Multiplies every element by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

FMatrix CDPL.Math.FMatrix.__idiv__ ( float t )

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

FMatrix CDPL.Math.FMatrix.__itruediv__ ( float t )

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/8]

◆ __init__() [2/8]

◆ __init__() [3/8]

◆ __init__() [4/8]

◆ __init__() [5/8]

◆ __init__() [6/8]

◆ __init__() [7/8]

◆ __init__() [8/8]

Member Function Documentation

◆ resize()

◆ clear()

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

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

◆ __setitem__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

◆ init() [1/8]

◆ init() [2/8]

◆ init() [3/8]

◆ init() [4/8]

◆ init() [5/8]

◆ init() [6/8]

◆ init() [7/8]

◆ init() [8/8]

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

◆ setitem()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()