Translation matrix holding unsigned integer values of type unsigned long. More...

Inheritance diagram for CDPL.Math.ULTranslationMatrix:

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

None	__init__ (int n, int tx=0, int ty=0, int tz=0)
	Constructs an N×N translation matrix with the supplied per-axis translation components. More...

None	set (int tx=0, int ty=0, int tz=0)
	Sets the per-axis translation components. 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 translation matrix element at (i, j). More...

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

ULTranslationMatrix	assign (ULTranslationMatrix m)
	Copy-assigns the dimension and the translation components from m. More...

None	swap (ULTranslationMatrix m)
	Swaps the dimension and the translation components with m. More...

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

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

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

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

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

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

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

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

ULTranslationMatrix	__pos__ ()
	Returns self. More...

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

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

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

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

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

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

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

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

ConstULMatrixExpression	__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

Translation matrix holding unsigned integer values of type unsigned long.

Constructor & Destructor Documentation

◆ init() [1/2]

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

Constructs a copy of the translation matrix m.

Parameters

m	The translation matrix to copy.

◆ init() [2/2]

None CDPL.Math.ULTranslationMatrix.__init__	(	int	n,
		int	tx = `0`,
		int	ty = `0`,
		int	tz = `0`
	)

Constructs an N×N translation matrix with the supplied per-axis translation components.

Parameters

n	The matrix dimension N.
tx	The x-axis translation.
ty	The y-axis translation.
tz	The z-axis translation.

Member Function Documentation

◆ set()

None CDPL.Math.ULTranslationMatrix.set	(	int	tx = `0`,
		int	ty = `0`,
		int	tz = `0`
	)

Sets the per-axis translation components.

Parameters

tx	The x-axis translation.
ty	The y-axis translation.
tz	The z-axis translation.

◆ getObjectID()

int CDPL.Math.ULTranslationMatrix.getObjectID ( )

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

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

Returns the dimension N (the row count).

Returns: N.

◆ getSize2()

int CDPL.Math.ULTranslationMatrix.getSize2 ( )

Returns the dimension N (the column count).

Returns: N.

◆ isEmpty()

bool CDPL.Math.ULTranslationMatrix.isEmpty ( )

Tells whether the matrix is empty (size zero).

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

◆ getElement()

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

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

Parameters

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

Returns: 1 on the diagonal, the corresponding translation component in the last column (rows 0-2) and 0 elsewhere.

Exceptions

Base.IndexError if either index is out of range.

◆ toArray()

object CDPL.Math.ULTranslationMatrix.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ assign()

ULTranslationMatrix CDPL.Math.ULTranslationMatrix.assign ( ULTranslationMatrix m )

Copy-assigns the dimension and the translation components from m.

Parameters

m	The source translation matrix.

Returns: self.

◆ swap()

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

Swaps the dimension and the translation components with m.

Parameters

m	The translation matrix to swap with.

◆ call()

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

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

Parameters

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

Returns: 1 on the diagonal, the corresponding translation component in the last column (rows 0-2) and 0 elsewhere.

Exceptions

Base.IndexError if either index is out of range.

◆ getitem()

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

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

Parameters

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

Returns: 1 on the diagonal, the corresponding translation component in the last column (rows 0-2) and 0 elsewhere.

Exceptions

Base.IndexError if either index is out of range.

◆ len()

int CDPL.Math.ULTranslationMatrix.__len__ ( )

Returns the number of rows.

Returns: The number of rows.

◆ eq() [1/2]

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

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

Parameters

m	The `ULTranslationMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.ULTranslationMatrix.__eq__ ( ConstULMatrixExpression e )

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

Parameters

e	The `ConstULMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

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

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

Parameters

m	The `ULTranslationMatrix` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.ULTranslationMatrix.__ne__ ( ConstULMatrixExpression e )

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

Parameters

e	The `ConstULMatrixExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.ULTranslationMatrix.__str__ ( )

Returns a string representation of the ULTranslationMatrix instance.

Returns: The generated string representation.

◆ pos()

ULTranslationMatrix CDPL.Math.ULTranslationMatrix.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__add__ ( ConstULMatrixExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__sub__ ( ConstULMatrixExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/3]

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/3]

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__mul__ ( ConstULMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ mul() [3/3]

ConstULVectorExpression CDPL.Math.ULTranslationMatrix.__mul__ ( ConstULVectorExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstULMatrixExpression CDPL.Math.ULTranslationMatrix.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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