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

Bounded 7-element vector holding floating-point values of type double. More...

+ Inheritance diagram for CDPL.Math.Vector7D:

Public Member Functions

None __init__ ()
 Constructs a zero-initialized N element vector.
 
None __init__ (Vector7D vec)
 Constructs a copy of the fixed-size vector vec. More...
 
None __init__ (float v)
 Constructs an N-element vector with every element initialized to v. More...
 
None __init__ (ConstFVectorExpression e)
 Constructs a fixed-size vector from the vector expression e. More...
 
None __init__ (ConstDVectorExpression e)
 Constructs a fixed-size vector from the vector expression e. More...
 
None __init__ (ConstLVectorExpression e)
 Constructs a fixed-size vector from the vector expression e. More...
 
None __init__ (ConstULVectorExpression e)
 Constructs a fixed-size vector from the vector expression e. More...
 
None __init__ (object a)
 Contructs the Vector7D instance. More...
 
None clear (float v=0.0)
 Sets every element of the vector to the value v. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Vector7D assign (ConstFVectorExpression e)
 Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
 
Vector7D assign (ConstDVectorExpression e)
 Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
 
Vector7D assign (ConstLVectorExpression e)
 Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
 
Vector7D assign (ConstULVectorExpression e)
 Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
 
Vector7D assign (Vector7D v)
 Copy-assigns the elements of v to this fixed-size vector. More...
 
Vector7D assign (object a)
 Replaces the current state with a copy of the state of the object instance a. More...
 
bool isEmpty ()
 Tells whether the vector is empty (N is zero). More...
 
int getSize ()
 Returns the fixed element count N. More...
 
float getElement (int i)
 
object toArray ()
 Converts the Vector7D instance into a corresponding numpy.ndarray object. More...
 
None swap (Vector7D v)
 Swaps the contents of this fixed-size vector with those of v. More...
 
None setElement (int i, float v)
 
bool __eq__ (Vector7D 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__ (Vector7D 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)
 Returns the element at index i. More...
 
float __getitem__ (int i)
 Returns the element at index i. More...
 
int __len__ ()
 Returns the fixed element count N. More...
 
str __str__ ()
 Returns a string representation of the Vector7D instance. More...
 
Vector7D __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...
 
None __setitem__ (int i, float v)
 
Vector7D __iadd__ (Vector7D v)
 Performs the in-place addition operation self += v. More...
 
Vector7D __iadd__ (ConstDVectorExpression e)
 Adds the vector expression e element-wise to this fixed-size vector (via a temporary to handle aliasing). More...
 
Vector7D __isub__ (Vector7D v)
 Performs the in-place subtraction operation self -= v. More...
 
Vector7D __isub__ (ConstDVectorExpression e)
 Subtracts the vector expression e element-wise from this fixed-size vector (via a temporary to handle aliasing). More...
 
Vector7D __imul__ (float t)
 Multiplies every element by the scalar t. More...
 
Vector7D __idiv__ (float t)
 Divides every element by the scalar t. More...
 
Vector7D __itruediv__ (float t)
 Divides every element by the scalar t. More...
 

Properties

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

Detailed Description

Bounded 7-element vector holding floating-point values of type double.

Constructor & Destructor Documentation

◆ __init__() [1/7]

None CDPL.Math.Vector7D.__init__ ( Vector7D  vec)

Constructs a copy of the fixed-size vector vec.

Parameters
vecThe fixed-size vector to copy.

◆ __init__() [2/7]

None CDPL.Math.Vector7D.__init__ ( float  v)

Constructs an N-element vector with every element initialized to v.

Parameters
vThe initial element value.

◆ __init__() [3/7]

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

Constructs a fixed-size vector from the vector expression e.

Parameters
eThe source vector expression.

◆ __init__() [4/7]

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

Constructs a fixed-size vector from the vector expression e.

Parameters
eThe source vector expression.

◆ __init__() [5/7]

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

Constructs a fixed-size vector from the vector expression e.

Parameters
eThe source vector expression.

◆ __init__() [6/7]

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

Constructs a fixed-size vector from the vector expression e.

Parameters
eThe source vector expression.

◆ __init__() [7/7]

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

Contructs the Vector7D instance.

Parameters
a

Member Function Documentation

◆ clear()

None CDPL.Math.Vector7D.clear ( float   v = 0.0)

Sets every element of the vector to the value v.

Parameters
vThe fill value.

◆ getObjectID()

int CDPL.Math.Vector7D.getObjectID ( )

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

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

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [2/6]

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [3/6]

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [4/6]

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters
eThe source vector expression.
Returns
self.

◆ assign() [5/6]

Vector7D CDPL.Math.Vector7D.assign ( Vector7D  v)

Copy-assigns the elements of v to this fixed-size vector.

Parameters
vThe source fixed-size vector.
Returns
self.

◆ assign() [6/6]

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

Replaces the current state with a copy of the state of the object instance a.

Parameters
aThe object instance to copy.
Returns
self.

◆ isEmpty()

bool CDPL.Math.Vector7D.isEmpty ( )

Tells whether the vector is empty (N is zero).

Returns
True if N is zero, and False otherwise.

◆ getSize()

int CDPL.Math.Vector7D.getSize ( )

Returns the fixed element count N.

Returns
The element count.

◆ toArray()

object CDPL.Math.Vector7D.toArray ( )

Converts the Vector7D instance into a corresponding numpy.ndarray object.

Returns
The generated numpy.ndarray object.
See also
[NUMPY]

◆ swap()

None CDPL.Math.Vector7D.swap ( Vector7D  v)

Swaps the contents of this fixed-size vector with those of v.

Parameters
vThe fixed-size vector to swap with.

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.Vector7D.__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.Vector7D.__ne__ ( Vector7D  v)

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

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

◆ __ne__() [2/2]

bool CDPL.Math.Vector7D.__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.Vector7D.__call__ ( int  i)

Returns the element at index i.

Parameters
iThe zero-based element index.
Returns
The value of the element.
Exceptions
Base.IndexErrorif i is out of range.

◆ __getitem__()

float CDPL.Math.Vector7D.__getitem__ ( int  i)

Returns the element at index i.

Parameters
iThe zero-based element index.
Returns
The value of the element.
Exceptions
Base.IndexErrorif i is out of range.

◆ __len__()

int CDPL.Math.Vector7D.__len__ ( )

Returns the fixed element count N.

Returns
The element count.

◆ __str__()

str CDPL.Math.Vector7D.__str__ ( )

Returns a string representation of the Vector7D instance.

Returns
The generated string representation.

◆ __pos__()

Vector7D CDPL.Math.Vector7D.__pos__ ( )

Returns self.

Returns
self.

◆ __neg__()

ConstDVectorExpression CDPL.Math.Vector7D.__neg__ ( )

Returns the result of the operation self * -1.

Returns
A ConstDVectorExpression instance holding the result of the element negation.

◆ __add__()

ConstDVectorExpression CDPL.Math.Vector7D.__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.Vector7D.__sub__ ( ConstDVectorExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

ConstDVectorExpression CDPL.Math.Vector7D.__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.Vector7D.__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.Vector7D.__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.Vector7D.__truediv__ ( float  t)

Returns the result of the true division operation self / t.

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

◆ __rmul__()

ConstDVectorExpression CDPL.Math.Vector7D.__rmul__ ( float  t)

Returns the result of the multiplication operation t * self.

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

◆ __iadd__() [1/2]

Vector7D CDPL.Math.Vector7D.__iadd__ ( Vector7D  v)

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

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

◆ __iadd__() [2/2]

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

Adds the vector expression e element-wise to this fixed-size vector (via a temporary to handle aliasing).

Parameters
eThe source vector expression.
Returns
self.

◆ __isub__() [1/2]

Vector7D CDPL.Math.Vector7D.__isub__ ( Vector7D  v)

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

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

◆ __isub__() [2/2]

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

Subtracts the vector expression e element-wise from this fixed-size vector (via a temporary to handle aliasing).

Parameters
eThe source vector expression.
Returns
self.

◆ __imul__()

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

Multiplies every element by the scalar t.

Parameters
tThe scalar multiplier.
Returns
self.

◆ __idiv__()

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

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.

◆ __itruediv__()

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

Divides every element by the scalar t.

Parameters
tThe scalar divisor.
Returns
self.