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

Public Member Functions

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

Initializes a copy of the LVectorSlice instance s.

Parameters
sThe LVectorSlice instance to copy.

◆ __init__() [2/2]

None CDPL.Math.LVectorSlice.__init__ ( LVectorExpression  e,
ast.Slice  s 
)

Initializes the LVectorSlice instance.

Parameters
e
s

Member Function Documentation

◆ getStart()

int CDPL.Math.LVectorSlice.getStart ( )
Returns

◆ getStride()

int CDPL.Math.LVectorSlice.getStride ( )
Returns

◆ getObjectID()

int CDPL.Math.LVectorSlice.getObjectID ( )

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

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

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

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

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

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

LVectorSlice CDPL.Math.LVectorSlice.assign ( LVectorSlice  s)

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

Parameters
sThe LVectorSlice instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize()

int CDPL.Math.LVectorSlice.getSize ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.LVectorSlice.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ getData()

LVectorExpression CDPL.Math.LVectorSlice.getData ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

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

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

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

◆ __ne__() [2/2]

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.LVectorSlice.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.LVectorSlice.__str__ ( )

Returns a string representation of the LVectorSlice instance.

Returns
The generated string representation.

◆ __pos__()

LVectorSlice CDPL.Math.LVectorSlice.__pos__ ( )
Returns

◆ __neg__()

ConstLVectorExpression CDPL.Math.LVectorSlice.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

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

◆ __rmul__()

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

◆ __setitem__()

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

◆ __iadd__() [1/2]

LVectorSlice CDPL.Math.LVectorSlice.__iadd__ ( LVectorSlice  s)

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

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

◆ __iadd__() [2/2]

LVectorSlice CDPL.Math.LVectorSlice.__iadd__ ( ConstLVectorExpression  e)

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

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

◆ __isub__() [1/2]

LVectorSlice CDPL.Math.LVectorSlice.__isub__ ( LVectorSlice  s)

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

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

◆ __isub__() [2/2]

LVectorSlice CDPL.Math.LVectorSlice.__isub__ ( ConstLVectorExpression  e)

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

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

◆ __imul__()

LVectorSlice CDPL.Math.LVectorSlice.__imul__ ( int  t)

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

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

◆ __idiv__()

LVectorSlice CDPL.Math.LVectorSlice.__idiv__ ( int  t)

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

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

◆ __itruediv__()

LVectorSlice CDPL.Math.LVectorSlice.__itruediv__ ( int  t)
Parameters
t
Returns