CDPL.Math.SparseDVector Class Reference

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

Inheritance diagram for CDPL.Math.SparseDVector:

Public Member Functions
None	__init__ ()
	Initializes the SparseDVector instance.
None	__init__ (SparseDVector v)
	Initializes a copy of the SparseDVector instance v. More...
None	__init__ (int n)
	Initializes the SparseDVector instance. More...
None	__init__ (ConstFVectorExpression e)
	Initializes the SparseDVector instance. More...
None	__init__ (ConstDVectorExpression e)
	Initializes the SparseDVector instance. More...
None	__init__ (ConstLVectorExpression e)
	Initializes the SparseDVector instance. More...
None	__init__ (ConstULVectorExpression e)
	Initializes the SparseDVector instance. More...
None	__init__ (object a)
	Initializes the SparseDVector instance. More...
None	resize (int n)
None	clear ()
int	getNumElements ()
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
SparseDVector	assign (ConstFVectorExpression e)
	Replaces the current state of self with a copy of the state of the ConstFVectorExpression instance e. More...
SparseDVector	assign (ConstDVectorExpression e)
	Replaces the current state of self with a copy of the state of the ConstDVectorExpression instance e. More...
SparseDVector	assign (ConstLVectorExpression e)
	Replaces the current state of self with a copy of the state of the ConstLVectorExpression instance e. More...
SparseDVector	assign (ConstULVectorExpression e)
	Replaces the current state of self with a copy of the state of the ConstULVectorExpression instance e. More...
SparseDVector	assign (SparseDVector v)
	Replaces the current state of self with a copy of the state of the SparseDVector 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 (SparseDVector v)
None	setElement (int i, float v)
bool	__eq__ (SparseDVector v)
	Returns the result of the comparison operation self == v. More...
bool	__eq__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (SparseDVector v)
	Returns the result of the comparison operation self != v. More...
bool	__ne__ (ConstDVectorExpression 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 SparseDVector instance. More...
SparseDVector	__pos__ ()
ConstDVectorExpression	__neg__ ()
ConstDVectorExpression	__add__ (ConstDVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstDVectorExpression	__sub__ (ConstDVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstDVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstDVectorExpression	__mul__ (ConstDMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDVectorExpression	__div__ (float t)
	Returns the result of the division operation self / t. More...
ConstDVectorExpression	__truediv__ (float t)
ConstDVectorExpression	__rmul__ (float t)
None	__setitem__ (int i, float v)
SparseDVector	__iadd__ (SparseDVector v)
	Performs the in-place addition operation self += v. More...
SparseDVector	__iadd__ (ConstDVectorExpression e)
	Performs the in-place addition operation self += e. More...
SparseDVector	__isub__ (SparseDVector v)
	Performs the in-place subtraction operation self -= v. More...
SparseDVector	__isub__ (ConstDVectorExpression e)
	Performs the in-place subtraction operation self -= e. More...
SparseDVector	__imul__ (float t)
	Performs the in-place multiplication operation self *= t. More...
SparseDVector	__idiv__ (float t)
	Performs the in-place division operation self /= t. More...
SparseDVector	__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 double.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.SparseDVector.__init__

(

SparseDVector

v

)

Initializes a copy of the SparseDVector instance v.

Parameters

v	The SparseDVector instance to copy.

__init__() [2/7]

None CDPL.Math.SparseDVector.__init__

(

int

n

)

Initializes the SparseDVector instance.

Parameters

n

__init__() [3/7]

None CDPL.Math.SparseDVector.__init__

(

ConstFVectorExpression

e

)

Initializes the SparseDVector instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.SparseDVector.__init__

(

ConstDVectorExpression

e

)

Initializes the SparseDVector instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.SparseDVector.__init__

(

ConstLVectorExpression

e

)

Initializes the SparseDVector instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.SparseDVector.__init__

(

ConstULVectorExpression

e

)

Initializes the SparseDVector instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.SparseDVector.__init__

(

object

a

)

Initializes the SparseDVector instance.

Parameters

a

Member Function Documentation

resize()

None CDPL.Math.SparseDVector.resize

(

int

n

)

Parameters

n

getNumElements()

int CDPL.Math.SparseDVector.getNumElements

(

)

Returns

getObjectID()

int CDPL.Math.SparseDVector.getObjectID

(

)

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

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

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

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

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

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

SparseDVector CDPL.Math.SparseDVector.assign

(

SparseDVector

v

)

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

Parameters

v	The SparseDVector instance to copy.

Returns

self

assign() [6/6]

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

(

)

Returns

getSize()

int CDPL.Math.SparseDVector.getSize

(

)

Returns

getElement()

float CDPL.Math.SparseDVector.getElement

(

int

i

)

Parameters

i

Returns

toArray()

object CDPL.Math.SparseDVector.toArray

(

)

Returns

swap()

None CDPL.Math.SparseDVector.swap

(

SparseDVector

v

)

Parameters

v

setElement()

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

Parameters

i
v

__eq__() [1/2]

bool CDPL.Math.SparseDVector.__eq__

(

SparseDVector

v

)

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

Parameters

v	The SparseDVector instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.SparseDVector.__eq__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.SparseDVector.__ne__

(

SparseDVector

v

)

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

Parameters

v	The SparseDVector instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.SparseDVector.__ne__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

float CDPL.Math.SparseDVector.__call__

(

int

i

)

Parameters

i

Returns

__getitem__()

float CDPL.Math.SparseDVector.__getitem__

(

int

i

)

Parameters

i

Returns

__len__()

int CDPL.Math.SparseDVector.__len__

(

)

Returns

__str__()

str CDPL.Math.SparseDVector.__str__

(

)

Returns a string representation of the SparseDVector instance.

Returns

The generated string representation.

__pos__()

SparseDVector CDPL.Math.SparseDVector.__pos__

(

)

Returns

__neg__()

ConstDVectorExpression CDPL.Math.SparseDVector.__neg__

(

)

Returns

__add__()

ConstDVectorExpression CDPL.Math.SparseDVector.__add__

(

ConstDVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstDVectorExpression instance holding the result of the addition.

__sub__()

ConstDVectorExpression CDPL.Math.SparseDVector.__sub__

(

ConstDVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A SparseDVector instance holding the result of the subtraction.

__mul__() [1/2]

ConstDVectorExpression CDPL.Math.SparseDVector.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstDVectorExpression CDPL.Math.SparseDVector.__mul__

(

ConstDMatrixExpression

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

ConstDVectorExpression CDPL.Math.SparseDVector.__div__

(

float

t

)

Returns the result of the division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__truediv__()

ConstDVectorExpression CDPL.Math.SparseDVector.__truediv__

(

float

t

)

Parameters

t

Returns

__rmul__()

ConstDVectorExpression CDPL.Math.SparseDVector.__rmul__

(

float

t

)

Parameters

t

Returns

__setitem__()

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

Parameters

i
v

__iadd__() [1/2]

SparseDVector CDPL.Math.SparseDVector.__iadd__

(

SparseDVector

v

)

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

Parameters

v	Specifies the second addend.

Returns

The updated SparseDVector instance self.

__iadd__() [2/2]

SparseDVector CDPL.Math.SparseDVector.__iadd__

(

ConstDVectorExpression

e

)

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

Parameters

e	Specifies the second addend.

Returns

The updated SparseDVector instance self.

__isub__() [1/2]

SparseDVector CDPL.Math.SparseDVector.__isub__

(

SparseDVector

v

)

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

Parameters

v	Specifies the subtrahend.

Returns

The updated SparseDVector instance self.

__isub__() [2/2]

SparseDVector CDPL.Math.SparseDVector.__isub__

(

ConstDVectorExpression

e

)

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

Parameters

e	Specifies the subtrahend.

Returns

The updated SparseDVector instance self.

__imul__()

SparseDVector CDPL.Math.SparseDVector.__imul__

(

float

t

)

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

Parameters

t	Specifies the multiplier.

Returns

The updated SparseDVector instance self.

__idiv__()

SparseDVector CDPL.Math.SparseDVector.__idiv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

The updated SparseDVector instance self.

__itruediv__()

SparseDVector CDPL.Math.SparseDVector.__itruediv__

(

float

t

)

Parameters

t

Returns