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

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

+ Inheritance diagram for CDPL.Math.LVectorExpression:

Public Member Functions

None swap (LVectorExpression e)
 Swaps the contents of this vector expression with those of e. More...
 
LVectorExpression assign (LVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
LVectorExpression assign (ConstFVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
LVectorExpression assign (ConstDVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
LVectorExpression assign (ConstLVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
LVectorExpression assign (ConstULVectorExpression e)
 Assigns the contents of the vector expression e to this expression. More...
 
LVectorExpression assign (object a)
 Assigns the contents of the numpy.ndarray object a to this vector expression. More...
 
None setElement (int i, int v)
 Sets the value of the element at index i to v. More...
 
None __setitem__ (int i, int v)
 Sets the value of the element at index i to v. More...
 
LVectorExpression __iadd__ (LVectorExpression e)
 Adds the vector expression e element-wise to this expression. More...
 
LVectorExpression __iadd__ (ConstLVectorExpression e)
 Adds the vector expression e element-wise to this expression. More...
 
LVectorExpression __isub__ (LVectorExpression e)
 Subtracts the vector expression e element-wise from this expression. More...
 
LVectorExpression __isub__ (ConstLVectorExpression e)
 Subtracts the vector expression e element-wise from this expression. More...
 
LVectorExpression __imul__ (int t)
 Multiplies every element by the scalar t. More...
 
LVectorExpression __idiv__ (int t)
 Divides every element by the scalar t. More...
 
LVectorExpression __itruediv__ (int t)
 Divides every element by the scalar t. More...
 
- Public Member Functions inherited from CDPL.Math.ConstLVectorExpression
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...
 
int getElement (int i)
 Returns the element at index i. More...
 
object toArray ()
 Converts the ConstLVectorExpression instance into a corresponding numpy.ndarray object. More...
 
bool __eq__ (ConstLVectorExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstLVectorExpression e)
 Returns the result of the comparison operation self != e. More...
 
int __call__ (int i)
 Returns the element at index i. More...
 
int __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 ConstLVectorExpression instance. More...
 
ConstLVectorExpression __pos__ ()
 Returns self. More...
 
ConstLVectorExpression __neg__ ()
 Returns the result of the operation self * -1. More...
 
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)
 Returns the result of the true division operation self / t. More...
 
ConstLVectorExpression __rmul__ (int t)
 Returns the result of the multiplication operation t * self. More...
 

Additional Inherited Members

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

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

Parameters
eThe vector expression to swap with.

◆ assign() [1/6]

LVectorExpression CDPL.Math.LVectorExpression.assign ( LVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [2/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [3/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [4/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [5/6]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [6/6]

LVectorExpression CDPL.Math.LVectorExpression.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.LVectorExpression.setElement ( int  i,
int  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.LVectorExpression.__setitem__ ( int  i,
int  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]

LVectorExpression CDPL.Math.LVectorExpression.__iadd__ ( LVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ __iadd__() [2/2]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ __isub__() [1/2]

LVectorExpression CDPL.Math.LVectorExpression.__isub__ ( LVectorExpression  e)

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

Parameters
eThe source vector expression.
Returns
self.

◆ __isub__() [2/2]

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

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

Parameters
eThe source vector expression.
Returns
self.

◆ __imul__()

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

Multiplies every element by the scalar t.

Parameters
tThe scalar multiplier.
Returns
self.

◆ __idiv__()

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

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __itruediv__()

LVectorExpression CDPL.Math.LVectorExpression.__itruediv__ ( int  t)

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.