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

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

+ Inheritance diagram for CDPL.Math.DVector:

Public Member Functions

None __init__ ()
 Initializes the DVector instance.
 
None __init__ (DVector v)
 Initializes a copy of the DVector instance v. More...
 
None __init__ (int n)
 Initializes the DVector instance. More...
 
None __init__ (int n, float v)
 Initializes the DVector instance. More...
 
None __init__ (ConstFVectorExpression e)
 Initializes the DVector instance. More...
 
None __init__ (ConstDVectorExpression e)
 Initializes the DVector instance. More...
 
None __init__ (ConstLVectorExpression e)
 Initializes the DVector instance. More...
 
None __init__ (ConstULVectorExpression e)
 Initializes the DVector instance. More...
 
None __init__ (object a)
 Initializes the DVector instance. More...
 
None resize (int n, float v=0.0)
 
None clear (float v=0.0)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
DVector assign (ConstFVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstFVectorExpression instance e. More...
 
DVector assign (ConstDVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstDVectorExpression instance e. More...
 
DVector assign (ConstLVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstLVectorExpression instance e. More...
 
DVector assign (ConstULVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstULVectorExpression instance e. More...
 
DVector assign (DVector v)
 Replaces the current state of self with a copy of the state of the DVector 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 (DVector v)
 
None setElement (int i, float v)
 
bool __eq__ (DVector 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__ (DVector 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 DVector instance. More...
 
DVector __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)
 
DVector __iadd__ (DVector v)
 Performs the in-place addition operation self += v. More...
 
DVector __iadd__ (ConstDVectorExpression e)
 Performs the in-place addition operation self += e. More...
 
DVector __isub__ (DVector v)
 Performs the in-place subtraction operation self -= v. More...
 
DVector __isub__ (ConstDVectorExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
DVector __imul__ (float t)
 Performs the in-place multiplication operation self *= t. More...
 
DVector __idiv__ (float t)
 Performs the in-place division operation self /= t. More...
 
DVector __itruediv__ (float t)
 

Properties

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

Detailed Description

An unbounded dense vector holding floating point values of type double.

Constructor & Destructor Documentation

◆ __init__() [1/8]

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

Initializes a copy of the DVector instance v.

Parameters
vThe DVector instance to copy.

◆ __init__() [2/8]

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

Initializes the DVector instance.

Parameters
n

◆ __init__() [3/8]

None CDPL.Math.DVector.__init__ ( int  n,
float  v 
)

Initializes the DVector instance.

Parameters
n
v

◆ __init__() [4/8]

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

Initializes the DVector instance.

Parameters
e

◆ __init__() [5/8]

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

Initializes the DVector instance.

Parameters
e

◆ __init__() [6/8]

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

Initializes the DVector instance.

Parameters
e

◆ __init__() [7/8]

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

Initializes the DVector instance.

Parameters
e

◆ __init__() [8/8]

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

Initializes the DVector instance.

Parameters
a

Member Function Documentation

◆ resize()

None CDPL.Math.DVector.resize ( int  n,
float   v = 0.0 
)
Parameters
n
v

◆ clear()

None CDPL.Math.DVector.clear ( float   v = 0.0)
Parameters
v

◆ getObjectID()

int CDPL.Math.DVector.getObjectID ( )

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

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

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

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

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

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

DVector CDPL.Math.DVector.assign ( DVector  v)

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

Parameters
vThe DVector instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize()

int CDPL.Math.DVector.getSize ( )
Returns

◆ getElement()

float CDPL.Math.DVector.getElement ( int  i)
Parameters
i
Returns

◆ toArray()

object CDPL.Math.DVector.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.DVector.__eq__ ( ConstDVectorExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.DVector.__ne__ ( ConstDVectorExpression  e)

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

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

◆ __call__()

float CDPL.Math.DVector.__call__ ( int  i)
Parameters
i
Returns

◆ __getitem__()

float CDPL.Math.DVector.__getitem__ ( int  i)
Parameters
i
Returns

◆ __len__()

int CDPL.Math.DVector.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.DVector.__str__ ( )

Returns a string representation of the DVector instance.

Returns
The generated string representation.

◆ __pos__()

DVector CDPL.Math.DVector.__pos__ ( )
Returns

◆ __neg__()

ConstDVectorExpression CDPL.Math.DVector.__neg__ ( )
Returns

◆ __add__()

ConstDVectorExpression CDPL.Math.DVector.__add__ ( ConstDVectorExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstDVectorExpression CDPL.Math.DVector.__sub__ ( ConstDVectorExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

ConstDVectorExpression CDPL.Math.DVector.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/2]

ConstDVectorExpression CDPL.Math.DVector.__mul__ ( ConstDMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstDVectorExpression CDPL.Math.DVector.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstDVectorExpression CDPL.Math.DVector.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstDVectorExpression CDPL.Math.DVector.__rmul__ ( float  t)
Parameters
t
Returns

◆ __setitem__()

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

◆ __iadd__() [1/2]

DVector CDPL.Math.DVector.__iadd__ ( DVector  v)

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

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

◆ __iadd__() [2/2]

DVector CDPL.Math.DVector.__iadd__ ( ConstDVectorExpression  e)

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

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

◆ __isub__() [1/2]

DVector CDPL.Math.DVector.__isub__ ( DVector  v)

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

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

◆ __isub__() [2/2]

DVector CDPL.Math.DVector.__isub__ ( ConstDVectorExpression  e)

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

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

◆ __imul__()

DVector CDPL.Math.DVector.__imul__ ( float  t)

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

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

◆ __idiv__()

DVector CDPL.Math.DVector.__idiv__ ( float  t)

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

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

◆ __itruediv__()

DVector CDPL.Math.DVector.__itruediv__ ( float  t)
Parameters
t
Returns