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

Public Member Functions

None __init__ (ULMatrixSlice s)
 Initializes a copy of the ULMatrixSlice instance s. More...
 
None __init__ (ULMatrixExpression e, ast.Slice s1, ast.Slice s2)
 Initializes the ULMatrixSlice instance. More...
 
int getStart1 ()
 
int getStart2 ()
 
int getStride1 ()
 
int getStride2 ()
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
ULMatrixSlice assign (ConstFMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e. More...
 
ULMatrixSlice assign (ConstDMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e. More...
 
ULMatrixSlice assign (ConstLMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e. More...
 
ULMatrixSlice assign (ConstULMatrixExpression e)
 Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e. More...
 
ULMatrixSlice assign (ULMatrixSlice s)
 Replaces the current state of self with a copy of the state of the ULMatrixSlice 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...
 
int getSize1 ()
 
int getSize2 ()
 
bool isEmpty ()
 
int getElement (int i, int j)
 
object toArray ()
 
None swap (ULMatrixSlice s)
 
None setElement (int i, int j, int v)
 
ULMatrixExpression getData ()
 
int __call__ (int i, int j)
 
int __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (ULMatrixSlice s)
 Returns the result of the comparison operation self == s. More...
 
bool __eq__ (ConstULMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (ULMatrixSlice s)
 Returns the result of the comparison operation self != s. More...
 
bool __ne__ (ConstULMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the ULMatrixSlice instance. More...
 
ULMatrixSlice __pos__ ()
 
ConstULMatrixExpression __neg__ ()
 
ConstULMatrixExpression __add__ (ConstULMatrixExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstULMatrixExpression __sub__ (ConstULMatrixExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstULMatrixExpression __mul__ (int t)
 Returns the result of the multiplication operation self * t. More...
 
ConstULMatrixExpression __mul__ (ConstULMatrixExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstULVectorExpression __mul__ (ConstULVectorExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstULMatrixExpression __div__ (int t)
 Returns the result of the division operation self / t. More...
 
ConstULMatrixExpression __truediv__ (int t)
 
ConstULMatrixExpression __rmul__ (int t)
 
None __setitem__ (tuple ij, int v)
 
ULMatrixSlice __iadd__ (ULMatrixSlice s)
 Performs the in-place addition operation self += s. More...
 
ULMatrixSlice __iadd__ (ConstULMatrixExpression e)
 Performs the in-place addition operation self += e. More...
 
ULMatrixSlice __isub__ (ULMatrixSlice s)
 Performs the in-place subtraction operation self -= s. More...
 
ULMatrixSlice __isub__ (ConstULMatrixExpression e)
 Performs the in-place subtraction operation self -= e. More...
 
ULMatrixSlice __imul__ (int t)
 Performs the in-place multiplication operation self *= t. More...
 
ULMatrixSlice __idiv__ (int t)
 Performs the in-place division operation self /= t. More...
 
ULMatrixSlice __itruediv__ (int t)
 

Properties

 objectID = property(getObjectID)
 
 size1 = property(getSize1)
 
 size2 = property(getSize2)
 
 data = property(getData)
 
 start1 = property(getStart1)
 
 start2 = property(getStart2)
 
 stride1 = property(getStride1)
 
 stride2 = property(getStride2)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Initializes a copy of the ULMatrixSlice instance s.

Parameters
sThe ULMatrixSlice instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ULMatrixSlice.__init__ ( ULMatrixExpression  e,
ast.Slice  s1,
ast.Slice  s2 
)

Initializes the ULMatrixSlice instance.

Parameters
e
s1
s2

Member Function Documentation

◆ getStart1()

int CDPL.Math.ULMatrixSlice.getStart1 ( )
Returns

◆ getStart2()

int CDPL.Math.ULMatrixSlice.getStart2 ( )
Returns

◆ getStride1()

int CDPL.Math.ULMatrixSlice.getStride1 ( )
Returns

◆ getStride2()

int CDPL.Math.ULMatrixSlice.getStride2 ( )
Returns

◆ getObjectID()

int CDPL.Math.ULMatrixSlice.getObjectID ( )

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

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

ULMatrixSlice CDPL.Math.ULMatrixSlice.assign ( ConstFMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstFMatrixExpression instance e.

Parameters
eThe ConstFMatrixExpression instance to copy.
Returns
self

◆ assign() [2/6]

ULMatrixSlice CDPL.Math.ULMatrixSlice.assign ( ConstDMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstDMatrixExpression instance e.

Parameters
eThe ConstDMatrixExpression instance to copy.
Returns
self

◆ assign() [3/6]

ULMatrixSlice CDPL.Math.ULMatrixSlice.assign ( ConstLMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstLMatrixExpression instance e.

Parameters
eThe ConstLMatrixExpression instance to copy.
Returns
self

◆ assign() [4/6]

ULMatrixSlice CDPL.Math.ULMatrixSlice.assign ( ConstULMatrixExpression  e)

Replaces the current state of self with a copy of the state of the ConstULMatrixExpression instance e.

Parameters
eThe ConstULMatrixExpression instance to copy.
Returns
self

◆ assign() [5/6]

ULMatrixSlice CDPL.Math.ULMatrixSlice.assign ( ULMatrixSlice  s)

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

Parameters
sThe ULMatrixSlice instance to copy.
Returns
self

◆ assign() [6/6]

None CDPL.Math.ULMatrixSlice.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

◆ getSize1()

int CDPL.Math.ULMatrixSlice.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.ULMatrixSlice.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.ULMatrixSlice.isEmpty ( )
Returns

◆ getElement()

int CDPL.Math.ULMatrixSlice.getElement ( int  i,
int  j 
)
Parameters
i
j
Returns

◆ toArray()

object CDPL.Math.ULMatrixSlice.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ getData()

ULMatrixExpression CDPL.Math.ULMatrixSlice.getData ( )
Returns

◆ __call__()

int CDPL.Math.ULMatrixSlice.__call__ ( int  i,
int  j 
)
Parameters
i
j
Returns

◆ __getitem__()

int CDPL.Math.ULMatrixSlice.__getitem__ ( tuple  ij)
Parameters
ij
Returns

◆ __len__()

int CDPL.Math.ULMatrixSlice.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.ULMatrixSlice.__eq__ ( ConstULMatrixExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.ULMatrixSlice.__ne__ ( ConstULMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.ULMatrixSlice.__str__ ( )

Returns a string representation of the ULMatrixSlice instance.

Returns
The generated string representation.

◆ __pos__()

ULMatrixSlice CDPL.Math.ULMatrixSlice.__pos__ ( )
Returns

◆ __neg__()

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__neg__ ( )
Returns

◆ __add__()

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__add__ ( ConstULMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__sub__ ( ConstULMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__mul__ ( int  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__mul__ ( ConstULMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstULVectorExpression CDPL.Math.ULMatrixSlice.__mul__ ( ConstULVectorExpression  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__()

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__div__ ( int  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__truediv__ ( int  t)
Parameters
t
Returns

◆ __rmul__()

ConstULMatrixExpression CDPL.Math.ULMatrixSlice.__rmul__ ( int  t)
Parameters
t
Returns

◆ __setitem__()

None CDPL.Math.ULMatrixSlice.__setitem__ ( tuple  ij,
int  v 
)
Parameters
ij
v

◆ __iadd__() [1/2]

ULMatrixSlice CDPL.Math.ULMatrixSlice.__iadd__ ( ULMatrixSlice  s)

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

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

◆ __iadd__() [2/2]

ULMatrixSlice CDPL.Math.ULMatrixSlice.__iadd__ ( ConstULMatrixExpression  e)

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

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

◆ __isub__() [1/2]

ULMatrixSlice CDPL.Math.ULMatrixSlice.__isub__ ( ULMatrixSlice  s)

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

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

◆ __isub__() [2/2]

ULMatrixSlice CDPL.Math.ULMatrixSlice.__isub__ ( ConstULMatrixExpression  e)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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