CDPL.Math.SparseFMatrix Class Reference

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

Inheritance diagram for CDPL.Math.SparseFMatrix:

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

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.SparseFMatrix.__init__

(

SparseFMatrix

m

)

Initializes a copy of the SparseFMatrix instance m.

Parameters

m	The SparseFMatrix instance to copy.

__init__() [2/7]

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

Initializes the SparseFMatrix instance.

Parameters

m
n

__init__() [3/7]

None CDPL.Math.SparseFMatrix.__init__

(

ConstFMatrixExpression

e

)

Initializes the SparseFMatrix instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.SparseFMatrix.__init__

(

ConstDMatrixExpression

e

)

Initializes the SparseFMatrix instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.SparseFMatrix.__init__

(

ConstLMatrixExpression

e

)

Initializes the SparseFMatrix instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.SparseFMatrix.__init__

(

ConstULMatrixExpression

e

)

Initializes the SparseFMatrix instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.SparseFMatrix.__init__

(

object

a

)

Initializes the SparseFMatrix instance.

Parameters

a

Member Function Documentation

resize()

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

Parameters

m
n

getNumElements()

int CDPL.Math.SparseFMatrix.getNumElements

(

)

Returns

getObjectID()

int CDPL.Math.SparseFMatrix.getObjectID

(

)

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

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

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

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

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

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

SparseFMatrix CDPL.Math.SparseFMatrix.assign

(

SparseFMatrix

m

)

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

Parameters

m	The SparseFMatrix instance to copy.

Returns

self

assign() [6/6]

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

(

)

Returns

getSize2()

int CDPL.Math.SparseFMatrix.getSize2

(

)

Returns

isEmpty()

bool CDPL.Math.SparseFMatrix.isEmpty

(

)

Returns

getElement()

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

Parameters

i
j

Returns

toArray()

object CDPL.Math.SparseFMatrix.toArray

(

)

Returns

swap()

None CDPL.Math.SparseFMatrix.swap

(

SparseFMatrix

m

)

Parameters

m

setElement()

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

Parameters

i
j
v

__call__()

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

Parameters

i
j

Returns

__getitem__()

float CDPL.Math.SparseFMatrix.__getitem__

(

tuple

ij

)

Parameters

ij

Returns

__len__()

int CDPL.Math.SparseFMatrix.__len__

(

)

Returns

__eq__() [1/2]

bool CDPL.Math.SparseFMatrix.__eq__

(

SparseFMatrix

m

)

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

Parameters

m	The SparseFMatrix instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

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

(

SparseFMatrix

m

)

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

Parameters

m	The SparseFMatrix instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

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

(

)

Returns a string representation of the SparseFMatrix instance.

Returns

The generated string representation.

__pos__()

SparseFMatrix CDPL.Math.SparseFMatrix.__pos__

(

)

Returns

__neg__()

ConstFMatrixExpression CDPL.Math.SparseFMatrix.__neg__

(

)

Returns

__add__()

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

(

ConstFMatrixExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A SparseFMatrix instance holding the result of the subtraction.

__mul__() [1/3]

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

(

float

t

)

Parameters

t

Returns

__rmul__()

ConstFMatrixExpression CDPL.Math.SparseFMatrix.__rmul__

(

float

t

)

Parameters

t

Returns

__setitem__()

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

Parameters

ij
v

__iadd__() [1/2]

SparseFMatrix CDPL.Math.SparseFMatrix.__iadd__

(

SparseFMatrix

m

)

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

Parameters

m	Specifies the second addend.

Returns

The updated SparseFMatrix instance self.

__iadd__() [2/2]

SparseFMatrix CDPL.Math.SparseFMatrix.__iadd__

(

ConstFMatrixExpression

e

)

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

Parameters

e	Specifies the second addend.

Returns

The updated SparseFMatrix instance self.

__isub__() [1/2]

SparseFMatrix CDPL.Math.SparseFMatrix.__isub__

(

SparseFMatrix

m

)

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

Parameters

m	Specifies the subtrahend.

Returns

The updated SparseFMatrix instance self.

__isub__() [2/2]

SparseFMatrix CDPL.Math.SparseFMatrix.__isub__

(

ConstFMatrixExpression

e

)

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

Parameters

e	Specifies the subtrahend.

Returns

The updated SparseFMatrix instance self.

__imul__()

SparseFMatrix CDPL.Math.SparseFMatrix.__imul__

(

float

t

)

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

Parameters

t	Specifies the multiplier.

Returns

The updated SparseFMatrix instance self.

__idiv__()

SparseFMatrix CDPL.Math.SparseFMatrix.__idiv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

The updated SparseFMatrix instance self.

__itruediv__()

SparseFMatrix CDPL.Math.SparseFMatrix.__itruediv__

(

float

t

)

Parameters

t

Returns