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

Public Member Functions

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

Initializes a copy of the DMatrixSlice instance s.

Parameters
sThe DMatrixSlice instance to copy.

◆ __init__() [2/2]

None CDPL.Math.DMatrixSlice.__init__ ( DMatrixExpression  e,
ast.Slice  s1,
ast.Slice  s2 
)

Initializes the DMatrixSlice instance.

Parameters
e
s1
s2

Member Function Documentation

◆ getStart1()

int CDPL.Math.DMatrixSlice.getStart1 ( )
Returns

◆ getStart2()

int CDPL.Math.DMatrixSlice.getStart2 ( )
Returns

◆ getStride1()

int CDPL.Math.DMatrixSlice.getStride1 ( )
Returns

◆ getStride2()

int CDPL.Math.DMatrixSlice.getStride2 ( )
Returns

◆ getObjectID()

int CDPL.Math.DMatrixSlice.getObjectID ( )

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

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

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

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

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

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

DMatrixSlice CDPL.Math.DMatrixSlice.assign ( DMatrixSlice  s)

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

Parameters
sThe DMatrixSlice instance to copy.
Returns
self

◆ assign() [6/6]

None CDPL.Math.DMatrixSlice.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.DMatrixSlice.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.DMatrixSlice.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.DMatrixSlice.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.DMatrixSlice.toArray ( )
Returns

◆ swap()

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

◆ setElement()

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

◆ getData()

DMatrixExpression CDPL.Math.DMatrixSlice.getData ( )
Returns

◆ __call__()

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

◆ __getitem__()

float CDPL.Math.DMatrixSlice.__getitem__ ( tuple  ij)
Parameters
ij
Returns

◆ __len__()

int CDPL.Math.DMatrixSlice.__len__ ( )
Returns

◆ __eq__() [1/2]

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

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

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

◆ __eq__() [2/2]

bool CDPL.Math.DMatrixSlice.__eq__ ( ConstDMatrixExpression  e)

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

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

◆ __ne__() [1/2]

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

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

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

◆ __ne__() [2/2]

bool CDPL.Math.DMatrixSlice.__ne__ ( ConstDMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.DMatrixSlice.__str__ ( )

Returns a string representation of the DMatrixSlice instance.

Returns
The generated string representation.

◆ __pos__()

DMatrixSlice CDPL.Math.DMatrixSlice.__pos__ ( )
Returns

◆ __neg__()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__neg__ ( )
Returns

◆ __add__()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__add__ ( ConstDMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__sub__ ( ConstDMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__mul__ ( ConstDMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstDVectorExpression CDPL.Math.DMatrixSlice.__mul__ ( ConstDVectorExpression  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__()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstDMatrixExpression CDPL.Math.DMatrixSlice.__rmul__ ( float  t)
Parameters
t
Returns

◆ __setitem__()

None CDPL.Math.DMatrixSlice.__setitem__ ( tuple  ij,
float  v 
)
Parameters
ij
v

◆ __iadd__() [1/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__iadd__ ( DMatrixSlice  s)

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

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

◆ __iadd__() [2/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__iadd__ ( ConstDMatrixExpression  e)

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

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

◆ __isub__() [1/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__isub__ ( DMatrixSlice  s)

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

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

◆ __isub__() [2/2]

DMatrixSlice CDPL.Math.DMatrixSlice.__isub__ ( ConstDMatrixExpression  e)

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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