General 4-component quaternion with component values of type float. More...

Inheritance diagram for CDPL.Math.FQuaternion:

Public Member Functions
None	__init__ ()
	Constructs an uninitialized quaternion.

None	__init__ (FQuaternion q)
	Constructs a copy of the quaternion q. More...

None	__init__ (float c1, float c2=0.0, float c3=0.0, float c4=0.0)
	Constructs the quaternion with the supplied component values. More...

None	__init__ (ConstFQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (ConstDQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (ConstLQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (ConstULQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (object a)
	Constructs the quaternion from the `numpy.ndarray` object a. More...

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

FQuaternion	assign (ConstFQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

FQuaternion	assign (ConstDQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

FQuaternion	assign (ConstLQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

FQuaternion	assign (ConstULQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

FQuaternion	assign (FQuaternion q)
	Copy-assigns the components of q to this quaternion. More...

None	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this quaternion. 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 `FQuaternion` instance into a corresponding `numpy.ndarray` object. More...

None	swap (FQuaternion q)
	Swaps the four components of this quaternion with those of q. More...

None	setC1 (float v)
	Sets the value of the real component C1 to v. More...

None	setC2 (float v)
	Sets the value of the imaginary component C2 to v. More...

None	setC3 (float v)
	Sets the value of the imaginary component C3 to v. More...

None	setC4 (float v)
	Sets the value of the imaginary component C4 to v. More...

None	set (float c1=0.0, float c2=0.0, float c3=0.0, float c4=0.0)
	Sets the four quaternion components to the supplied values. More...

bool	__eq__ (FQuaternion q)
	Returns the result of the comparison operation `self == q`. More...

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

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

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

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

FQuaternion	__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...

FQuaternion	__iadd__ (float t)
	Adds the scalar t to the real component. More...

FQuaternion	__iadd__ (FQuaternion q)
	Adds the quaternion q to this quaternion (via a temporary to handle aliasing). More...

FQuaternion	__iadd__ (ConstFQuaternionExpression e)
	Adds the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

FQuaternion	__isub__ (float t)
	Subtracts the scalar t from the real component. More...

FQuaternion	__isub__ (FQuaternion q)
	Subtracts the quaternion q from this quaternion (via a temporary to handle aliasing). More...

FQuaternion	__isub__ (ConstFQuaternionExpression e)
	Subtracts the quaternion expression e from this quaternion (via a temporary to handle aliasing). More...

FQuaternion	__imul__ (float t)
	Multiplies every component by the scalar t. More...

FQuaternion	__imul__ (FQuaternion q)
	Right-multiplies this quaternion by the quaternion q (Hamilton product, via a temporary). More...

FQuaternion	__imul__ (ConstFQuaternionExpression e)
	Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary). More...

FQuaternion	__idiv__ (float t)
	Divides every component by the scalar t. More...

FQuaternion	__idiv__ (FQuaternion q)
	Right-divides this quaternion by the quaternion q (Hamilton-product inverse, via a temporary). More...

FQuaternion	__idiv__ (ConstFQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...

FQuaternion	__itruediv__ (float t)
	Divides every component by the scalar t. More...

FQuaternion	__itruediv__ (FQuaternion q)
	Right-divides this quaternion by the quaternion q (Hamilton-product inverse, via a temporary). More...

FQuaternion	__itruediv__ (ConstFQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...

Properties
	objectID = property(getObjectID)

Detailed Description

General 4-component quaternion with component values of type float.

Constructor & Destructor Documentation

◆ init() [1/7]

None CDPL.Math.FQuaternion.__init__ ( FQuaternion q )

Constructs a copy of the quaternion q.

Parameters

q	The quaternion to copy.

◆ init() [2/7]

None CDPL.Math.FQuaternion.__init__	(	float	c1,
		float	c2 = `0.0`,
		float	c3 = `0.0`,
		float	c4 = `0.0`
	)

Constructs the quaternion with the supplied component values.

Parameters

c1	The real component.
c2	The first imaginary component.
c3	The second imaginary component.
c4	The third imaginary component.

◆ init() [3/7]

None CDPL.Math.FQuaternion.__init__ ( ConstFQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [4/7]

None CDPL.Math.FQuaternion.__init__ ( ConstDQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [5/7]

None CDPL.Math.FQuaternion.__init__ ( ConstLQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [6/7]

None CDPL.Math.FQuaternion.__init__ ( ConstULQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [7/7]

None CDPL.Math.FQuaternion.__init__ ( object a )

Constructs the quaternion from the numpy.ndarray object a.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

Member Function Documentation

◆ getObjectID()

int CDPL.Math.FQuaternion.getObjectID ( )

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

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

◆ assign() [1/6]

FQuaternion CDPL.Math.FQuaternion.assign ( ConstFQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [2/6]

FQuaternion CDPL.Math.FQuaternion.assign ( ConstDQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [3/6]

FQuaternion CDPL.Math.FQuaternion.assign ( ConstLQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [4/6]

FQuaternion CDPL.Math.FQuaternion.assign ( ConstULQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [5/6]

FQuaternion CDPL.Math.FQuaternion.assign ( FQuaternion q )

Copy-assigns the components of q to this quaternion.

Parameters

q	The source quaternion.

Returns: self.

◆ assign() [6/6]

None CDPL.Math.FQuaternion.assign ( object a )

Assigns the contents of the numpy.ndarray object a to this quaternion.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ getC1()

float CDPL.Math.FQuaternion.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

float CDPL.Math.FQuaternion.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

float CDPL.Math.FQuaternion.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

float CDPL.Math.FQuaternion.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.FQuaternion.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.FQuaternion.swap ( FQuaternion q )

Swaps the four components of this quaternion with those of q.

Parameters

q	The quaternion to swap with.

◆ setC1()

None CDPL.Math.FQuaternion.setC1 ( float v )

Sets the value of the real component C1 to v.

Parameters

v	The new value of the real component C1.

◆ setC2()

None CDPL.Math.FQuaternion.setC2 ( float v )

Sets the value of the imaginary component C2 to v.

Parameters

v	The new value of the imaginary component C2.

◆ setC3()

None CDPL.Math.FQuaternion.setC3 ( float v )

Sets the value of the imaginary component C3 to v.

Parameters

v	The new value of the imaginary component C3.

◆ setC4()

None CDPL.Math.FQuaternion.setC4 ( float v )

Sets the value of the imaginary component C4 to v.

Parameters

v	The new value of the imaginary component C4.

◆ set()

None CDPL.Math.FQuaternion.set	(	float	c1 = `0.0`,
		float	c2 = `0.0`,
		float	c3 = `0.0`,
		float	c4 = `0.0`
	)

Sets the four quaternion components to the supplied values.

Parameters

c1	The new real component.
c2	The new first imaginary component.
c3	The new second imaginary component.
c4	The new third imaginary component.

◆ eq() [1/2]

bool CDPL.Math.FQuaternion.__eq__ ( FQuaternion q )

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

Parameters

q	The `FQuaternion` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.FQuaternion.__eq__ ( ConstFQuaternionExpression q )

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

Parameters

q	The `ConstFQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.FQuaternion.__ne__ ( FQuaternion q )

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

Parameters

q	The `FQuaternion` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.FQuaternion.__ne__ ( ConstFQuaternionExpression q )

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

Parameters

q	The `ConstFQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.FQuaternion.__str__ ( )

Returns a string representation of the FQuaternion instance.

Returns: The generated string representation.

◆ pos()

FQuaternion CDPL.Math.FQuaternion.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFQuaternionExpression CDPL.Math.FQuaternion.__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.FQuaternion.__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.FQuaternion.__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.FQuaternion.__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.FQuaternion.__sub__ ( float t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

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

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__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.FQuaternion.__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.FQuaternion.__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.FQuaternion.__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.FQuaternion.__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.FQuaternion.__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.FQuaternion.__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.

◆ iadd() [1/3]

FQuaternion CDPL.Math.FQuaternion.__iadd__ ( float t )

Adds the scalar t to the real component.

Parameters

t	The scalar addend.

Returns: self.

◆ iadd() [2/3]

FQuaternion CDPL.Math.FQuaternion.__iadd__ ( FQuaternion q )

Adds the quaternion q to this quaternion (via a temporary to handle aliasing).

Parameters

q	The source quaternion.

Returns: self.

◆ iadd() [3/3]

FQuaternion CDPL.Math.FQuaternion.__iadd__ ( ConstFQuaternionExpression e )

Adds the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ isub() [1/3]

FQuaternion CDPL.Math.FQuaternion.__isub__ ( float t )

Subtracts the scalar t from the real component.

Parameters

t	The scalar subtrahend.

Returns: self.

◆ isub() [2/3]

FQuaternion CDPL.Math.FQuaternion.__isub__ ( FQuaternion q )

Subtracts the quaternion q from this quaternion (via a temporary to handle aliasing).

Parameters

q	The source quaternion.

Returns: self.

◆ isub() [3/3]

FQuaternion CDPL.Math.FQuaternion.__isub__ ( ConstFQuaternionExpression e )

Subtracts the quaternion expression e from this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ imul() [1/3]

FQuaternion CDPL.Math.FQuaternion.__imul__ ( float t )

Multiplies every component by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ imul() [2/3]

FQuaternion CDPL.Math.FQuaternion.__imul__ ( FQuaternion q )

Right-multiplies this quaternion by the quaternion q (Hamilton product, via a temporary).

Parameters

q	The right-hand quaternion.

Returns: self.

◆ imul() [3/3]

FQuaternion CDPL.Math.FQuaternion.__imul__ ( ConstFQuaternionExpression e )

Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns: self.

◆ idiv() [1/3]

FQuaternion CDPL.Math.FQuaternion.__idiv__ ( float t )

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ idiv() [2/3]

FQuaternion CDPL.Math.FQuaternion.__idiv__ ( FQuaternion q )

Right-divides this quaternion by the quaternion q (Hamilton-product inverse, via a temporary).

Parameters

q	The right-hand quaternion.

Returns: self.

◆ idiv() [3/3]

FQuaternion CDPL.Math.FQuaternion.__idiv__ ( ConstFQuaternionExpression e )

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns: self.

◆ itruediv() [1/3]

FQuaternion CDPL.Math.FQuaternion.__itruediv__ ( float t )

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv() [2/3]

FQuaternion CDPL.Math.FQuaternion.__itruediv__ ( FQuaternion q )

Right-divides this quaternion by the quaternion q (Hamilton-product inverse, via a temporary).

Parameters

q	The right-hand quaternion.

Returns: self.

◆ itruediv() [3/3]

FQuaternion CDPL.Math.FQuaternion.__itruediv__ ( ConstFQuaternionExpression e )

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/7]

◆ __init__() [2/7]

◆ __init__() [3/7]

◆ __init__() [4/7]

◆ __init__() [5/7]

◆ __init__() [6/7]

◆ __init__() [7/7]

Member Function Documentation

◆ getObjectID()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ getC1()

◆ getC2()

◆ getC3()

◆ getC4()

◆ toArray()

◆ swap()

◆ setC1()

◆ setC2()

◆ setC3()

◆ setC4()

◆ set()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __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__()

◆ __iadd__() [1/3]

◆ __iadd__() [2/3]

◆ __iadd__() [3/3]

◆ __isub__() [1/3]

◆ __isub__() [2/3]

◆ __isub__() [3/3]

◆ __imul__() [1/3]

◆ __imul__() [2/3]

◆ __imul__() [3/3]

◆ __idiv__() [1/3]

◆ __idiv__() [2/3]

◆ __idiv__() [3/3]

◆ __itruediv__() [1/3]

◆ __itruediv__() [2/3]

◆ __itruediv__() [3/3]

◆ init() [1/7]

◆ init() [2/7]

◆ init() [3/7]

◆ init() [4/7]

◆ init() [5/7]

◆ init() [6/7]

◆ init() [7/7]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ 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()

◆ iadd() [1/3]

◆ iadd() [2/3]

◆ iadd() [3/3]

◆ isub() [1/3]

◆ isub() [2/3]

◆ isub() [3/3]

◆ imul() [1/3]

◆ imul() [2/3]

◆ imul() [3/3]

◆ idiv() [1/3]

◆ idiv() [2/3]

◆ idiv() [3/3]

◆ itruediv() [1/3]

◆ itruediv() [2/3]

◆ itruediv() [3/3]