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

Public Member Functions

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

Properties

 objectID = property(getObjectID)
 
 size = property(getSize)
 
 data = property(getData)
 
 index = property(getIndex)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.LMatrixColumn.__init__ ( LMatrixColumn  mc)

Initializes a copy of the LMatrixColumn instance mc.

Parameters
mcThe LMatrixColumn instance to copy.

◆ __init__() [2/2]

None CDPL.Math.LMatrixColumn.__init__ ( LMatrixExpression  e,
int  i 
)

Initializes the LMatrixColumn instance.

Parameters
e
i

Member Function Documentation

◆ getIndex()

int CDPL.Math.LMatrixColumn.getIndex ( )
Returns

◆ getObjectID()

int CDPL.Math.LMatrixColumn.getObjectID ( )

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

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

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

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

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

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

LMatrixColumn CDPL.Math.LMatrixColumn.assign ( LMatrixColumn  c)

Replaces the current state of self with a copy of the state of the LMatrixColumn instance c.

Parameters
cThe LMatrixColumn instance to copy.
Returns
self

◆ assign() [6/6]

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

◆ getSize()

int CDPL.Math.LMatrixColumn.getSize ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.LMatrixColumn.toArray ( )
Returns

◆ swap()

None CDPL.Math.LMatrixColumn.swap ( LMatrixColumn  c)
Parameters
c

◆ setElement()

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

◆ getData()

LMatrixExpression CDPL.Math.LMatrixColumn.getData ( )
Returns

◆ __eq__() [1/2]

bool CDPL.Math.LMatrixColumn.__eq__ ( LMatrixColumn  c)

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

Parameters
cThe LMatrixColumn instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

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

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

Parameters
cThe LMatrixColumn instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.LMatrixColumn.__len__ ( )
Returns

◆ __str__()

str CDPL.Math.LMatrixColumn.__str__ ( )

Returns a string representation of the LMatrixColumn instance.

Returns
The generated string representation.

◆ __pos__()

LMatrixColumn CDPL.Math.LMatrixColumn.__pos__ ( )
Returns

◆ __neg__()

ConstLVectorExpression CDPL.Math.LMatrixColumn.__neg__ ( )
Returns

◆ __add__()

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

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/2]

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

◆ __rmul__()

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

◆ __setitem__()

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

◆ __iadd__() [1/2]

LMatrixColumn CDPL.Math.LMatrixColumn.__iadd__ ( LMatrixColumn  c)

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

Parameters
cSpecifies the second addend.
Returns
The updated LMatrixColumn instance self.

◆ __iadd__() [2/2]

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

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

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

◆ __isub__() [1/2]

LMatrixColumn CDPL.Math.LMatrixColumn.__isub__ ( LMatrixColumn  c)

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

Parameters
cSpecifies the subtrahend.
Returns
The updated LMatrixColumn instance self.

◆ __isub__() [2/2]

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

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

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

◆ __imul__()

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

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

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

◆ __idiv__()

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

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

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

◆ __itruediv__()

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