CDPL.Math.SparseLMatrix Class Reference

An unbounded sparse matrix holding signed integers of type long. More...

Inheritance diagram for CDPL.Math.SparseLMatrix:

Public Member Functions
None	__init__ ()
	Initializes the SparseLMatrix instance.
None	__init__ (SparseLMatrix m)
	Initializes a copy of the SparseLMatrix instance m. More...
None	__init__ (int m, int n)
	Initializes the SparseLMatrix instance. More...
None	__init__ (ConstFMatrixExpression e)
	Initializes the SparseLMatrix instance. More...
None	__init__ (ConstDMatrixExpression e)
	Initializes the SparseLMatrix instance. More...
None	__init__ (ConstLMatrixExpression e)
	Initializes the SparseLMatrix instance. More...
None	__init__ (ConstULMatrixExpression e)
	Initializes the SparseLMatrix instance. More...
None	__init__ (object a)
	Initializes the SparseLMatrix instance. More...
None	resize (int m, int n)
None	clear ()
int	getNumElements ()
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
SparseLMatrix	assign (ConstFMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e. More...
SparseLMatrix	assign (ConstDMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e. More...
SparseLMatrix	assign (ConstLMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e. More...
SparseLMatrix	assign (ConstULMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e. More...
SparseLMatrix	assign (SparseLMatrix m)
	Replaces the current state of self with a copy of the state of the SparseLMatrix instance m. More...
None	assign (object a)
	Replaces the current state of self with a copy of the state of the object instance a. More...
int	getSize1 ()
int	getSize2 ()
bool	isEmpty ()
int	getElement (int i, int j)
object	toArray ()
None	swap (SparseLMatrix m)
None	setElement (int i, int j, int v)
int	__call__ (int i, int j)
int	__getitem__ (tuple ij)
int	__len__ ()
bool	__eq__ (SparseLMatrix m)
	Returns the result of the comparison operation self == m. More...
bool	__eq__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (SparseLMatrix m)
	Returns the result of the comparison operation self != m. More...
bool	__ne__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the SparseLMatrix instance. More...
SparseLMatrix	__pos__ ()
ConstLMatrixExpression	__neg__ ()
ConstLMatrixExpression	__add__ (ConstLMatrixExpression e)
	Returns the result of the addition operation self + e. More...
ConstLMatrixExpression	__sub__ (ConstLMatrixExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstLMatrixExpression	__mul__ (int t)
	Returns the result of the multiplication operation self * t. More...
ConstLMatrixExpression	__mul__ (ConstLMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstLVectorExpression	__mul__ (ConstLVectorExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstLMatrixExpression	__div__ (int t)
	Returns the result of the division operation self / t. More...
ConstLMatrixExpression	__truediv__ (int t)
ConstLMatrixExpression	__rmul__ (int t)
None	__setitem__ (tuple ij, int v)
SparseLMatrix	__iadd__ (SparseLMatrix m)
	Performs the in-place addition operation self += m. More...
SparseLMatrix	__iadd__ (ConstLMatrixExpression e)
	Performs the in-place addition operation self += e. More...
SparseLMatrix	__isub__ (SparseLMatrix m)
	Performs the in-place subtraction operation self -= m. More...
SparseLMatrix	__isub__ (ConstLMatrixExpression e)
	Performs the in-place subtraction operation self -= e. More...
SparseLMatrix	__imul__ (int t)
	Performs the in-place multiplication operation self *= t. More...
SparseLMatrix	__idiv__ (int t)
	Performs the in-place division operation self /= t. More...
SparseLMatrix	__itruediv__ (int t)

Properties
	objectID = property(getObjectID)
	size1 = property(getSize1)
	size2 = property(getSize2)
	numElements = property(getNumElements)

Detailed Description

An unbounded sparse matrix holding signed integers of type long.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.SparseLMatrix.__init__

(

SparseLMatrix

m

)

Initializes a copy of the SparseLMatrix instance m.

Parameters

m	The SparseLMatrix instance to copy.

__init__() [2/7]

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

Initializes the SparseLMatrix instance.

Parameters

m
n

__init__() [3/7]

None CDPL.Math.SparseLMatrix.__init__

(

ConstFMatrixExpression

e

)

Initializes the SparseLMatrix instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.SparseLMatrix.__init__

(

ConstDMatrixExpression

e

)

Initializes the SparseLMatrix instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.SparseLMatrix.__init__

(

ConstLMatrixExpression

e

)

Initializes the SparseLMatrix instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.SparseLMatrix.__init__

(

ConstULMatrixExpression

e

)

Initializes the SparseLMatrix instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.SparseLMatrix.__init__

(

object

a

)

Initializes the SparseLMatrix instance.

Parameters

a

Member Function Documentation

resize()

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

Parameters

m
n

getNumElements()

int CDPL.Math.SparseLMatrix.getNumElements

(

)

Returns

getObjectID()

int CDPL.Math.SparseLMatrix.getObjectID

(

)

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

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

SparseLMatrix CDPL.Math.SparseLMatrix.assign

(

ConstFMatrixExpression

e

)

Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e.

Parameters

e	The ConstFMatrixExpression instance to copy.

Returns

self

assign() [2/6]

SparseLMatrix CDPL.Math.SparseLMatrix.assign

(

ConstDMatrixExpression

e

)

Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e.

Parameters

e	The ConstDMatrixExpression instance to copy.

Returns

self

assign() [3/6]

SparseLMatrix CDPL.Math.SparseLMatrix.assign

(

ConstLMatrixExpression

e

)

Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e.

Parameters

e	The ConstLMatrixExpression instance to copy.

Returns

self

assign() [4/6]

SparseLMatrix CDPL.Math.SparseLMatrix.assign

(

ConstULMatrixExpression

e

)

Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e.

Parameters

e	The ConstULMatrixExpression instance to copy.

Returns

self

assign() [5/6]

SparseLMatrix CDPL.Math.SparseLMatrix.assign

(

SparseLMatrix

m

)

Replaces the current state of self with a copy of the state of the SparseLMatrix instance m.

Parameters

m	The SparseLMatrix instance to copy.

Returns

self

assign() [6/6]

None CDPL.Math.SparseLMatrix.assign

(

object

a

)

Replaces the current state of self with a copy of the state of the object instance a.

Parameters

a	The object instance to copy.

Returns

self

getSize1()

int CDPL.Math.SparseLMatrix.getSize1

(

)

Returns

getSize2()

int CDPL.Math.SparseLMatrix.getSize2

(

)

Returns

isEmpty()

bool CDPL.Math.SparseLMatrix.isEmpty

(

)

Returns

getElement()

int CDPL.Math.SparseLMatrix.getElement	(	int	i,
		int	j
	)

Parameters

i
j

Returns

toArray()

object CDPL.Math.SparseLMatrix.toArray

(

)

Returns

swap()

None CDPL.Math.SparseLMatrix.swap

(

SparseLMatrix

m

)

Parameters

m

setElement()

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

Parameters

i
j
v

__call__()

int CDPL.Math.SparseLMatrix.__call__	(	int	i,
		int	j
	)

Parameters

i
j

Returns

__getitem__()

int CDPL.Math.SparseLMatrix.__getitem__

(

tuple

ij

)

Parameters

ij

Returns

__len__()

int CDPL.Math.SparseLMatrix.__len__

(

)

Returns

__eq__() [1/2]

bool CDPL.Math.SparseLMatrix.__eq__

(

SparseLMatrix

m

)

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

Parameters

m	The SparseLMatrix instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.SparseLMatrix.__eq__

(

ConstLMatrixExpression

e

)

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

Parameters

e	The ConstLMatrixExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.SparseLMatrix.__ne__

(

SparseLMatrix

m

)

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

Parameters

m	The SparseLMatrix instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.SparseLMatrix.__ne__

(

ConstLMatrixExpression

e

)

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

Parameters

e	The ConstLMatrixExpression instance to be compared with.

Returns

The result of the comparison operation.

__str__()

str CDPL.Math.SparseLMatrix.__str__

(

)

Returns a string representation of the SparseLMatrix instance.

Returns

The generated string representation.

__pos__()

SparseLMatrix CDPL.Math.SparseLMatrix.__pos__

(

)

Returns

__neg__()

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__neg__

(

)

Returns

__add__()

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__add__

(

ConstLMatrixExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstLMatrixExpression instance holding the result of the addition.

__sub__()

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__sub__

(

ConstLMatrixExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A SparseLMatrix instance holding the result of the subtraction.

__mul__() [1/3]

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__mul__

(

int

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstLMatrixExpression instance holding the result of the multiplication.

__mul__() [2/3]

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__mul__

(

ConstLMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstLMatrixExpression instance holding the result of the multiplication.

__mul__() [3/3]

ConstLVectorExpression CDPL.Math.SparseLMatrix.__mul__

(

ConstLVectorExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstLVectorExpression instance holding the result of the multiplication.

__div__()

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__div__

(

int

t

)

Returns the result of the division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstLMatrixExpression instance holding the result of the division.

__truediv__()

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__truediv__

(

int

t

)

Parameters

t

Returns

__rmul__()

ConstLMatrixExpression CDPL.Math.SparseLMatrix.__rmul__

(

int

t

)

Parameters

t

Returns

__setitem__()

None CDPL.Math.SparseLMatrix.__setitem__	(	tuple	ij,
		int	v
	)

Parameters

ij
v

__iadd__() [1/2]

SparseLMatrix CDPL.Math.SparseLMatrix.__iadd__

(

SparseLMatrix

m

)

Performs the in-place addition operation self += m.

Parameters

m	Specifies the second addend.

Returns

The updated SparseLMatrix instance self.

__iadd__() [2/2]

SparseLMatrix CDPL.Math.SparseLMatrix.__iadd__

(

ConstLMatrixExpression

e

)

Performs the in-place addition operation self += e.

Parameters

e	Specifies the second addend.

Returns

The updated SparseLMatrix instance self.

__isub__() [1/2]

SparseLMatrix CDPL.Math.SparseLMatrix.__isub__

(

SparseLMatrix

m

)

Performs the in-place subtraction operation self -= m.

Parameters

m	Specifies the subtrahend.

Returns

The updated SparseLMatrix instance self.

__isub__() [2/2]

SparseLMatrix CDPL.Math.SparseLMatrix.__isub__

(

ConstLMatrixExpression

e

)

Performs the in-place subtraction operation self -= e.

Parameters

e	Specifies the subtrahend.

Returns

The updated SparseLMatrix instance self.

__imul__()

SparseLMatrix CDPL.Math.SparseLMatrix.__imul__

(

int

t

)

Performs the in-place multiplication operation self *= t.

Parameters

t	Specifies the multiplier.

Returns

The updated SparseLMatrix instance self.

__idiv__()

SparseLMatrix CDPL.Math.SparseLMatrix.__idiv__

(

int

t

)

Performs the in-place division operation self /= t.

Parameters

t	Specifies the divisor.

Returns

The updated SparseLMatrix instance self.

__itruediv__()

SparseLMatrix CDPL.Math.SparseLMatrix.__itruediv__

(

int

t

)

Parameters

t

Returns