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

Public Member Functions

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

Properties

 objectID = property(getObjectID)
 
 size = property(getSize)
 
 data = property(getData)
 
 start = property(getStart)
 
 stride = property(getStride)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.DVectorSlice.__init__ ( DVectorSlice  s)

Initializes a copy of the DVectorSlice instance s.

Parameters
sThe DVectorSlice instance to copy.

◆ __init__() [2/2]

None CDPL.Math.DVectorSlice.__init__ ( DVectorExpression  e,
ast.Slice  s 
)

Initializes the DVectorSlice instance.

Parameters
e
s

Member Function Documentation

◆ getStart()

int CDPL.Math.DVectorSlice.getStart ( )
Returns

◆ getStride()

int CDPL.Math.DVectorSlice.getStride ( )
Returns

◆ getObjectID()

int CDPL.Math.DVectorSlice.getObjectID ( )

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

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

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

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

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

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

DVectorSlice CDPL.Math.DVectorSlice.assign ( DVectorSlice  s)

Replaces the current state of self with a copy of the state of the DVectorSlice instance s.

Parameters
sThe DVectorSlice instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize()

int CDPL.Math.DVectorSlice.getSize ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.DVectorSlice.toArray ( )
Returns

◆ swap()

None CDPL.Math.DVectorSlice.swap ( DVectorSlice  s)
Parameters
s

◆ setElement()

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

◆ getData()

DVectorExpression CDPL.Math.DVectorSlice.getData ( )
Returns

◆ __eq__() [1/2]

bool CDPL.Math.DVectorSlice.__eq__ ( DVectorSlice  s)

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

Parameters
sThe DVectorSlice instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

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

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

Parameters
sThe DVectorSlice instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.DVectorSlice.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.DVectorSlice.__str__ ( )

Returns a string representation of the DVectorSlice instance.

Returns
The generated string representation.

◆ __pos__()

DVectorSlice CDPL.Math.DVectorSlice.__pos__ ( )
Returns

◆ __neg__()

ConstDVectorExpression CDPL.Math.DVectorSlice.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

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

◆ __rmul__()

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

◆ __setitem__()

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

◆ __iadd__() [1/2]

DVectorSlice CDPL.Math.DVectorSlice.__iadd__ ( DVectorSlice  s)

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

Parameters
sSpecifies the second addend.
Returns
The updated DVectorSlice instance self.

◆ __iadd__() [2/2]

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

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

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

◆ __isub__() [1/2]

DVectorSlice CDPL.Math.DVectorSlice.__isub__ ( DVectorSlice  s)

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

Parameters
sSpecifies the subtrahend.
Returns
The updated DVectorSlice instance self.

◆ __isub__() [2/2]

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

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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