Scaling matrix holding floating-point values of type float. More...

Inheritance diagram for CDPL.Math.FScalingMatrix:

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

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

None	set (float sx=1.0, float sy=1.0, float sz=1.0)
	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...

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

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

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

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

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

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

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

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__ ()
	Returns self. More...

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

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)
	Returns the result of the true division operation `self / t`. More...

ConstFMatrixExpression	__rmul__ (float 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 floating-point values of type float.

Constructor & Destructor Documentation

◆ init() [1/2]

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

Constructs a copy of the scaling matrix m.

Parameters

m	The scaling matrix to copy.

◆ init() [2/2]

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

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.FScalingMatrix.set	(	float	sx = `1.0`,
		float	sy = `1.0`,
		float	sz = `1.0`
	)

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.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 the dimension N (the row count).

Returns: N.

◆ getSize2()

int CDPL.Math.FScalingMatrix.getSize2 ( )

Returns the dimension N (the column count).

Returns: N.

◆ isEmpty()

bool CDPL.Math.FScalingMatrix.isEmpty ( )

Tells whether the matrix is empty (size zero).

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

◆ getElement()

float CDPL.Math.FScalingMatrix.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.FScalingMatrix.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ assign()

FScalingMatrix CDPL.Math.FScalingMatrix.assign ( FScalingMatrix 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.FScalingMatrix.swap ( FScalingMatrix m )

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

Parameters

m	The scaling matrix to swap with.

◆ call()

float CDPL.Math.FScalingMatrix.__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()

float CDPL.Math.FScalingMatrix.__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.FScalingMatrix.__len__ ( )

Returns the number of rows.

Returns: The number of rows.

◆ eq() [1/2]

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

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

Parameters

m	The `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

e	The `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

m	The `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

e	The `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 self.

Returns: self.

◆ neg()

ConstFMatrixExpression CDPL.Math.FScalingMatrix.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the addition operation self + e.

Parameters

e	Specifies 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

e	Specifies 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

t	Specifies 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

e	Specifies 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

e	Specifies 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

t	Specifies the divisor.

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

◆ truediv()

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

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

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

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstFMatrixExpression 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()