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

Public Member Functions

None __init__ (FScalingMatrix m)
 Initializes a copy of the FScalingMatrix instance m. More...
 
None __init__ (int n, float sx=1.0, float sy=1.0, float sz=1.0)
 Initializes the FScalingMatrix instance. More...
 
None set (float sx=1.0, float sy=1.0, float sz=1.0)
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getSize1 ()
 
int getSize2 ()
 
bool isEmpty ()
 
float getElement (int i, int j)
 
object toArray ()
 
FScalingMatrix assign (FScalingMatrix m)
 Replaces the current state of self with a copy of the state of the FScalingMatrix instance m. More...
 
None swap (FScalingMatrix m)
 
float __call__ (int i, int j)
 
float __getitem__ (tuple ij)
 
int __len__ ()
 
bool __eq__ (FScalingMatrix m)
 Returns the result of the comparison operation self == m. More...
 
bool __eq__ (ConstFMatrixExpression e)
 Returns the result of the comparison operation self == e. More...
 
bool __ne__ (FScalingMatrix m)
 Returns the result of the comparison operation self != m. More...
 
bool __ne__ (ConstFMatrixExpression e)
 Returns the result of the comparison operation self != e. More...
 
str __str__ ()
 Returns a string representation of the FScalingMatrix instance. More...
 
FScalingMatrix __pos__ ()
 
ConstFMatrixExpression __neg__ ()
 
ConstFMatrixExpression __add__ (ConstFMatrixExpression e)
 Returns the result of the addition operation self + e. More...
 
ConstFMatrixExpression __sub__ (ConstFMatrixExpression e)
 Returns the result of the subtraction operation self - e. More...
 
ConstFMatrixExpression __mul__ (float t)
 Returns the result of the multiplication operation self * t. More...
 
ConstFMatrixExpression __mul__ (ConstFMatrixExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstFVectorExpression __mul__ (ConstFVectorExpression e)
 Returns the result of the multiplication operation self * e. More...
 
ConstFMatrixExpression __div__ (float t)
 Returns the result of the division operation self / t. More...
 
ConstFMatrixExpression __truediv__ (float t)
 
ConstFMatrixExpression __rmul__ (float t)
 

Properties

 objectID = property(getObjectID)
 
 size1 = property(getSize1)
 
 size2 = property(getSize2)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Math.FScalingMatrix.__init__ ( FScalingMatrix  m)

Initializes a copy of the FScalingMatrix instance m.

Parameters
mThe FScalingMatrix instance to copy.

◆ __init__() [2/2]

None CDPL.Math.FScalingMatrix.__init__ ( int  n,
float   sx = 1.0,
float   sy = 1.0,
float   sz = 1.0 
)

Initializes the FScalingMatrix instance.

Parameters
n
sx
sy
sz

Member Function Documentation

◆ set()

None CDPL.Math.FScalingMatrix.set ( float   sx = 1.0,
float   sy = 1.0,
float   sz = 1.0 
)
Parameters
sx
sy
sz

◆ getObjectID()

int CDPL.Math.FScalingMatrix.getObjectID ( )

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

Different Python FScalingMatrix 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 FScalingMatrix 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.FScalingMatrix.getSize1 ( )
Returns

◆ getSize2()

int CDPL.Math.FScalingMatrix.getSize2 ( )
Returns

◆ isEmpty()

bool CDPL.Math.FScalingMatrix.isEmpty ( )
Returns

◆ getElement()

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

◆ toArray()

object CDPL.Math.FScalingMatrix.toArray ( )
Returns

◆ assign()

FScalingMatrix CDPL.Math.FScalingMatrix.assign ( FScalingMatrix  m)

Replaces the current state of self with a copy of the state of the FScalingMatrix instance m.

Parameters
mThe FScalingMatrix instance to copy.
Returns
self

◆ swap()

None CDPL.Math.FScalingMatrix.swap ( FScalingMatrix  m)
Parameters
m

◆ __call__()

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

◆ __getitem__()

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

◆ __len__()

int CDPL.Math.FScalingMatrix.__len__ ( )
Returns

◆ __eq__() [1/2]

bool CDPL.Math.FScalingMatrix.__eq__ ( FScalingMatrix  m)

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

Parameters
mThe FScalingMatrix instance to be compared with.
Returns
The result of the comparison operation.

◆ __eq__() [2/2]

bool CDPL.Math.FScalingMatrix.__eq__ ( ConstFMatrixExpression  e)

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

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

◆ __ne__() [1/2]

bool CDPL.Math.FScalingMatrix.__ne__ ( FScalingMatrix  m)

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

Parameters
mThe FScalingMatrix instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__() [2/2]

bool CDPL.Math.FScalingMatrix.__ne__ ( ConstFMatrixExpression  e)

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

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

◆ __str__()

str CDPL.Math.FScalingMatrix.__str__ ( )

Returns a string representation of the FScalingMatrix instance.

Returns
The generated string representation.

◆ __pos__()

FScalingMatrix CDPL.Math.FScalingMatrix.__pos__ ( )
Returns

◆ __neg__()

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__neg__ ( )
Returns

◆ __add__()

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__add__ ( ConstFMatrixExpression  e)

Returns the result of the addition operation self + e.

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

◆ __sub__()

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__sub__ ( ConstFMatrixExpression  e)

Returns the result of the subtraction operation self - e.

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

◆ __mul__() [1/3]

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__mul__ ( float  t)

Returns the result of the multiplication operation self * t.

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

◆ __mul__() [2/3]

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__mul__ ( ConstFMatrixExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __mul__() [3/3]

ConstFVectorExpression CDPL.Math.FScalingMatrix.__mul__ ( ConstFVectorExpression  e)

Returns the result of the multiplication operation self * e.

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

◆ __div__()

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__div__ ( float  t)

Returns the result of the division operation self / t.

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

◆ __truediv__()

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__truediv__ ( float  t)
Parameters
t
Returns

◆ __rmul__()

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__rmul__ ( float  t)
Parameters
t
Returns