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

Inheritance diagram for CDPL.Math.DScalarMatrix:

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

None	__init__ (DScalarMatrix 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 `DScalarMatrix` instance into a corresponding `numpy.ndarray` object. More...

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

None	swap (DScalarMatrix 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__ (DScalarMatrix m)
	Returns the result of the comparison operation `self == m`. More...

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

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

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

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

DScalarMatrix	__pos__ ()
	Returns self. More...

ConstDMatrixExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

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

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

ConstDMatrixExpression	__mul__ (float t)
	Returns the result of the multiplication operation `self * t`. More...

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

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

ConstDMatrixExpression	__div__ (float t)
	Returns the result of the division operation `self // t`. More...

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

ConstDMatrixExpression	__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 double.

Constructor & Destructor Documentation

◆ init() [1/2]

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

Constructs a copy of the scalar matrix m.

Parameters

m	The scalar matrix to copy.

◆ init() [2/2]

None CDPL.Math.DScalarMatrix.__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.DScalarMatrix.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.DScalarMatrix.getObjectID ( )

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

Different Python DScalarMatrix 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 DScalarMatrix 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.DScalarMatrix.getSize1 ( )

Returns the logical number of rows.

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.DScalarMatrix.getSize2 ( )

Returns the logical number of columns.

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.DScalarMatrix.isEmpty ( )

Tells whether the matrix is empty.

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

◆ getElement()

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

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ assign()

DScalarMatrix CDPL.Math.DScalarMatrix.assign ( DScalarMatrix m )

Copy-assigns the dimensions and common value from m.

Parameters

m	The source scalar matrix.

Returns: self.

◆ swap()

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

Swaps the dimensions and common value with m.

Parameters

m	The scalar matrix to swap with.

◆ call()

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

Returns the number of rows.

Returns: The number of rows.

◆ eq() [1/2]

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

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

Parameters

m	The `DScalarMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.DScalarMatrix.__eq__ ( ConstDMatrixExpression e )

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

Parameters

e	The `ConstDMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.DScalarMatrix.__ne__ ( DScalarMatrix m )

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

Parameters

m	The `DScalarMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.DScalarMatrix.__ne__ ( ConstDMatrixExpression e )

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

Parameters

e	The `ConstDMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.DScalarMatrix.__str__ ( )

Returns a string representation of the DScalarMatrix instance.

Returns: The generated string representation.

◆ pos()

DScalarMatrix CDPL.Math.DScalarMatrix.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__add__ ( ConstDMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__sub__ ( ConstDMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/3]

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__mul__ ( ConstDMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ mul() [3/3]

ConstDVectorExpression CDPL.Math.DScalarMatrix.__mul__ ( ConstDVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__div__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstDMatrixExpression CDPL.Math.DScalarMatrix.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstDMatrixExpression 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()