Unbounded sparse matrix holding unsigned integers of type unsigned long. More...

Inheritance diagram for CDPL.Math.SparseULMatrix:

Public Member Functions
None	__init__ ()
	Constructs an empty sparse matrix (zero rows, zero columns, no stored entries).

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

None	__init__ (int m, int n)
	Constructs a sparse matrix of size m×n with no stored entries. More...

None	__init__ (ConstFMatrixExpression e)
	Constructs a sparse matrix from the matrix expression e. More...

None	__init__ (ConstDMatrixExpression e)
	Constructs a sparse matrix from the matrix expression e. More...

None	__init__ (ConstLMatrixExpression e)
	Constructs a sparse matrix from the matrix expression e. More...

None	__init__ (ConstULMatrixExpression e)
	Constructs a sparse matrix from the matrix expression e. More...

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

None	resize (int m, int n)
	Resizes the logical dimensions to m×n, dropping any stored entries that fall outside the new bounds. More...

None	clear ()
	Removes all explicitly stored entries (the logical dimensions remain unchanged).

int	getNumElements ()
	Returns the number of explicitly stored (non-default) entries. More...

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

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

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

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

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

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

SparseULMatrix	assign (object a)
	Assigns the contents of the 2D `numpy.ndarray` object a to this matrix. 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 (zero rows or zero columns). More...

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

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

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

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

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

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

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

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

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

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

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

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

SparseULMatrix	__pos__ ()
	Returns self. More...

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

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

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

ConstULMatrixExpression	__mul__ (int t)
	Returns the result of the multiplication operation `self * t`. More...

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

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

ConstULMatrixExpression	__div__ (int t)
	Returns the result of the division operation `self // t`. More...

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

ConstULMatrixExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

None	__setitem__ (tuple ij, int v)
	Sets the value of the element (i, j) to v. More...

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

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

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

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

SparseULMatrix	__imul__ (int t)
	Multiplies every stored entry by the scalar t. More...

SparseULMatrix	__idiv__ (int t)
	Divides every stored entry by the scalar t. More...

SparseULMatrix	__itruediv__ (int t)
	Divides every stored entry by the scalar t. More...

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

	numElements = property(getNumElements)

Detailed Description

Unbounded sparse matrix holding unsigned integers of type unsigned long.

Constructor & Destructor Documentation

◆ init() [1/7]

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

Constructs a copy of the sparse matrix m.

Parameters

m	The sparse matrix to copy.

◆ init() [2/7]

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

Constructs a sparse matrix of size m×n with no stored entries.

Parameters

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

Exceptions

Base.SizeError if \( m \cdot n \) exceeds the underlying container's capacity.

◆ init() [3/7]

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

Constructs a sparse matrix from the matrix expression e.

Parameters

e	The source matrix expression.

Exceptions

Base.SizeError if the dimensions of e exceed the underlying container's capacity.

◆ init() [4/7]

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

Constructs a sparse matrix from the matrix expression e.

Parameters

e	The source matrix expression.

Exceptions

Base.SizeError if the dimensions of e exceed the underlying container's capacity.

◆ init() [5/7]

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

Constructs a sparse matrix from the matrix expression e.

Parameters

e	The source matrix expression.

Exceptions

Base.SizeError if the dimensions of e exceed the underlying container's capacity.

◆ init() [6/7]

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

Constructs a sparse matrix from the matrix expression e.

Parameters

e	The source matrix expression.

Exceptions

Base.SizeError if the dimensions of e exceed the underlying container's capacity.

◆ init() [7/7]

None CDPL.Math.SparseULMatrix.__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.SparseULMatrix.resize	(	int	m,
		int	n
	)

Resizes the logical dimensions to m×n, dropping any stored entries that fall outside the new bounds.

Parameters

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

Exceptions

Base.SizeError if \( m \cdot n \) exceeds the underlying container's capacity.

◆ getNumElements()

int CDPL.Math.SparseULMatrix.getNumElements ( )

Returns the number of explicitly stored (non-default) entries.

Returns: The number of stored entries.

◆ getObjectID()

int CDPL.Math.SparseULMatrix.getObjectID ( )

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

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

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

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

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [2/6]

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

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

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [3/6]

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

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

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [4/6]

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

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

Parameters

e	The source matrix expression.

Returns: self.

◆ assign() [5/6]

SparseULMatrix CDPL.Math.SparseULMatrix.assign ( SparseULMatrix m )

Copy-assigns the contents of m to this sparse matrix.

Parameters

m	The source sparse matrix.

Returns: self.

◆ assign() [6/6]

SparseULMatrix CDPL.Math.SparseULMatrix.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.SparseULMatrix.getSize1 ( )

Returns the logical number of rows.

Returns: The number of rows.

◆ getSize2()

int CDPL.Math.SparseULMatrix.getSize2 ( )

Returns the logical number of columns.

Returns: The number of columns.

◆ isEmpty()

bool CDPL.Math.SparseULMatrix.isEmpty ( )

Tells whether the matrix is empty (zero rows or zero columns).

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

◆ getElement()

int CDPL.Math.SparseULMatrix.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 stored value, or the zero element if no entry exists.

Exceptions

Base.IndexError if either index is out of range.

◆ toArray()

object CDPL.Math.SparseULMatrix.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

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

Swaps the contents of this sparse matrix with those of m.

Parameters

m	The sparse matrix to swap with.

◆ setElement()

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

int CDPL.Math.SparseULMatrix.__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 stored value, or the zero element if no entry exists.

Exceptions

Base.IndexError if either index is out of range.

◆ getitem()

int CDPL.Math.SparseULMatrix.__getitem__ ( tuple ij )

Returns the element at (i, j).

Parameters

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

Returns: The stored value, or the zero element if no entry exists.

Exceptions

Base.IndexError if either index is out of range.

◆ len()

int CDPL.Math.SparseULMatrix.__len__ ( )

Returns the number of rows.

Returns: The number of rows.

◆ eq() [1/2]

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

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

Parameters

m	The `SparseULMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.SparseULMatrix.__eq__ ( ConstULMatrixExpression e )

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

Parameters

e	The `ConstULMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

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

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

Parameters

m	The `SparseULMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.SparseULMatrix.__ne__ ( ConstULMatrixExpression e )

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

Parameters

e	The `ConstULMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.SparseULMatrix.__str__ ( )

Returns a string representation of the SparseULMatrix instance.

Returns: The generated string representation.

◆ pos()

SparseULMatrix CDPL.Math.SparseULMatrix.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__add__ ( ConstULMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__sub__ ( ConstULMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/3]

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__mul__ ( ConstULMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ mul() [3/3]

ConstULVectorExpression CDPL.Math.SparseULMatrix.__mul__ ( ConstULVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstULMatrixExpression CDPL.Math.SparseULMatrix.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ setitem()

None CDPL.Math.SparseULMatrix.__setitem__	(	tuple	ij,
		int	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]

SparseULMatrix CDPL.Math.SparseULMatrix.__iadd__ ( SparseULMatrix 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]

SparseULMatrix CDPL.Math.SparseULMatrix.__iadd__ ( ConstULMatrixExpression e )

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

Parameters

e	The source matrix expression.

Returns: self.

◆ isub() [1/2]

SparseULMatrix CDPL.Math.SparseULMatrix.__isub__ ( SparseULMatrix 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]

SparseULMatrix CDPL.Math.SparseULMatrix.__isub__ ( ConstULMatrixExpression e )

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

Parameters

e	The source matrix expression.

Returns: self.

◆ imul()

SparseULMatrix CDPL.Math.SparseULMatrix.__imul__ ( int t )

Multiplies every stored entry by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

SparseULMatrix CDPL.Math.SparseULMatrix.__idiv__ ( int t )

Divides every stored entry by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

SparseULMatrix CDPL.Math.SparseULMatrix.__itruediv__ ( int t )

Divides every stored entry by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/7]

◆ __init__() [2/7]

◆ __init__() [3/7]

◆ __init__() [4/7]

◆ __init__() [5/7]

◆ __init__() [6/7]

◆ __init__() [7/7]

Member Function Documentation

◆ resize()

◆ getNumElements()

◆ 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/7]

◆ init() [2/7]

◆ init() [3/7]

◆ init() [4/7]

◆ init() [5/7]

◆ init() [6/7]

◆ init() [7/7]

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