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

Public Member Functions

None __init__ (ConstULMatrixSlice s)
 Initializes a copy of the ConstULMatrixSlice instance s. More...
 
None __init__ (ConstULMatrixExpression e, ast.Slice s1, ast.Slice s2)
 Initializes the ConstULMatrixSlice instance. More...
 
int getStart1 ()
 
int getStart2 ()
 
int getStride1 ()
 
int getStride2 ()
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getSize1 ()
 
int getSize2 ()
 
bool isEmpty ()
 
int getElement (int i, int j)
 
object toArray ()
 
ConstULMatrixExpression getData ()
 
int __call__ (int i, int j)
 
int __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (ConstULMatrixSlice 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__ (ConstULMatrixSlice 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 ConstULMatrixSlice instance. More...
 
ConstULMatrixSlice __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)
 

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.ConstULMatrixSlice.__init__ ( ConstULMatrixSlice  s)

Initializes a copy of the ConstULMatrixSlice instance s.

Parameters
sThe ConstULMatrixSlice instance to copy.

◆ __init__() [2/2]

None CDPL.Math.ConstULMatrixSlice.__init__ ( ConstULMatrixExpression  e,
ast.Slice  s1,
ast.Slice  s2 
)

Initializes the ConstULMatrixSlice instance.

Parameters
e
s1
s2

Member Function Documentation

◆ getStart1()

int CDPL.Math.ConstULMatrixSlice.getStart1 ( )
Returns

◆ getStart2()

int CDPL.Math.ConstULMatrixSlice.getStart2 ( )
Returns

◆ getStride1()

int CDPL.Math.ConstULMatrixSlice.getStride1 ( )
Returns

◆ getStride2()

int CDPL.Math.ConstULMatrixSlice.getStride2 ( )
Returns

◆ getObjectID()

int CDPL.Math.ConstULMatrixSlice.getObjectID ( )

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

Different Python ConstULMatrixSlice 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 ConstULMatrixSlice 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.

◆ getSize1()

int CDPL.Math.ConstULMatrixSlice.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.ConstULMatrixSlice.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.ConstULMatrixSlice.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.ConstULMatrixSlice.toArray ( )
Returns

◆ getData()

ConstULMatrixExpression CDPL.Math.ConstULMatrixSlice.getData ( )
Returns

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.ConstULMatrixSlice.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.ConstULMatrixSlice.__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.ConstULMatrixSlice.__str__ ( )

Returns a string representation of the ConstULMatrixSlice instance.

Returns
The generated string representation.

◆ __pos__()

ConstULMatrixSlice CDPL.Math.ConstULMatrixSlice.__pos__ ( )
Returns

◆ __neg__()

ConstULMatrixExpression CDPL.Math.ConstULMatrixSlice.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

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

◆ __rmul__()

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