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

Represents the outcome of mathematical expressions/operations that result in a vector. More...

+ Inheritance diagram for CDPL.Math.DVectorExpression:

Public Member Functions

None swap (DVectorExpression e)
 Swaps the contents of this vector expression with those of e. More...
 
DVectorExpression assign (DVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
DVectorExpression assign (ConstFVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
DVectorExpression assign (ConstDVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
DVectorExpression assign (ConstLVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
DVectorExpression assign (ConstULVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
DVectorExpression assign (object a)
 Assigns the contents of the numpy.ndarray object a to this vector expression. More...
 
None setElement (int i, float v)
 Sets the value of the element at index i to v. More...
 
None __setitem__ (int i, float v)
 Sets the value of the element at index i to v. More...
 
DVectorExpression __iadd__ (DVectorExpression e)
 Adds the vector expression e element-wise to this expression. More...
 
DVectorExpression __iadd__ (ConstDVectorExpression e)
 Adds the vector expression e element-wise to this expression. More...
 
DVectorExpression __isub__ (DVectorExpression e)
 Subtracts the vector expression e element-wise from this expression. More...
 
DVectorExpression __isub__ (ConstDVectorExpression e)
 Subtracts the vector expression e element-wise from this expression. More...
 
DVectorExpression __imul__ (float t)
 Multiplies every element by the scalar t. More...
 
DVectorExpression __idiv__ (float t)
 Divides every element by the scalar t. More...
 
DVectorExpression __itruediv__ (float t)
 Divides every element by the scalar t. More...
 
- Public Member Functions inherited from CDPL.Math.ConstDVectorExpression
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
bool isEmpty ()
 Tells whether the vector is empty. More...
 
int getSize ()
 Returns the current element count. More...
 
float getElement (int i)
 Returns the element at index i. More...
 
object toArray ()
 Converts the ConstDVectorExpression instance into a corresponding numpy.ndarray object. More...
 
bool __eq__ (ConstDVectorExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstDVectorExpression e)
 Returns the result of the comparison operation self != e. More...
 
float __call__ (int i)
 Returns the element at index i. More...
 
float __getitem__ (int i)
 Returns the element at index i. More...
 
int __len__ ()
 Returns the current element count. More...
 
str __str__ ()
 Returns a string representation of the ConstDVectorExpression instance. More...
 
ConstDVectorExpression __pos__ ()
 Returns self. More...
 
ConstDVectorExpression __neg__ ()
 Returns the result of the operation self * -1. More...
 
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)
 Returns the result of the true division operation self / t. More...
 
ConstDVectorExpression __rmul__ (float t)
 Returns the result of the multiplication operation t * self. More...
 

Additional Inherited Members

- Properties inherited from CDPL.Math.ConstDVectorExpression
 objectID = property(getObjectID)
 
 size = property(getSize)
 

Detailed Description

Represents the outcome of mathematical expressions/operations that result in a vector.

Member Function Documentation

◆ swap()

None CDPL.Math.DVectorExpression.swap ( DVectorExpression  e)

Swaps the contents of this vector expression with those of e.

Parameters
eThe vector expression to swap with.

◆ assign() [1/6]

DVectorExpression CDPL.Math.DVectorExpression.assign ( DVectorExpression  e)

Assigns the contents of the vector expression e to this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [2/6]

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

Assigns the contents of the vector expression e to this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [3/6]

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

Assigns the contents of the vector expression e to this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [4/6]

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

Assigns the contents of the vector expression e to this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [5/6]

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

Assigns the contents of the vector expression e to this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [6/6]

DVectorExpression CDPL.Math.DVectorExpression.assign ( object  a)

Assigns the contents of the numpy.ndarray object a to this vector expression.

Parameters
aThe numpy.ndarray object.
See also
[NUMPY]

◆ setElement()

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

Sets the value of the element at index i to v.

Parameters
iThe zero-based element index.
vThe new value of the element.
Exceptions
Base.IndexErrorif i is not in the range [0, getSize()).

◆ __setitem__()

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

Sets the value of the element at index i to v.

Parameters
iThe zero-based element index.
vThe new value of the element.
Exceptions
Base.IndexErrorif i is not in the range [0, getSize()).

◆ __iadd__() [1/2]

DVectorExpression CDPL.Math.DVectorExpression.__iadd__ ( DVectorExpression  e)

Adds the vector expression e element-wise to this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ __iadd__() [2/2]

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

Adds the vector expression e element-wise to this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ __isub__() [1/2]

DVectorExpression CDPL.Math.DVectorExpression.__isub__ ( DVectorExpression  e)

Subtracts the vector expression e element-wise from this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ __isub__() [2/2]

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

Subtracts the vector expression e element-wise from this expression.

Parameters
eThe source vector expression.
Returns
self.

◆ __imul__()

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

Multiplies every element by the scalar t.

Parameters
tThe scalar multiplier.
Returns
self.

◆ __idiv__()

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

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __itruediv__()

DVectorExpression CDPL.Math.DVectorExpression.__itruediv__ ( float  t)

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.