CDPL.Math.SparseFVector Class Reference

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

Inheritance diagram for CDPL.Math.SparseFVector:

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

Properties
	objectID = property(getObjectID)
	size = property(getSize)
	numElements = property(getNumElements)

Detailed Description

An unbounded sparse vector holding floating point values of type float.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.SparseFVector.__init__

(

SparseFVector

v

)

Initializes a copy of the SparseFVector instance v.

Parameters

v	The SparseFVector instance to copy.

__init__() [2/7]

None CDPL.Math.SparseFVector.__init__

(

int

n

)

Initializes the SparseFVector instance.

Parameters

n

__init__() [3/7]

None CDPL.Math.SparseFVector.__init__

(

ConstFVectorExpression

e

)

Initializes the SparseFVector instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.SparseFVector.__init__

(

ConstDVectorExpression

e

)

Initializes the SparseFVector instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.SparseFVector.__init__

(

ConstLVectorExpression

e

)

Initializes the SparseFVector instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.SparseFVector.__init__

(

ConstULVectorExpression

e

)

Initializes the SparseFVector instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.SparseFVector.__init__

(

object

a

)

Initializes the SparseFVector instance.

Parameters

a

Member Function Documentation

resize()

None CDPL.Math.SparseFVector.resize

(

int

n

)

Parameters

n

getNumElements()

int CDPL.Math.SparseFVector.getNumElements

(

)

Returns

getObjectID()

int CDPL.Math.SparseFVector.getObjectID

(

)

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

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

SparseFVector CDPL.Math.SparseFVector.assign

(

ConstFVectorExpression

e

)

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

Parameters

e	The ConstFVectorExpression instance to copy.

Returns

self

assign() [2/6]

SparseFVector CDPL.Math.SparseFVector.assign

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to copy.

Returns

self

assign() [3/6]

SparseFVector CDPL.Math.SparseFVector.assign

(

ConstLVectorExpression

e

)

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

Parameters

e	The ConstLVectorExpression instance to copy.

Returns

self

assign() [4/6]

SparseFVector CDPL.Math.SparseFVector.assign

(

ConstULVectorExpression

e

)

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

Parameters

e	The ConstULVectorExpression instance to copy.

Returns

self

assign() [5/6]

SparseFVector CDPL.Math.SparseFVector.assign

(

SparseFVector

v

)

Replaces the current state of self with a copy of the state of the SparseFVector instance v.

Parameters

v	The SparseFVector instance to copy.

Returns

self

assign() [6/6]

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

isEmpty()

bool CDPL.Math.SparseFVector.isEmpty

(

)

Returns

getSize()

int CDPL.Math.SparseFVector.getSize

(

)

Returns

getElement()

float CDPL.Math.SparseFVector.getElement

(

int

i

)

Parameters

i

Returns

toArray()

object CDPL.Math.SparseFVector.toArray

(

)

Returns

swap()

None CDPL.Math.SparseFVector.swap

(

SparseFVector

v

)

Parameters

v

setElement()

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

Parameters

i
v

__eq__() [1/2]

bool CDPL.Math.SparseFVector.__eq__

(

SparseFVector

v

)

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

Parameters

v	The SparseFVector instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.SparseFVector.__eq__

(

ConstFVectorExpression

e

)

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

Parameters

e	The ConstFVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.SparseFVector.__ne__

(

SparseFVector

v

)

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

Parameters

v	The SparseFVector instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.SparseFVector.__ne__

(

ConstFVectorExpression

e

)

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

Parameters

e	The ConstFVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

float CDPL.Math.SparseFVector.__call__

(

int

i

)

Parameters

i

Returns

__getitem__()

float CDPL.Math.SparseFVector.__getitem__

(

int

i

)

Parameters

i

Returns

__len__()

int CDPL.Math.SparseFVector.__len__

(

)

Returns

__str__()

str CDPL.Math.SparseFVector.__str__

(

)

Returns a string representation of the SparseFVector instance.

Returns

The generated string representation.

__pos__()

SparseFVector CDPL.Math.SparseFVector.__pos__

(

)

Returns

__neg__()

ConstFVectorExpression CDPL.Math.SparseFVector.__neg__

(

)

Returns

__add__()

ConstFVectorExpression CDPL.Math.SparseFVector.__add__

(

ConstFVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstFVectorExpression instance holding the result of the addition.

__sub__()

ConstFVectorExpression CDPL.Math.SparseFVector.__sub__

(

ConstFVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A SparseFVector instance holding the result of the subtraction.

__mul__() [1/2]

ConstFVectorExpression CDPL.Math.SparseFVector.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstFVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstFVectorExpression CDPL.Math.SparseFVector.__mul__

(

ConstFMatrixExpression

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

ConstFVectorExpression CDPL.Math.SparseFVector.__div__

(

float

t

)

Returns the result of the division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstFVectorExpression instance holding the result of the division.

__truediv__()

ConstFVectorExpression CDPL.Math.SparseFVector.__truediv__

(

float

t

)

Parameters

t

Returns

__rmul__()

ConstFVectorExpression CDPL.Math.SparseFVector.__rmul__

(

float

t

)

Parameters

t

Returns

__setitem__()

None CDPL.Math.SparseFVector.__setitem__	(	int	i,
		float	v
	)

Parameters

i
v

__iadd__() [1/2]

SparseFVector CDPL.Math.SparseFVector.__iadd__

(

SparseFVector

v

)

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

Parameters

v	Specifies the second addend.

Returns

The updated SparseFVector instance self.

__iadd__() [2/2]

SparseFVector CDPL.Math.SparseFVector.__iadd__

(

ConstFVectorExpression

e

)

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

Parameters

e	Specifies the second addend.

Returns

The updated SparseFVector instance self.

__isub__() [1/2]

SparseFVector CDPL.Math.SparseFVector.__isub__

(

SparseFVector

v

)

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

Parameters

v	Specifies the subtrahend.

Returns

The updated SparseFVector instance self.

__isub__() [2/2]

SparseFVector CDPL.Math.SparseFVector.__isub__

(

ConstFVectorExpression

e

)

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

Parameters

e	Specifies the subtrahend.

Returns

The updated SparseFVector instance self.

__imul__()

SparseFVector CDPL.Math.SparseFVector.__imul__

(

float

t

)

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

Parameters

t	Specifies the multiplier.

Returns

The updated SparseFVector instance self.

__idiv__()

SparseFVector CDPL.Math.SparseFVector.__idiv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

The updated SparseFVector instance self.

__itruediv__()

SparseFVector CDPL.Math.SparseFVector.__itruediv__

(

float

t

)

Parameters

t

Returns