Scaling matrix holding integer values of type long. More...

Inheritance diagram for CDPL.Math.LScalingMatrix:

Public Member Functions
None	__init__ (LScalingMatrix m)
	Constructs a copy of the scaling matrix m. More...

None	__init__ (int n, int sx=1, int sy=1, int sz=1)
	Constructs an N×N scaling matrix with the supplied per-axis scale factors. More...

None	set (int sx=1, int sy=1, int sz=1)
	Sets the per-axis scale factors. More...

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

int	getSize1 ()
	Returns the dimension N (the row count). More...

int	getSize2 ()
	Returns the dimension N (the column count). More...

bool	isEmpty ()
	Tells whether the matrix is empty (size zero). More...

int	getElement (int i, int j)
	Returns the scaling matrix element at (i, j). More...

object	toArray ()
	Converts the `LScalingMatrix` instance into a corresponding `numpy.ndarray` object. More...

LScalingMatrix	assign (LScalingMatrix m)
	Copy-assigns the dimension and the per-axis scale factors from m. More...

None	swap (LScalingMatrix m)
	Swaps the dimension and the per-axis scale factors with m. More...

int	__call__ (int i, int j)
	Returns the scaling matrix element at (i, j). More...

int	__getitem__ (tuple ij)
	Returns the scaling matrix element at (i, j). More...

int	__len__ ()
	Returns the number of rows. More...

bool	__eq__ (LScalingMatrix m)
	Returns the result of the comparison operation `self == m`. More...

bool	__eq__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation `self == e`. More...

bool	__ne__ (LScalingMatrix m)
	Returns the result of the comparison operation `self != m`. More...

bool	__ne__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation `self != e`. More...

str	__str__ ()
	Returns a string representation of the `LScalingMatrix` instance. More...

LScalingMatrix	__pos__ ()
	Returns self. More...

ConstLMatrixExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

ConstLMatrixExpression	__add__ (ConstLMatrixExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstLMatrixExpression	__sub__ (ConstLMatrixExpression e)
	Returns the result of the subtraction operation `self - e`. More...

ConstLMatrixExpression	__mul__ (int t)
	Returns the result of the multiplication operation `self * t`. More...

ConstLMatrixExpression	__mul__ (ConstLMatrixExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstLVectorExpression	__mul__ (ConstLVectorExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstLMatrixExpression	__div__ (int t)
	Returns the result of the division operation `self // t`. More...

ConstLMatrixExpression	__truediv__ (int t)
	Returns the result of the true division operation `self / t`. More...

ConstLMatrixExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

Properties
	objectID = property(getObjectID)

	size1 = property(getSize1)

	size2 = property(getSize2)

Detailed Description

Scaling matrix holding integer values of type long.

Constructor & Destructor Documentation

◆ init() [1/2]

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

Constructs a copy of the scaling matrix m.

Parameters

m	The scaling matrix to copy.

◆ init() [2/2]

None CDPL.Math.LScalingMatrix.__init__	(	int	n,
		int	sx = `1`,
		int	sy = `1`,
		int	sz = `1`
	)

Constructs an N×N scaling matrix with the supplied per-axis scale factors.

Parameters

n	The matrix dimension N.
sx	The x-axis scale factor.
sy	The y-axis scale factor.
sz	The z-axis scale factor.

Member Function Documentation

◆ set()

None CDPL.Math.LScalingMatrix.set	(	int	sx = `1`,
		int	sy = `1`,
		int	sz = `1`
	)

Sets the per-axis scale factors.

Parameters

sx	The x-axis scale factor.
sy	The y-axis scale factor.
sz	The z-axis scale factor.

◆ getObjectID()

int CDPL.Math.LScalingMatrix.getObjectID ( )

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

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

Returns the dimension N (the row count).

Returns: N.

◆ getSize2()

int CDPL.Math.LScalingMatrix.getSize2 ( )

Returns the dimension N (the column count).

Returns: N.

◆ isEmpty()

bool CDPL.Math.LScalingMatrix.isEmpty ( )

Tells whether the matrix is empty (size zero).

Returns: True if N is zero, and False otherwise.

◆ getElement()

int CDPL.Math.LScalingMatrix.getElement	(	int	i,
		int	j
	)

Returns the scaling matrix element at (i, j).

Parameters

i	The zero-based row index.
j	The zero-based column index.

Returns: The corresponding axis scaling factor on a diagonal position and 0 off the diagonal.

Exceptions

Base.IndexError if either index is out of range.

◆ toArray()

object CDPL.Math.LScalingMatrix.toArray ( )

Converts the LScalingMatrix instance into a corresponding numpy.ndarray object.

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ assign()

LScalingMatrix CDPL.Math.LScalingMatrix.assign ( LScalingMatrix m )

Copy-assigns the dimension and the per-axis scale factors from m.

Parameters

m	The source scaling matrix.

Returns: self.

◆ swap()

None CDPL.Math.LScalingMatrix.swap ( LScalingMatrix m )

Swaps the dimension and the per-axis scale factors with m.

Parameters

m	The scaling matrix to swap with.

◆ call()

int CDPL.Math.LScalingMatrix.__call__	(	int	i,
		int	j
	)

Returns the scaling matrix element at (i, j).

Parameters

i	The zero-based row index.
j	The zero-based column index.

Returns: The corresponding axis scaling factor on a diagonal position and 0 off the diagonal.

Exceptions

Base.IndexError if either index is out of range.

◆ getitem()

int CDPL.Math.LScalingMatrix.__getitem__ ( tuple ij )

Returns the scaling matrix element at (i, j).

Parameters

i	The zero-based row index.
j	The zero-based column index.

Returns: The corresponding axis scaling factor on a diagonal position and 0 off the diagonal.

Exceptions

Base.IndexError if either index is out of range.

◆ len()

int CDPL.Math.LScalingMatrix.__len__ ( )

Returns the number of rows.

Returns: The number of rows.

◆ eq() [1/2]

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

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

Parameters

m	The `LScalingMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.LScalingMatrix.__eq__ ( ConstLMatrixExpression e )

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

Parameters

e	The `ConstLMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

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

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

Parameters

m	The `LScalingMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.LScalingMatrix.__ne__ ( ConstLMatrixExpression e )

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

Parameters

e	The `ConstLMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.LScalingMatrix.__str__ ( )

Returns a string representation of the LScalingMatrix instance.

Returns: The generated string representation.

◆ pos()

LScalingMatrix CDPL.Math.LScalingMatrix.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__neg__ ( )

Returns the result of the operation self * -1.

Returns: A ConstLMatrixExpression instance holding the result of the element negation.

◆ add()

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__add__ ( ConstLMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns: A ConstLMatrixExpression instance holding the result of the addition.

◆ sub()

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__sub__ ( ConstLMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns: A LScalingMatrix instance holding the result of the subtraction.

◆ mul() [1/3]

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A ConstLMatrixExpression instance holding the result of the multiplication.

◆ mul() [2/3]

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__mul__ ( ConstLMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstLMatrixExpression instance holding the result of the multiplication.

◆ mul() [3/3]

ConstLVectorExpression CDPL.Math.LScalingMatrix.__mul__ ( ConstLVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstLVectorExpression instance holding the result of the multiplication.

◆ div()

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__div__ ( int t )

Returns the result of the division operation self // t.

Parameters

t	Specifies the divisor.

Returns: A ConstLMatrixExpression instance holding the result of the division.

◆ truediv()

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__truediv__ ( int t )

Returns the result of the true division operation self / t.

Parameters

t	Specifies the divisor.

Returns: A ConstLMatrixExpression instance holding the result of the division.

◆ rmul()

ConstLMatrixExpression CDPL.Math.LScalingMatrix.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstLMatrixExpression instance holding the result of the multiplication.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ set()

◆ getObjectID()

◆ getSize1()

◆ getSize2()

◆ isEmpty()

◆ getElement()

◆ toArray()

◆ assign()

◆ swap()

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/3]

◆ __mul__() [2/3]

◆ __mul__() [3/3]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ init() [1/2]

◆ init() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul() [1/3]

◆ mul() [2/3]

◆ mul() [3/3]

◆ div()

◆ truediv()

◆ rmul()