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

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

+ Inheritance diagram for CDPL.Math.FVectorExpression:

Public Member Functions

None swap (FVectorExpression e)
 Swaps the contents of this vector expression with those of e. More...
 
FVectorExpression assign (FVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
FVectorExpression assign (ConstFVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
FVectorExpression assign (ConstDVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
FVectorExpression assign (ConstLVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
FVectorExpression assign (ConstULVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
FVectorExpression 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...
 
FVectorExpression __iadd__ (FVectorExpression e)
 Adds the vector expression e element-wise to this expression. More...
 
FVectorExpression __iadd__ (ConstFVectorExpression e)
 Adds the vector expression e element-wise to this expression. More...
 
FVectorExpression __isub__ (FVectorExpression e)
 Subtracts the vector expression e element-wise from this expression. More...
 
FVectorExpression __isub__ (ConstFVectorExpression e)
 Subtracts the vector expression e element-wise from this expression. More...
 
FVectorExpression __imul__ (float t)
 Multiplies every element by the scalar t. More...
 
FVectorExpression __idiv__ (float t)
 Divides every element by the scalar t. More...
 
FVectorExpression __itruediv__ (float t)
 Divides every element by the scalar t. More...
 
- Public Member Functions inherited from CDPL.Math.ConstFVectorExpression
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 ConstFVectorExpression instance into a corresponding numpy.ndarray object. More...
 
bool __eq__ (ConstFVectorExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstFVectorExpression 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 ConstFVectorExpression instance. More...
 
ConstFVectorExpression __pos__ ()
 Returns self. More...
 
ConstFVectorExpression __neg__ ()
 Returns the result of the operation self * -1. More...
 
ConstFVectorExpression __add__ (ConstFVectorExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstFVectorExpression __sub__ (ConstFVectorExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstFVectorExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstFVectorExpression __mul__ (ConstFMatrixExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstFVectorExpression __div__ (float t)
 Returns the result of the division operation self // t. More...
 
ConstFVectorExpression __truediv__ (float t)
 Returns the result of the true division operation self / t. More...
 
ConstFVectorExpression __rmul__ (float t)
 Returns the result of the multiplication operation t * self. More...
 

Additional Inherited Members

- Properties inherited from CDPL.Math.ConstFVectorExpression
 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.FVectorExpression.swap ( FVectorExpression  e)

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

Parameters
eThe vector expression to swap with.

◆ assign() [1/6]

FVectorExpression CDPL.Math.FVectorExpression.assign ( FVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [2/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [3/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [4/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [5/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [6/6]

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

FVectorExpression CDPL.Math.FVectorExpression.__iadd__ ( FVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ __iadd__() [2/2]

FVectorExpression CDPL.Math.FVectorExpression.__iadd__ ( ConstFVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ __isub__() [1/2]

FVectorExpression CDPL.Math.FVectorExpression.__isub__ ( FVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ __isub__() [2/2]

FVectorExpression CDPL.Math.FVectorExpression.__isub__ ( ConstFVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ __imul__()

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

Multiplies every element by the scalar t.

Parameters
tThe scalar multiplier.
Returns
self.

◆ __idiv__()

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

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __itruediv__()

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

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.