Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Math.SparseLVector Class Reference

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

+ Inheritance diagram for CDPL.Math.SparseLVector:

Public Member Functions

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

Properties

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

Detailed Description

An unbounded sparse vector holding signed integers of type long.

Constructor & Destructor Documentation

◆ __init__() [1/7]

None CDPL.Math.SparseLVector.__init__ ( SparseLVector  v)

Initializes a copy of the SparseLVector instance v.

Parameters
vThe SparseLVector instance to copy.

◆ __init__() [2/7]

None CDPL.Math.SparseLVector.__init__ ( int  n)

Initializes the SparseLVector instance.

Parameters
n

◆ __init__() [3/7]

None CDPL.Math.SparseLVector.__init__ ( ConstFVectorExpression  e)

Initializes the SparseLVector instance.

Parameters
e

◆ __init__() [4/7]

None CDPL.Math.SparseLVector.__init__ ( ConstDVectorExpression  e)

Initializes the SparseLVector instance.

Parameters
e

◆ __init__() [5/7]

None CDPL.Math.SparseLVector.__init__ ( ConstLVectorExpression  e)

Initializes the SparseLVector instance.

Parameters
e

◆ __init__() [6/7]

None CDPL.Math.SparseLVector.__init__ ( ConstULVectorExpression  e)

Initializes the SparseLVector instance.

Parameters
e

◆ __init__() [7/7]

None CDPL.Math.SparseLVector.__init__ ( object  a)

Initializes the SparseLVector instance.

Parameters
a

Member Function Documentation

◆ resize()

None CDPL.Math.SparseLVector.resize ( int  n)
Parameters
n

◆ getNumElements()

int CDPL.Math.SparseLVector.getNumElements ( )
Returns

◆ getObjectID()

int CDPL.Math.SparseLVector.getObjectID ( )

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

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

SparseLVector CDPL.Math.SparseLVector.assign ( ConstFVectorExpression  e)

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

Parameters
eThe ConstFVectorExpression instance to copy.
Returns
self

◆ assign() [2/6]

SparseLVector CDPL.Math.SparseLVector.assign ( ConstDVectorExpression  e)

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

Parameters
eThe ConstDVectorExpression instance to copy.
Returns
self

◆ assign() [3/6]

SparseLVector CDPL.Math.SparseLVector.assign ( ConstLVectorExpression  e)

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

Parameters
eThe ConstLVectorExpression instance to copy.
Returns
self

◆ assign() [4/6]

SparseLVector CDPL.Math.SparseLVector.assign ( ConstULVectorExpression  e)

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

Parameters
eThe ConstULVectorExpression instance to copy.
Returns
self

◆ assign() [5/6]

SparseLVector CDPL.Math.SparseLVector.assign ( SparseLVector  v)

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

Parameters
vThe SparseLVector instance to copy.
Returns
self

◆ assign() [6/6]

None CDPL.Math.SparseLVector.assign ( object  a)

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

Parameters
aThe object instance to copy.
Returns
self

◆ isEmpty()

bool CDPL.Math.SparseLVector.isEmpty ( )
Returns

◆ getSize()

int CDPL.Math.SparseLVector.getSize ( )
Returns

◆ getElement()

int CDPL.Math.SparseLVector.getElement ( int  i)
Parameters
i
Returns

◆ toArray()

object CDPL.Math.SparseLVector.toArray ( )
Returns

◆ swap()

None CDPL.Math.SparseLVector.swap ( SparseLVector  v)
Parameters
v

◆ setElement()

None CDPL.Math.SparseLVector.setElement ( int  i,
int  v 
)
Parameters
i
v

◆ __eq__() [1/2]

bool CDPL.Math.SparseLVector.__eq__ ( SparseLVector  v)

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

Parameters
vThe SparseLVector instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

bool CDPL.Math.SparseLVector.__eq__ ( ConstLVectorExpression  e)

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

Parameters
eThe ConstLVectorExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [1/2]

bool CDPL.Math.SparseLVector.__ne__ ( SparseLVector  v)

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

Parameters
vThe SparseLVector instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

bool CDPL.Math.SparseLVector.__ne__ ( ConstLVectorExpression  e)

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

Parameters
eThe ConstLVectorExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __call__()

int CDPL.Math.SparseLVector.__call__ ( int  i)
Parameters
i
Returns

◆ __getitem__()

int CDPL.Math.SparseLVector.__getitem__ ( int  i)
Parameters
i
Returns

◆ __len__()

int CDPL.Math.SparseLVector.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.SparseLVector.__str__ ( )

Returns a string representation of the SparseLVector instance.

Returns
The generated string representation.

◆ __pos__()

SparseLVector CDPL.Math.SparseLVector.__pos__ ( )
Returns

◆ __neg__()

ConstLVectorExpression CDPL.Math.SparseLVector.__neg__ ( )
Returns

◆ __add__()

ConstLVectorExpression CDPL.Math.SparseLVector.__add__ ( ConstLVectorExpression  e)

Returns the result of the addition operation self + e.

Parameters
eSpecifies the second addend.
Returns
A ConstLVectorExpression instance holding the result of the addition.

◆ __sub__()

ConstLVectorExpression CDPL.Math.SparseLVector.__sub__ ( ConstLVectorExpression  e)

Returns the result of the subtraction operation self - e.

Parameters
eSpecifies the subtrahend.
Returns
A SparseLVector instance holding the result of the subtraction.

◆ __mul__() [1/2]

ConstLVectorExpression CDPL.Math.SparseLVector.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

Parameters
tSpecifies the multiplier.
Returns
A ConstLVectorExpression instance holding the result of the multiplication.

◆ __mul__() [2/2]

ConstLVectorExpression CDPL.Math.SparseLVector.__mul__ ( ConstLMatrixExpression  e)

Returns the result of the multiplication operation self * e.

Parameters
eSpecifies the multiplier.
Returns
A ConstLVectorExpression instance holding the result of the multiplication.

◆ __div__()

ConstLVectorExpression CDPL.Math.SparseLVector.__div__ ( int  t)

Returns the result of the division operation self / t.

Parameters
tSpecifies the divisor.
Returns
A ConstLVectorExpression instance holding the result of the division.

◆ __truediv__()

ConstLVectorExpression CDPL.Math.SparseLVector.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

ConstLVectorExpression CDPL.Math.SparseLVector.__rmul__ ( int  t)
Parameters
t
Returns

◆ __setitem__()

None CDPL.Math.SparseLVector.__setitem__ ( int  i,
int  v 
)
Parameters
i
v

◆ __iadd__() [1/2]

SparseLVector CDPL.Math.SparseLVector.__iadd__ ( SparseLVector  v)

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

Parameters
vSpecifies the second addend.
Returns
The updated SparseLVector instance self.

◆ __iadd__() [2/2]

SparseLVector CDPL.Math.SparseLVector.__iadd__ ( ConstLVectorExpression  e)

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

Parameters
eSpecifies the second addend.
Returns
The updated SparseLVector instance self.

◆ __isub__() [1/2]

SparseLVector CDPL.Math.SparseLVector.__isub__ ( SparseLVector  v)

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

Parameters
vSpecifies the subtrahend.
Returns
The updated SparseLVector instance self.

◆ __isub__() [2/2]

SparseLVector CDPL.Math.SparseLVector.__isub__ ( ConstLVectorExpression  e)

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

Parameters
eSpecifies the subtrahend.
Returns
The updated SparseLVector instance self.

◆ __imul__()

SparseLVector CDPL.Math.SparseLVector.__imul__ ( int  t)

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

Parameters
tSpecifies the multiplier.
Returns
The updated SparseLVector instance self.

◆ __idiv__()

SparseLVector CDPL.Math.SparseLVector.__idiv__ ( int  t)

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

Parameters
tSpecifies the divisor.
Returns
The updated SparseLVector instance self.

◆ __itruediv__()

SparseLVector CDPL.Math.SparseLVector.__itruediv__ ( int  t)
Parameters
t
Returns