Represents the outcome of mathematical expressions/operations that result in a quaternion. More...

Inheritance diagram for CDPL.Math.ConstFQuaternionExpression:

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

float	getC1 ()
	Returns the real component C1. More...

float	getC2 ()
	Returns the imaginary component C2. More...

float	getC3 ()
	Returns the imaginary component C3. More...

float	getC4 ()
	Returns the imaginary component C4. More...

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

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

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

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

ConstFQuaternionExpression	__pos__ ()
	Returns self. More...

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

ConstFQuaternionExpression	__add__ (float t)
	Returns the result of the addition operation `self + t`. More...

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

ConstFQuaternionExpression	__radd__ (float t)
	Returns the result of the addition operation `t + self`. More...

ConstFQuaternionExpression	__sub__ (float t)
	Returns the result of the subtraction operation `self - t`. More...

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

ConstFQuaternionExpression	__rsub__ (float t)
	Returns the result of the subtraction operation `t - self`. More...

ConstFQuaternionExpression	__mul__ (float t)
	Returns the result of the multiplication operation `self * t`. More...

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

ConstFQuaternionExpression	__rmul__ (float t)
	Returns the result of the multiplication operation `t * self`. More...

ConstFQuaternionExpression	__div__ (float t)
	Returns the result of the division operation `self // t`. More...

ConstFQuaternionExpression	__div__ (ConstFQuaternionExpression e)
	Returns the result of the division operation `self // e`. More...

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

ConstFQuaternionExpression	__rdiv__ (float t)
	Returns the result of the division operation `t // self`. More...

Properties
	objectID = property(getObjectID)

Detailed Description

Represents the outcome of mathematical expressions/operations that result in a quaternion.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstFQuaternionExpression.getObjectID ( )

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

Different Python ConstFQuaternionExpression 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 ConstFQuaternionExpression 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.

◆ getC1()

float CDPL.Math.ConstFQuaternionExpression.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

float CDPL.Math.ConstFQuaternionExpression.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

float CDPL.Math.ConstFQuaternionExpression.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

float CDPL.Math.ConstFQuaternionExpression.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.ConstFQuaternionExpression.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ eq()

bool CDPL.Math.ConstFQuaternionExpression.__eq__ ( ConstFQuaternionExpression e )

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

Parameters

e	The `ConstFQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne()

bool CDPL.Math.ConstFQuaternionExpression.__ne__ ( ConstFQuaternionExpression e )

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

Parameters

e	The `ConstFQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.ConstFQuaternionExpression.__str__ ( )

Returns a string representation of the ConstFQuaternionExpression instance.

Returns: The generated string representation.

◆ pos()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add() [1/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__add__ ( float t )

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

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

◆ add() [2/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__add__ ( ConstFQuaternionExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ radd()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__radd__ ( float t )

Returns the result of the addition operation t + self.

Parameters

t	Specifies the first addend.

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

◆ sub() [1/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__sub__ ( float t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__sub__ ( ConstFQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__rsub__ ( float t )

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__mul__ ( ConstFQuaternionExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ rmul()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ div() [1/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__div__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ div() [2/2]

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__div__ ( ConstFQuaternionExpression e )

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

Parameters

e	Specifies the divisor.

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

◆ truediv()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ rdiv()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionExpression.__rdiv__ ( float t )

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

Parameters

t	Specifies the dividend.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ getObjectID()

◆ getC1()

◆ getC2()

◆ getC3()

◆ getC4()

◆ toArray()

◆ __eq__()

◆ __ne__()

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__() [1/2]

◆ __add__() [2/2]

◆ __radd__()

◆ __sub__() [1/2]

◆ __sub__() [2/2]

◆ __rsub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __rmul__()

◆ __div__() [1/2]

◆ __div__() [2/2]

◆ __truediv__()

◆ __rdiv__()

◆ eq()

◆ ne()

◆ str()

◆ pos()

◆ neg()

◆ add() [1/2]

◆ add() [2/2]

◆ radd()

◆ sub() [1/2]

◆ sub() [2/2]

◆ rsub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ rmul()

◆ div() [1/2]

◆ div() [2/2]

◆ truediv()

◆ rdiv()