Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Math.LUnitVector Class Reference
+ Inheritance diagram for CDPL.Math.LUnitVector:

Public Member Functions

None __init__ ()
 Initializes the LUnitVector instance.
 
None __init__ (LUnitVector v)
 Initializes a copy of the LUnitVector instance v. More...
 
None __init__ (int n, int i)
 Initializes the LUnitVector instance. More...
 
None resize (int n)
 
int getIndex ()
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
bool isEmpty ()
 
int getSize ()
 
int getElement (int i)
 
object toArray ()
 
LUnitVector assign (LUnitVector v)
 Replaces the current state of self with a copy of the state of the LUnitVector instance v. More...
 
None swap (LUnitVector v)
 
bool __eq__ (LUnitVector v)
 Returns the result of the comparison operation self == v. More...
 
bool __eq__ (ConstLVectorExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (LUnitVector v)
 Returns the result of the comparison operation self != v. More...
 
bool __ne__ (ConstLVectorExpression e)
 Returns the result of the comparison operation self != e. More...
 
int __call__ (int i)
 
int __getitem__ (int i)
 
int __len__ ()
 
str __str__ ()
 Returns a string representation of the LUnitVector instance. More...
 
LUnitVector __pos__ ()
 
ConstLVectorExpression __neg__ ()
 
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)
 
ConstLVectorExpression __rmul__ (int t)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the LUnitVector instance v.

Parameters
vThe LUnitVector instance to copy.

◆ __init__() [2/2]

None CDPL.Math.LUnitVector.__init__ ( int  n,
int  i 
)

Initializes the LUnitVector instance.

Parameters
n
i

Member Function Documentation

◆ resize()

None CDPL.Math.LUnitVector.resize ( int  n)
Parameters
n

◆ getIndex()

int CDPL.Math.LUnitVector.getIndex ( )
Parameters
arg1
Returns

◆ getObjectID()

int CDPL.Math.LUnitVector.getObjectID ( )

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

Different Python LUnitVector 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 LUnitVector 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.

◆ isEmpty()

bool CDPL.Math.LUnitVector.isEmpty ( )
Returns

◆ getSize()

int CDPL.Math.LUnitVector.getSize ( )
Returns

◆ getElement()

int CDPL.Math.LUnitVector.getElement ( int  i)
Parameters
i
Returns

◆ toArray()

object CDPL.Math.LUnitVector.toArray ( )
Returns

◆ assign()

LUnitVector CDPL.Math.LUnitVector.assign ( LUnitVector  v)

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

Parameters
vThe LUnitVector instance to copy.
Returns
self

◆ swap()

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

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.LUnitVector.__eq__ ( ConstLVectorExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.LUnitVector.__ne__ ( ConstLVectorExpression  e)

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

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

◆ __call__()

int CDPL.Math.LUnitVector.__call__ ( int  i)
Parameters
i
Returns

◆ __getitem__()

int CDPL.Math.LUnitVector.__getitem__ ( int  i)
Parameters
i
Returns

◆ __len__()

int CDPL.Math.LUnitVector.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.LUnitVector.__str__ ( )

Returns a string representation of the LUnitVector instance.

Returns
The generated string representation.

◆ __pos__()

LUnitVector CDPL.Math.LUnitVector.__pos__ ( )
Returns

◆ __neg__()

ConstLVectorExpression CDPL.Math.LUnitVector.__neg__ ( )
Returns

◆ __add__()

ConstLVectorExpression CDPL.Math.LUnitVector.__add__ ( ConstLVectorExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstLVectorExpression CDPL.Math.LUnitVector.__sub__ ( ConstLVectorExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

ConstLVectorExpression CDPL.Math.LUnitVector.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/2]

ConstLVectorExpression CDPL.Math.LUnitVector.__mul__ ( ConstLMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstLVectorExpression CDPL.Math.LUnitVector.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstLVectorExpression CDPL.Math.LUnitVector.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

ConstLVectorExpression CDPL.Math.LUnitVector.__rmul__ ( int  t)
Parameters
t
Returns