Quaternion expression that exposes a 4-element vector as a quaternion (component indices 0-3 map to C1-C4). More...

Inheritance diagram for CDPL.Math.FVectorQuaternionAdapter:

Public Member Functions
None	__init__ (FVectorQuaternionAdapter va)
	Contructs a copy of the `FVectorQuaternionAdapter` instance va. More...

None	__init__ (FVectorExpression v)
	Constructs the adapter wrapping the 4-element vector v. More...

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

FVectorQuaternionAdapter	assign (ConstFQuaternionExpression e)
	Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...

FVectorQuaternionAdapter	assign (ConstDQuaternionExpression e)
	Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...

FVectorQuaternionAdapter	assign (ConstLQuaternionExpression e)
	Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...

FVectorQuaternionAdapter	assign (ConstULQuaternionExpression e)
	Assigns the quaternion expression e to this view (writing through to the wrapped vector). More...

None	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this view. More...

FVectorQuaternionAdapter	assign (FVectorQuaternionAdapter va)
	Copies the components of va into this view (writing through to the wrapped vector). 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 `FVectorQuaternionAdapter` instance into a corresponding `numpy.ndarray` object. More...

None	swap (FVectorQuaternionAdapter va)
	Swaps the components of this view with those of va. 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)
	Assigns the four supplied component values to this view (writing through to the wrapped vector). More...

FVectorExpression	getData ()
	Returns the wrapped vector. More...

bool	__eq__ (FVectorQuaternionAdapter va)
	Returns the result of the comparison operation `self == va`. More...

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

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

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

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

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

FVectorQuaternionAdapter	__iadd__ (float t)
	Adds the scalar t to component C1 of this view. More...

FVectorQuaternionAdapter	__iadd__ (FVectorQuaternionAdapter va)
	Adds the vector adapter va componentwise to this view. More...

FVectorQuaternionAdapter	__iadd__ (ConstFQuaternionExpression e)
	Adds the quaternion expression e componentwise to this view. More...

FVectorQuaternionAdapter	__isub__ (float t)
	Subtracts the scalar t from component C1 of this view. More...

FVectorQuaternionAdapter	__isub__ (FVectorQuaternionAdapter va)
	Subtracts the vector adapter va componentwise from this view. More...

FVectorQuaternionAdapter	__isub__ (ConstFQuaternionExpression e)
	Subtracts the quaternion expression e componentwise from this view. More...

FVectorQuaternionAdapter	__imul__ (float t)
	Multiplies every component of this view by the scalar t. More...

FVectorQuaternionAdapter	__imul__ (FVectorQuaternionAdapter va)
	Multiplies this view by the vector adapter va (Hamilton-product semantics). More...

FVectorQuaternionAdapter	__imul__ (ConstFQuaternionExpression e)
	Multiplies this view by the quaternion expression e (Hamilton-product semantics). More...

FVectorQuaternionAdapter	__idiv__ (float t)
	Divides every component of this view by the scalar t. More...

FVectorQuaternionAdapter	__idiv__ (FVectorQuaternionAdapter va)
	Divides this view by the vector adapter va (Hamilton-quotient semantics). More...

FVectorQuaternionAdapter	__idiv__ (ConstFQuaternionExpression e)
	Divides this view by the quaternion expression e (Hamilton-quotient semantics). More...

FVectorQuaternionAdapter	__itruediv__ (float t)
	Divides every component of this view by the scalar t. More...

FVectorQuaternionAdapter	__itruediv__ (FVectorQuaternionAdapter va)
	Divides this view by the vector adapter va (Hamilton-quotient semantics). More...

FVectorQuaternionAdapter	__itruediv__ (ConstFQuaternionExpression e)
	Divides this view by the quaternion expression e (Hamilton-quotient semantics). More...

Properties
	objectID = property(getObjectID)

	data = property(getData)

Detailed Description

Quaternion expression that exposes a 4-element vector as a quaternion (component indices 0-3 map to C1-C4).

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.FVectorQuaternionAdapter.__init__ ( FVectorQuaternionAdapter va )

Contructs a copy of the FVectorQuaternionAdapter instance va.

Parameters

va	The `FVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.FVectorQuaternionAdapter.__init__ ( FVectorExpression v )

Constructs the adapter wrapping the 4-element vector v.

Parameters

v	The 4-element vector to be viewed as a quaternion.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.FVectorQuaternionAdapter.getObjectID ( )

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

Different Python FVectorQuaternionAdapter 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 FVectorQuaternionAdapter 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]

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [2/6]

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [3/6]

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [4/6]

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

Assigns the quaternion expression e to this view (writing through to the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [5/6]

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

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

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ assign() [6/6]

FVectorQuaternionAdapter CDPL.Math.FVectorQuaternionAdapter.assign ( FVectorQuaternionAdapter va )

Copies the components of va into this view (writing through to the wrapped vector).

Parameters

va	The source adapter.

Returns: self.

◆ getC1()

float CDPL.Math.FVectorQuaternionAdapter.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

float CDPL.Math.FVectorQuaternionAdapter.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

float CDPL.Math.FVectorQuaternionAdapter.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

float CDPL.Math.FVectorQuaternionAdapter.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.FVectorQuaternionAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.FVectorQuaternionAdapter.swap ( FVectorQuaternionAdapter va )

Swaps the components of this view with those of va.

Parameters

va	The adapter to swap with.

◆ setC1()

None CDPL.Math.FVectorQuaternionAdapter.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.FVectorQuaternionAdapter.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.FVectorQuaternionAdapter.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.FVectorQuaternionAdapter.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.FVectorQuaternionAdapter.set	(	float	c1 = `0.0`,
		float	c2 = `0.0`,
		float	c3 = `0.0`,
		float	c4 = `0.0`
	)

Assigns the four supplied component values to this view (writing through to the wrapped vector).

Parameters

c1	The C1 component value.
c2	The C2 component value.
c3	The C3 component value.
c4	The C4 component value.

◆ getData()

FVectorExpression CDPL.Math.FVectorQuaternionAdapter.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

bool CDPL.Math.FVectorQuaternionAdapter.__eq__ ( FVectorQuaternionAdapter va )

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

Parameters

va	The `FVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.FVectorQuaternionAdapter.__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.FVectorQuaternionAdapter.__ne__ ( FVectorQuaternionAdapter va )

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

Parameters

va	The `FVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.FVectorQuaternionAdapter.__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.FVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the FVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ pos()

FVectorQuaternionAdapter CDPL.Math.FVectorQuaternionAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

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

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

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

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

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

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

Adds the scalar t to component C1 of this view.

Parameters

t	The scalar summand.

Returns: self.

◆ iadd() [2/3]

FVectorQuaternionAdapter CDPL.Math.FVectorQuaternionAdapter.__iadd__ ( FVectorQuaternionAdapter va )

Adds the vector adapter va componentwise to this view.

Parameters

va	The vector adapter to add.

Returns: self.

◆ iadd() [3/3]

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

Adds the quaternion expression e componentwise to this view.

Parameters

e	The quaternion expression to add.

Returns: self.

◆ isub() [1/3]

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

Subtracts the scalar t from component C1 of this view.

Parameters

t	The scalar subtrahend.

Returns: self.

◆ isub() [2/3]

FVectorQuaternionAdapter CDPL.Math.FVectorQuaternionAdapter.__isub__ ( FVectorQuaternionAdapter va )

Subtracts the vector adapter va componentwise from this view.

Parameters

va	The vector adapter to subtract.

Returns: self.

◆ isub() [3/3]

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

Subtracts the quaternion expression e componentwise from this view.

Parameters

e	The quaternion expression to subtract.

Returns: self.

◆ imul() [1/3]

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

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ imul() [2/3]

FVectorQuaternionAdapter CDPL.Math.FVectorQuaternionAdapter.__imul__ ( FVectorQuaternionAdapter va )

Multiplies this view by the vector adapter va (Hamilton-product semantics).

Parameters

va	The vector adapter to multiply by.

Returns: self.

◆ imul() [3/3]

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

Multiplies this view by the quaternion expression e (Hamilton-product semantics).

Parameters

e	The quaternion expression to multiply by.

Returns: self.

◆ idiv() [1/3]

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

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ idiv() [2/3]

FVectorQuaternionAdapter CDPL.Math.FVectorQuaternionAdapter.__idiv__ ( FVectorQuaternionAdapter va )

Divides this view by the vector adapter va (Hamilton-quotient semantics).

Parameters

va	The vector adapter to divide by.

Returns: self.

◆ idiv() [3/3]

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

Divides this view by the quaternion expression e (Hamilton-quotient semantics).

Parameters

e	The quaternion expression to divide by.

Returns: self.

◆ itruediv() [1/3]

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

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv() [2/3]

FVectorQuaternionAdapter CDPL.Math.FVectorQuaternionAdapter.__itruediv__ ( FVectorQuaternionAdapter va )

Divides this view by the vector adapter va (Hamilton-quotient semantics).

Parameters

va	The vector adapter to divide by.

Returns: self.

◆ itruediv() [3/3]

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

Divides this view by the quaternion expression e (Hamilton-quotient semantics).

Parameters

e	The quaternion expression to divide by.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

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

◆ getData()

◆ __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/2]

◆ init() [2/2]

◆ 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]