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

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

+ Inheritance diagram for CDPL.Math.SparseULVector:

Public Member Functions

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

Properties

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

Detailed Description

An unbounded sparse vector holding unsigned integers of type unsigned long.

Constructor & Destructor Documentation

◆ __init__() [1/7]

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

Initializes a copy of the SparseULVector instance v.

Parameters
vThe SparseULVector instance to copy.

◆ __init__() [2/7]

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

Initializes the SparseULVector instance.

Parameters
n

◆ __init__() [3/7]

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

Initializes the SparseULVector instance.

Parameters
e

◆ __init__() [4/7]

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

Initializes the SparseULVector instance.

Parameters
e

◆ __init__() [5/7]

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

Initializes the SparseULVector instance.

Parameters
e

◆ __init__() [6/7]

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

Initializes the SparseULVector instance.

Parameters
e

◆ __init__() [7/7]

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

Initializes the SparseULVector instance.

Parameters
a

Member Function Documentation

◆ resize()

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

◆ getNumElements()

int CDPL.Math.SparseULVector.getNumElements ( )
Returns

◆ getObjectID()

int CDPL.Math.SparseULVector.getObjectID ( )

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

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

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

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

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

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

SparseULVector CDPL.Math.SparseULVector.assign ( SparseULVector  v)

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

Parameters
vThe SparseULVector instance to copy.
Returns
self

◆ assign() [6/6]

None CDPL.Math.SparseULVector.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.SparseULVector.isEmpty ( )
Returns

◆ getSize()

int CDPL.Math.SparseULVector.getSize ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.SparseULVector.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.SparseULVector.__eq__ ( ConstULVectorExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.SparseULVector.__ne__ ( ConstULVectorExpression  e)

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

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.SparseULVector.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.SparseULVector.__str__ ( )

Returns a string representation of the SparseULVector instance.

Returns
The generated string representation.

◆ __pos__()

SparseULVector CDPL.Math.SparseULVector.__pos__ ( )
Returns

◆ __neg__()

ConstULVectorExpression CDPL.Math.SparseULVector.__neg__ ( )
Returns

◆ __add__()

ConstULVectorExpression CDPL.Math.SparseULVector.__add__ ( ConstULVectorExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstULVectorExpression CDPL.Math.SparseULVector.__sub__ ( ConstULVectorExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

ConstULVectorExpression CDPL.Math.SparseULVector.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/2]

ConstULVectorExpression CDPL.Math.SparseULVector.__mul__ ( ConstULMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstULVectorExpression CDPL.Math.SparseULVector.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstULVectorExpression CDPL.Math.SparseULVector.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

ConstULVectorExpression CDPL.Math.SparseULVector.__rmul__ ( int  t)
Parameters
t
Returns

◆ __setitem__()

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

◆ __iadd__() [1/2]

SparseULVector CDPL.Math.SparseULVector.__iadd__ ( SparseULVector  v)

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

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

◆ __iadd__() [2/2]

SparseULVector CDPL.Math.SparseULVector.__iadd__ ( ConstULVectorExpression  e)

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

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

◆ __isub__() [1/2]

SparseULVector CDPL.Math.SparseULVector.__isub__ ( SparseULVector  v)

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

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

◆ __isub__() [2/2]

SparseULVector CDPL.Math.SparseULVector.__isub__ ( ConstULVectorExpression  e)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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