CDPL.Math.SparseDMatrix Class Reference

An unbounded sparse matrix holding floating point values of type double. More...

Inheritance diagram for CDPL.Math.SparseDMatrix:

Public Member Functions
None	__init__ ()
	Initializes the SparseDMatrix instance.
None	__init__ (SparseDMatrix m)
	Initializes a copy of the SparseDMatrix instance m. More...
None	__init__ (int m, int n)
	Initializes the SparseDMatrix instance. More...
None	__init__ (ConstFMatrixExpression e)
	Initializes the SparseDMatrix instance. More...
None	__init__ (ConstDMatrixExpression e)
	Initializes the SparseDMatrix instance. More...
None	__init__ (ConstLMatrixExpression e)
	Initializes the SparseDMatrix instance. More...
None	__init__ (ConstULMatrixExpression e)
	Initializes the SparseDMatrix instance. More...
None	__init__ (object a)
	Initializes the SparseDMatrix 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...
SparseDMatrix	assign (ConstFMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e. More...
SparseDMatrix	assign (ConstDMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e. More...
SparseDMatrix	assign (ConstLMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e. More...
SparseDMatrix	assign (ConstULMatrixExpression e)
	Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e. More...
SparseDMatrix	assign (SparseDMatrix m)
	Replaces the current state of self with a copy of the state of the SparseDMatrix 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 ()
float	getElement (int i, int j)
object	toArray ()
None	swap (SparseDMatrix m)
None	setElement (int i, int j, float v)
float	__call__ (int i, int j)
float	__getitem__ (tuple ij)
int	__len__ ()
bool	__eq__ (SparseDMatrix 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__ (SparseDMatrix 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 SparseDMatrix instance. More...
SparseDMatrix	__pos__ ()
ConstDMatrixExpression	__neg__ ()
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)
ConstDMatrixExpression	__rmul__ (float t)
None	__setitem__ (tuple ij, float v)
SparseDMatrix	__iadd__ (SparseDMatrix m)
	Performs the in-place addition operation self += m. More...
SparseDMatrix	__iadd__ (ConstDMatrixExpression e)
	Performs the in-place addition operation self += e. More...
SparseDMatrix	__isub__ (SparseDMatrix m)
	Performs the in-place subtraction operation self -= m. More...
SparseDMatrix	__isub__ (ConstDMatrixExpression e)
	Performs the in-place subtraction operation self -= e. More...
SparseDMatrix	__imul__ (float t)
	Performs the in-place multiplication operation self *= t. More...
SparseDMatrix	__idiv__ (float t)
	Performs the in-place division operation self /= t. More...
SparseDMatrix	__itruediv__ (float t)

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

Detailed Description

An unbounded sparse matrix holding floating point values of type double.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.SparseDMatrix.__init__

(

SparseDMatrix

m

)

Initializes a copy of the SparseDMatrix instance m.

Parameters

m	The SparseDMatrix instance to copy.

__init__() [2/7]

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

Initializes the SparseDMatrix instance.

Parameters

m
n

__init__() [3/7]

None CDPL.Math.SparseDMatrix.__init__

(

ConstFMatrixExpression

e

)

Initializes the SparseDMatrix instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.SparseDMatrix.__init__

(

ConstDMatrixExpression

e

)

Initializes the SparseDMatrix instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.SparseDMatrix.__init__

(

ConstLMatrixExpression

e

)

Initializes the SparseDMatrix instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.SparseDMatrix.__init__

(

ConstULMatrixExpression

e

)

Initializes the SparseDMatrix instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.SparseDMatrix.__init__

(

object

a

)

Initializes the SparseDMatrix instance.

Parameters

a

Member Function Documentation

resize()

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

Parameters

m
n

getNumElements()

int CDPL.Math.SparseDMatrix.getNumElements

(

)

Returns

getObjectID()

int CDPL.Math.SparseDMatrix.getObjectID

(

)

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

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

SparseDMatrix CDPL.Math.SparseDMatrix.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]

SparseDMatrix CDPL.Math.SparseDMatrix.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]

SparseDMatrix CDPL.Math.SparseDMatrix.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]

SparseDMatrix CDPL.Math.SparseDMatrix.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]

SparseDMatrix CDPL.Math.SparseDMatrix.assign

(

SparseDMatrix

m

)

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

Parameters

m	The SparseDMatrix instance to copy.

Returns

self

assign() [6/6]

None CDPL.Math.SparseDMatrix.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.SparseDMatrix.getSize1

(

)

Returns

getSize2()

int CDPL.Math.SparseDMatrix.getSize2

(

)

Returns

isEmpty()

bool CDPL.Math.SparseDMatrix.isEmpty

(

)

Returns

getElement()

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

Parameters

i
j

Returns

toArray()

object CDPL.Math.SparseDMatrix.toArray

(

)

Returns

swap()

None CDPL.Math.SparseDMatrix.swap

(

SparseDMatrix

m

)

Parameters

m

setElement()

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

Parameters

i
j
v

__call__()

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

Parameters

i
j

Returns

__getitem__()

float CDPL.Math.SparseDMatrix.__getitem__

(

tuple

ij

)

Parameters

ij

Returns

__len__()

int CDPL.Math.SparseDMatrix.__len__

(

)

Returns

__eq__() [1/2]

bool CDPL.Math.SparseDMatrix.__eq__

(

SparseDMatrix

m

)

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

Parameters

m	The SparseDMatrix instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.SparseDMatrix.__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.SparseDMatrix.__ne__

(

SparseDMatrix

m

)

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

Parameters

m	The SparseDMatrix instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.SparseDMatrix.__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.SparseDMatrix.__str__

(

)

Returns a string representation of the SparseDMatrix instance.

Returns

The generated string representation.

__pos__()

SparseDMatrix CDPL.Math.SparseDMatrix.__pos__

(

)

Returns

__neg__()

ConstDMatrixExpression CDPL.Math.SparseDMatrix.__neg__

(

)

Returns

__add__()

ConstDMatrixExpression CDPL.Math.SparseDMatrix.__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.SparseDMatrix.__sub__

(

ConstDMatrixExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A SparseDMatrix instance holding the result of the subtraction.

__mul__() [1/3]

ConstDMatrixExpression CDPL.Math.SparseDMatrix.__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.SparseDMatrix.__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.SparseDMatrix.__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.SparseDMatrix.__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.SparseDMatrix.__truediv__

(

float

t

)

Parameters

t

Returns

__rmul__()

ConstDMatrixExpression CDPL.Math.SparseDMatrix.__rmul__

(

float

t

)

Parameters

t

Returns

__setitem__()

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

Parameters

ij
v

__iadd__() [1/2]

SparseDMatrix CDPL.Math.SparseDMatrix.__iadd__

(

SparseDMatrix

m

)

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

Parameters

m	Specifies the second addend.

Returns

The updated SparseDMatrix instance self.

__iadd__() [2/2]

SparseDMatrix CDPL.Math.SparseDMatrix.__iadd__

(

ConstDMatrixExpression

e

)

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

Parameters

e	Specifies the second addend.

Returns

The updated SparseDMatrix instance self.

__isub__() [1/2]

SparseDMatrix CDPL.Math.SparseDMatrix.__isub__

(

SparseDMatrix

m

)

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

Parameters

m	Specifies the subtrahend.

Returns

The updated SparseDMatrix instance self.

__isub__() [2/2]

SparseDMatrix CDPL.Math.SparseDMatrix.__isub__

(

ConstDMatrixExpression

e

)

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

Parameters

e	Specifies the subtrahend.

Returns

The updated SparseDMatrix instance self.

__imul__()

SparseDMatrix CDPL.Math.SparseDMatrix.__imul__

(

float

t

)

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

Parameters

t	Specifies the multiplier.

Returns

The updated SparseDMatrix instance self.

__idiv__()

SparseDMatrix CDPL.Math.SparseDMatrix.__idiv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

The updated SparseDMatrix instance self.

__itruediv__()

SparseDMatrix CDPL.Math.SparseDMatrix.__itruediv__

(

float

t

)

Parameters

t

Returns