Memory-efficient immutable matrix where all elements have the same value of type float. More...

Inheritance diagram for CDPL.Math.FScalarMatrix:

Public Member Functions
None	__init__ ()
	Constructs an empty scalar matrix.

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

None	__init__ (int m, int n, float v=0.0)
	Constructs a scalar matrix of size m×n in which every entry equals v. More...

None	resize (int m, int n)
	Resizes the dimensions to m×n. More...

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

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

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

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

float	getElement (int i, int j)
	Returns the common entry value. More...

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

FScalarMatrix	assign (FScalarMatrix m)
	Copy-assigns the dimensions and common value from m. More...

None	swap (FScalarMatrix m)
	Swaps the dimensions and common value with m. More...

float	__call__ (int i, int j)
	Returns the common entry value. More...

float	__getitem__ (tuple ij)
	Returns the common entry value. More...

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

bool	__eq__ (FScalarMatrix 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__ (FScalarMatrix 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 `FScalarMatrix` instance. More...

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

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

Detailed Description

Memory-efficient immutable matrix where all elements have the same value of type float.

Constructor & Destructor Documentation

◆ init() [1/2]

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

Constructs a copy of the scalar matrix m.

Parameters

m	The scalar matrix to copy.

◆ init() [2/2]

None CDPL.Math.FScalarMatrix.__init__	(	int	m,
		int	n,
		float	v = `0.0`
	)

Constructs a scalar matrix of size m×n in which every entry equals v.

Parameters

m	The number of rows.
n	The number of columns.
v	The common entry value.

Member Function Documentation

◆ resize()

None CDPL.Math.FScalarMatrix.resize	(	int	m,
		int	n
	)

Resizes the dimensions to m×n.

Parameters

m	The new row count.
n	The new column count.

◆ getObjectID()

int CDPL.Math.FScalarMatrix.getObjectID ( )

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

Different Python FScalarMatrix 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 FScalarMatrix 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.

◆ getSize1()

int CDPL.Math.FScalarMatrix.getSize1 ( )

Returns the logical number of rows.

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.FScalarMatrix.getSize2 ( )

Returns the logical number of columns.

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.FScalarMatrix.isEmpty ( )

Tells whether the matrix is empty.

Returns: True if either dimension is zero, and False otherwise.

◆ getElement()

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

Returns the common entry value.

Parameters

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

Returns: The common entry value.

Exceptions

Base.IndexError if either index is out of range.

◆ toArray()

object CDPL.Math.FScalarMatrix.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ assign()

FScalarMatrix CDPL.Math.FScalarMatrix.assign ( FScalarMatrix m )

Copy-assigns the dimensions and common value from m.

Parameters

m	The source scalar matrix.

Returns: self.

◆ swap()

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

Swaps the dimensions and common value with m.

Parameters

m	The scalar matrix to swap with.

◆ call()

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

Returns the common entry value.

Parameters

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

Returns: The common entry value.

Exceptions

Base.IndexError if either index is out of range.

◆ getitem()

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

Returns the common entry value.

Parameters

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

Returns: The common entry value.

Exceptions

Base.IndexError if either index is out of range.

◆ len()

int CDPL.Math.FScalarMatrix.__len__ ( )

Returns the number of rows.

Returns: The number of rows.

◆ eq() [1/2]

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

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

Parameters

m	The `FScalarMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

m	The `FScalarMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the FScalarMatrix instance.

Returns: The generated string representation.

◆ pos()

FScalarMatrix CDPL.Math.FScalarMatrix.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFMatrixExpression CDPL.Math.FScalarMatrix.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ resize()

◆ getObjectID()

◆ getSize1()

◆ getSize2()

◆ isEmpty()

◆ getElement()

◆ toArray()

◆ assign()

◆ swap()

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

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