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

Vector expression that exposes a vector as its homogeneous-coordinate extension by appending an implicit 1 at the end. More...

+ Inheritance diagram for CDPL.Math.ConstLHomogenousCoordsAdapter:

Public Member Functions

None __init__ (ConstLHomogenousCoordsAdapter va)
 Contructs a copy of the ConstLHomogenousCoordsAdapter instance va. More...
 
None __init__ (ConstLVectorExpression v)
 Constructs the adapter wrapping v. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
bool isEmpty ()
 Tells whether the view is empty (always False). More...
 
int getSize ()
 Returns the dimensionality of the view (wrapped vector size + 1). More...
 
int getElement (int i)
 Returns the element at index i of the view. More...
 
object toArray ()
 Converts the ConstLHomogenousCoordsAdapter instance into a corresponding numpy.ndarray object. More...
 
ConstLVectorExpression getData ()
 Returns the wrapped vector. More...
 
bool __eq__ (ConstLHomogenousCoordsAdapter va)
 Returns the result of the comparison operation self == va. More...
 
bool __eq__ (ConstLVectorExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ConstLHomogenousCoordsAdapter va)
 Returns the result of the comparison operation self != va. 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 of the view. More...
 
int __getitem__ (int i)
 Returns the element at index i of the view. More...
 
int __len__ ()
 Returns the dimensionality of the view (wrapped vector size + 1). More...
 
str __str__ ()
 Returns a string representation of the ConstLHomogenousCoordsAdapter instance. More...
 
ConstLHomogenousCoordsAdapter __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...
 

Properties

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

Detailed Description

Vector expression that exposes a vector as its homogeneous-coordinate extension by appending an implicit 1 at the end.

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.ConstLHomogenousCoordsAdapter.__init__ ( ConstLHomogenousCoordsAdapter  va)

Contructs a copy of the ConstLHomogenousCoordsAdapter instance va.

Parameters
vaThe ConstLHomogenousCoordsAdapter instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ConstLHomogenousCoordsAdapter.__init__ ( ConstLVectorExpression  v)

Constructs the adapter wrapping v.

Parameters
vThe vector to be viewed as its homogeneous-coordinate extension.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstLHomogenousCoordsAdapter.getObjectID ( )

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

Different Python ConstLHomogenousCoordsAdapter 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 ConstLHomogenousCoordsAdapter 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.ConstLHomogenousCoordsAdapter.isEmpty ( )

Tells whether the view is empty (always False).

Returns
False.

◆ getSize()

int CDPL.Math.ConstLHomogenousCoordsAdapter.getSize ( )

Returns the dimensionality of the view (wrapped vector size + 1).

Returns
The view size.

◆ getElement()

int CDPL.Math.ConstLHomogenousCoordsAdapter.getElement ( int  i)

Returns the element at index i of the view.

Parameters
iThe zero-based index within the view.
Returns
The value of the element.

◆ toArray()

object CDPL.Math.ConstLHomogenousCoordsAdapter.toArray ( )

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

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

◆ getData()

ConstLVectorExpression CDPL.Math.ConstLHomogenousCoordsAdapter.getData ( )

Returns the wrapped vector.

Returns
The wrapped vector closure.

◆ __eq__() [1/2]

bool CDPL.Math.ConstLHomogenousCoordsAdapter.__eq__ ( ConstLHomogenousCoordsAdapter  va)

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

Parameters
vaThe ConstLHomogenousCoordsAdapter instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

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

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

Parameters
vaThe ConstLHomogenousCoordsAdapter instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

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

Returns the element at index i of the view.

At index getSize() - 1 the method returns the extension element (initialized to 1). At lower indices it returns the corresponding element of the wrapped vector.

Parameters
iThe zero-based index within the view.
Returns
The value of the element.

◆ __getitem__()

int CDPL.Math.ConstLHomogenousCoordsAdapter.__getitem__ ( int  i)

Returns the element at index i of the view.

Parameters
iThe zero-based index within the view.
Returns
The value of the element.

◆ __len__()

int CDPL.Math.ConstLHomogenousCoordsAdapter.__len__ ( )

Returns the dimensionality of the view (wrapped vector size + 1).

Returns
The view size.

◆ __str__()

str CDPL.Math.ConstLHomogenousCoordsAdapter.__str__ ( )

Returns a string representation of the ConstLHomogenousCoordsAdapter instance.

Returns
The generated string representation.

◆ __pos__()

ConstLHomogenousCoordsAdapter CDPL.Math.ConstLHomogenousCoordsAdapter.__pos__ ( )

Returns self.

Returns
self.

◆ __neg__()

ConstLVectorExpression CDPL.Math.ConstLHomogenousCoordsAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

ConstLVectorExpression CDPL.Math.ConstLHomogenousCoordsAdapter.__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.ConstLHomogenousCoordsAdapter.__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.ConstLHomogenousCoordsAdapter.__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.ConstLHomogenousCoordsAdapter.__truediv__ ( int  t)

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

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

◆ __rmul__()

ConstLVectorExpression CDPL.Math.ConstLHomogenousCoordsAdapter.__rmul__ ( int  t)

Returns the result of the multiplication operation t * self.

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