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.DVectorQuaternionAdapter:

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

None	__init__ (DVectorExpression 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...

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

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

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

DVectorQuaternionAdapter	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...

DVectorQuaternionAdapter	assign (DVectorQuaternionAdapter 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 `DVectorQuaternionAdapter` instance into a corresponding `numpy.ndarray` object. More...

None	swap (DVectorQuaternionAdapter 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...

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

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

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

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

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

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

DVectorQuaternionAdapter	__pos__ ()
	Returns self. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DVectorQuaternionAdapter	__iadd__ (ConstDQuaternionExpression e)
	Adds the quaternion expression e componentwise to this view. More...

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

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

DVectorQuaternionAdapter	__isub__ (ConstDQuaternionExpression e)
	Subtracts the quaternion expression e componentwise from this view. More...

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

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

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

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

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

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

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

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

DVectorQuaternionAdapter	__itruediv__ (ConstDQuaternionExpression 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.DVectorQuaternionAdapter.__init__ ( DVectorQuaternionAdapter va )

Contructs a copy of the DVectorQuaternionAdapter instance va.

Parameters

va	The `DVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.DVectorQuaternionAdapter.__init__ ( DVectorExpression 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.DVectorQuaternionAdapter.getObjectID ( )

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

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

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.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.DVectorQuaternionAdapter.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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.assign ( DVectorQuaternionAdapter 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.DVectorQuaternionAdapter.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

float CDPL.Math.DVectorQuaternionAdapter.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

float CDPL.Math.DVectorQuaternionAdapter.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

float CDPL.Math.DVectorQuaternionAdapter.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.DVectorQuaternionAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

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

Swaps the components of this view with those of va.

Parameters

va	The adapter to swap with.

◆ setC1()

None CDPL.Math.DVectorQuaternionAdapter.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.DVectorQuaternionAdapter.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.DVectorQuaternionAdapter.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.DVectorQuaternionAdapter.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.DVectorQuaternionAdapter.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()

DVectorExpression CDPL.Math.DVectorQuaternionAdapter.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

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

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

Parameters

va	The `DVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.DVectorQuaternionAdapter.__eq__ ( ConstDQuaternionExpression q )

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

Parameters

q	The `ConstDQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.DVectorQuaternionAdapter.__ne__ ( DVectorQuaternionAdapter va )

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

Parameters

va	The `DVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.DVectorQuaternionAdapter.__ne__ ( ConstDQuaternionExpression q )

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

Parameters

q	The `ConstDQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.DVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the DVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ pos()

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add() [1/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__add__ ( float t )

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

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

◆ add() [2/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__add__ ( ConstDQuaternionExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ radd()

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__radd__ ( float t )

Returns the result of the addition operation t + self.

Parameters

t	Specifies the first addend.

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

◆ sub() [1/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__sub__ ( float t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__sub__ ( ConstDQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__rsub__ ( float t )

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__mul__ ( ConstDQuaternionExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ rmul()

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ div() [1/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__div__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ div() [2/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__div__ ( ConstDQuaternionExpression e )

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

Parameters

e	Specifies the divisor.

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

◆ truediv()

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ rdiv()

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__rdiv__ ( float t )

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

Parameters

t	Specifies the dividend.

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

◆ iadd() [1/3]

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

Adds the scalar t to component C1 of this view.

Parameters

t	The scalar summand.

Returns: self.

◆ iadd() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__iadd__ ( DVectorQuaternionAdapter va )

Adds the vector adapter va componentwise to this view.

Parameters

va	The vector adapter to add.

Returns: self.

◆ iadd() [3/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__iadd__ ( ConstDQuaternionExpression e )

Adds the quaternion expression e componentwise to this view.

Parameters

e	The quaternion expression to add.

Returns: self.

◆ isub() [1/3]

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

Subtracts the scalar t from component C1 of this view.

Parameters

t	The scalar subtrahend.

Returns: self.

◆ isub() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__isub__ ( DVectorQuaternionAdapter va )

Subtracts the vector adapter va componentwise from this view.

Parameters

va	The vector adapter to subtract.

Returns: self.

◆ isub() [3/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__isub__ ( ConstDQuaternionExpression e )

Subtracts the quaternion expression e componentwise from this view.

Parameters

e	The quaternion expression to subtract.

Returns: self.

◆ imul() [1/3]

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

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ imul() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__imul__ ( DVectorQuaternionAdapter 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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__imul__ ( ConstDQuaternionExpression 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]

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

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ idiv() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__idiv__ ( DVectorQuaternionAdapter 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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__idiv__ ( ConstDQuaternionExpression 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]

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

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__itruediv__ ( DVectorQuaternionAdapter 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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__itruediv__ ( ConstDQuaternionExpression 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]