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

A bounded 2 element vector holding floating point values of type float. More...

+ Inheritance diagram for CDPL.Math.Vector2F:

Public Member Functions

None __init__ ()
 Initializes the Vector2F instance.
 
None __init__ (Vector2F v)
 Initializes a copy of the Vector2F instance v. More...
 
None __init__ (float v)
 Initializes the Vector2F instance. More...
 
None __init__ (ConstFVectorExpression e)
 Initializes the Vector2F instance. More...
 
None __init__ (ConstDVectorExpression e)
 Initializes the Vector2F instance. More...
 
None __init__ (ConstLVectorExpression e)
 Initializes the Vector2F instance. More...
 
None __init__ (ConstULVectorExpression e)
 Initializes the Vector2F instance. More...
 
None __init__ (object a)
 Initializes the Vector2F instance. More...
 
None clear (float v=0.0)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Vector2F assign (ConstFVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstFVectorExpression instance e. More...
 
Vector2F assign (ConstDVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstDVectorExpression instance e. More...
 
Vector2F assign (ConstLVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstLVectorExpression instance e. More...
 
Vector2F assign (ConstULVectorExpression e)
 Replaces the current state of self with a copy of the state of the ConstULVectorExpression instance e. More...
 
Vector2F assign (Vector2F v)
 Replaces the current state of self with a copy of the state of the Vector2F 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 (Vector2F v)
 
None setElement (int i, float v)
 
bool __eq__ (Vector2F v)
 Returns the result of the comparison operation self == v. More...
 
bool __eq__ (ConstFVectorExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (Vector2F v)
 Returns the result of the comparison operation self != v. More...
 
bool __ne__ (ConstFVectorExpression 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 Vector2F instance. More...
 
Vector2F __pos__ ()
 
ConstFVectorExpression __neg__ ()
 
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)
 
ConstFVectorExpression __rmul__ (float t)
 
None __setitem__ (int i, float v)
 
Vector2F __iadd__ (Vector2F v)
 Performs the in-place addition operation self += v. More...
 
Vector2F __iadd__ (ConstFVectorExpression e)
 Performs the in-place addition operation self += e. More...
 
Vector2F __isub__ (Vector2F v)
 Performs the in-place subtraction operation self -= v. More...
 
Vector2F __isub__ (ConstFVectorExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
Vector2F __imul__ (float t)
 Performs the in-place multiplication operation self *= t. More...
 
Vector2F __idiv__ (float t)
 Performs the in-place division operation self /= t. More...
 
Vector2F __itruediv__ (float t)
 

Properties

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

Detailed Description

A bounded 2 element vector holding floating point values of type float.

Constructor & Destructor Documentation

◆ __init__() [1/7]

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

Initializes a copy of the Vector2F instance v.

Parameters
vThe Vector2F instance to copy.

◆ __init__() [2/7]

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

Initializes the Vector2F instance.

Parameters
v

◆ __init__() [3/7]

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

Initializes the Vector2F instance.

Parameters
e

◆ __init__() [4/7]

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

Initializes the Vector2F instance.

Parameters
e

◆ __init__() [5/7]

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

Initializes the Vector2F instance.

Parameters
e

◆ __init__() [6/7]

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

Initializes the Vector2F instance.

Parameters
e

◆ __init__() [7/7]

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

Initializes the Vector2F instance.

Parameters
a

Member Function Documentation

◆ clear()

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

◆ getObjectID()

int CDPL.Math.Vector2F.getObjectID ( )

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

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

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

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

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

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

Vector2F CDPL.Math.Vector2F.assign ( Vector2F  v)

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

Parameters
vThe Vector2F instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize()

int CDPL.Math.Vector2F.getSize ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.Vector2F.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.Vector2F.__eq__ ( ConstFVectorExpression  e)

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

Parameters
eThe ConstFVectorExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [1/2]

bool CDPL.Math.Vector2F.__ne__ ( Vector2F  v)

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

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

◆ __ne__() [2/2]

bool CDPL.Math.Vector2F.__ne__ ( ConstFVectorExpression  e)

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

Parameters
eThe ConstFVectorExpression instance to be compared with.
Returns
The result of the comparison operation.

◆ __call__()

float CDPL.Math.Vector2F.__call__ ( int  i)
Parameters
i
Returns

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.Vector2F.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.Vector2F.__str__ ( )

Returns a string representation of the Vector2F instance.

Returns
The generated string representation.

◆ __pos__()

Vector2F CDPL.Math.Vector2F.__pos__ ( )
Returns

◆ __neg__()

ConstFVectorExpression CDPL.Math.Vector2F.__neg__ ( )
Returns

◆ __add__()

ConstFVectorExpression CDPL.Math.Vector2F.__add__ ( ConstFVectorExpression  e)

Returns the result of the addition operation self + e.

Parameters
eSpecifies the second addend.
Returns
A ConstFVectorExpression instance holding the result of the addition.

◆ __sub__()

ConstFVectorExpression CDPL.Math.Vector2F.__sub__ ( ConstFVectorExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

ConstFVectorExpression CDPL.Math.Vector2F.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

Parameters
tSpecifies the multiplier.
Returns
A ConstFVectorExpression instance holding the result of the multiplication.

◆ __mul__() [2/2]

ConstFVectorExpression CDPL.Math.Vector2F.__mul__ ( ConstFMatrixExpression  e)

Returns the result of the multiplication operation self * e.

Parameters
eSpecifies the multiplier.
Returns
A ConstFVectorExpression instance holding the result of the multiplication.

◆ __div__()

ConstFVectorExpression CDPL.Math.Vector2F.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstFVectorExpression CDPL.Math.Vector2F.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstFVectorExpression CDPL.Math.Vector2F.__rmul__ ( float  t)
Parameters
t
Returns

◆ __setitem__()

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

◆ __iadd__() [1/2]

Vector2F CDPL.Math.Vector2F.__iadd__ ( Vector2F  v)

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

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

◆ __iadd__() [2/2]

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

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

Parameters
eSpecifies the second addend.
Returns
The updated Vector2F instance self.

◆ __isub__() [1/2]

Vector2F CDPL.Math.Vector2F.__isub__ ( Vector2F  v)

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

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

◆ __isub__() [2/2]

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

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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