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

Public Member Functions

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

Initializes a copy of the ULVectorSlice instance s.

Parameters
sThe ULVectorSlice instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ULVectorSlice.__init__ ( ULVectorExpression  e,
ast.Slice  s 
)

Initializes the ULVectorSlice instance.

Parameters
e
s

Member Function Documentation

◆ getStart()

int CDPL.Math.ULVectorSlice.getStart ( )
Returns

◆ getStride()

int CDPL.Math.ULVectorSlice.getStride ( )
Returns

◆ getObjectID()

int CDPL.Math.ULVectorSlice.getObjectID ( )

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

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

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

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

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

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

ULVectorSlice CDPL.Math.ULVectorSlice.assign ( ULVectorSlice  s)

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

Parameters
sThe ULVectorSlice instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize()

int CDPL.Math.ULVectorSlice.getSize ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.ULVectorSlice.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ getData()

ULVectorExpression CDPL.Math.ULVectorSlice.getData ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.ULVectorSlice.__eq__ ( ConstULVectorExpression  e)

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

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

◆ __ne__() [1/2]

bool CDPL.Math.ULVectorSlice.__ne__ ( ULVectorSlice  s)

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

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

◆ __ne__() [2/2]

bool CDPL.Math.ULVectorSlice.__ne__ ( ConstULVectorExpression  e)

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

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

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.ULVectorSlice.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.ULVectorSlice.__str__ ( )

Returns a string representation of the ULVectorSlice instance.

Returns
The generated string representation.

◆ __pos__()

ULVectorSlice CDPL.Math.ULVectorSlice.__pos__ ( )
Returns

◆ __neg__()

ConstULVectorExpression CDPL.Math.ULVectorSlice.__neg__ ( )
Returns

◆ __add__()

ConstULVectorExpression CDPL.Math.ULVectorSlice.__add__ ( ConstULVectorExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstULVectorExpression CDPL.Math.ULVectorSlice.__sub__ ( ConstULVectorExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

ConstULVectorExpression CDPL.Math.ULVectorSlice.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/2]

ConstULVectorExpression CDPL.Math.ULVectorSlice.__mul__ ( ConstULMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstULVectorExpression CDPL.Math.ULVectorSlice.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstULVectorExpression CDPL.Math.ULVectorSlice.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

ConstULVectorExpression CDPL.Math.ULVectorSlice.__rmul__ ( int  t)
Parameters
t
Returns

◆ __setitem__()

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

◆ __iadd__() [1/2]

ULVectorSlice CDPL.Math.ULVectorSlice.__iadd__ ( ULVectorSlice  s)

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

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

◆ __iadd__() [2/2]

ULVectorSlice CDPL.Math.ULVectorSlice.__iadd__ ( ConstULVectorExpression  e)

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

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

◆ __isub__() [1/2]

ULVectorSlice CDPL.Math.ULVectorSlice.__isub__ ( ULVectorSlice  s)

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

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

◆ __isub__() [2/2]

ULVectorSlice CDPL.Math.ULVectorSlice.__isub__ ( ConstULVectorExpression  e)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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