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

A bounded 7 element vector holding floating point values of type double. More...

+ Inheritance diagram for CDPL.Math.Vector7D:

Public Member Functions

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

Properties

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

Detailed Description

A bounded 7 element vector holding floating point values of type double.

Constructor & Destructor Documentation

◆ __init__() [1/7]

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

Initializes a copy of the Vector7D instance v.

Parameters
vThe Vector7D instance to copy.

◆ __init__() [2/7]

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

Initializes the Vector7D instance.

Parameters
v

◆ __init__() [3/7]

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

Initializes the Vector7D instance.

Parameters
e

◆ __init__() [4/7]

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

Initializes the Vector7D instance.

Parameters
e

◆ __init__() [5/7]

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

Initializes the Vector7D instance.

Parameters
e

◆ __init__() [6/7]

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

Initializes the Vector7D instance.

Parameters
e

◆ __init__() [7/7]

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

Initializes the Vector7D instance.

Parameters
a

Member Function Documentation

◆ clear()

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

◆ 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)

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]

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

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

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

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

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

Parameters
vThe Vector7D instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize()

int CDPL.Math.Vector7D.getSize ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.Vector7D.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __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)
Parameters
i
Returns

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.Vector7D.__len__ ( )
Returns

◆ __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

◆ __neg__()

ConstDVectorExpression CDPL.Math.Vector7D.__neg__ ( )
Returns

◆ __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)
Parameters
t
Returns

◆ __rmul__()

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

◆ __setitem__()

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

◆ __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)

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

Parameters
eSpecifies the second addend.
Returns
The updated Vector7D instance 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)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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