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

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

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

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

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

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

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

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

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

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

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

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

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

None	swap (LVectorQuaternionAdapter va)
	Swaps the components of this view with those of va. More...

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

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

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

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

None	set (int c1=0, int c2=0, int c3=0, int c4=0)
	Assigns the four supplied component values to this view (writing through to the wrapped vector). More...

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

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

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

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

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

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

LVectorQuaternionAdapter	__pos__ ()
	Returns self. More...

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

ConstLQuaternionExpression	__add__ (int t)
	Returns the result of the addition operation `self + t`. More...

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

ConstLQuaternionExpression	__radd__ (int t)
	Returns the result of the addition operation `t + self`. More...

ConstLQuaternionExpression	__sub__ (int t)
	Returns the result of the subtraction operation `self - t`. More...

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

ConstLQuaternionExpression	__rsub__ (int t)
	Returns the result of the subtraction operation `t - self`. More...

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

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

ConstLQuaternionExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

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

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

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

ConstLQuaternionExpression	__rdiv__ (int t)
	Returns the result of the division operation `t // self`. More...

LVectorQuaternionAdapter	__iadd__ (int t)
	Adds the scalar t to component C1 of this view. More...

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

LVectorQuaternionAdapter	__iadd__ (ConstLQuaternionExpression e)
	Adds the quaternion expression e componentwise to this view. More...

LVectorQuaternionAdapter	__isub__ (int t)
	Subtracts the scalar t from component C1 of this view. More...

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

LVectorQuaternionAdapter	__isub__ (ConstLQuaternionExpression e)
	Subtracts the quaternion expression e componentwise from this view. More...

LVectorQuaternionAdapter	__imul__ (int t)
	Multiplies every component of this view by the scalar t. More...

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

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

LVectorQuaternionAdapter	__idiv__ (int t)
	Divides every component of this view by the scalar t. More...

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

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

LVectorQuaternionAdapter	__itruediv__ (int t)
	Divides every component of this view by the scalar t. More...

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

LVectorQuaternionAdapter	__itruediv__ (ConstLQuaternionExpression 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.LVectorQuaternionAdapter.__init__ ( LVectorQuaternionAdapter va )

Contructs a copy of the LVectorQuaternionAdapter instance va.

Parameters

va	The `LVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

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

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

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

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

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

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

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

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.assign ( LVectorQuaternionAdapter va )

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

Parameters

va	The source adapter.

Returns: self.

◆ getC1()

int CDPL.Math.LVectorQuaternionAdapter.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

int CDPL.Math.LVectorQuaternionAdapter.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

int CDPL.Math.LVectorQuaternionAdapter.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

int CDPL.Math.LVectorQuaternionAdapter.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.LVectorQuaternionAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

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

Swaps the components of this view with those of va.

Parameters

va	The adapter to swap with.

◆ setC1()

None CDPL.Math.LVectorQuaternionAdapter.setC1 ( int 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.LVectorQuaternionAdapter.setC2 ( int 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.LVectorQuaternionAdapter.setC3 ( int 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.LVectorQuaternionAdapter.setC4 ( int 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.LVectorQuaternionAdapter.set	(	int	c1 = `0`,
		int	c2 = `0`,
		int	c3 = `0`,
		int	c4 = `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()

LVectorExpression CDPL.Math.LVectorQuaternionAdapter.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

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

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

Parameters

va	The `LVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.LVectorQuaternionAdapter.__eq__ ( ConstLQuaternionExpression q )

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

Parameters

q	The `ConstLQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

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

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

Parameters

va	The `LVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.LVectorQuaternionAdapter.__ne__ ( ConstLQuaternionExpression q )

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

Parameters

q	The `ConstLQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.LVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the LVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ pos()

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__add__ ( int t )

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

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

◆ add() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__add__ ( ConstLQuaternionExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ radd()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__radd__ ( int t )

Returns the result of the addition operation t + self.

Parameters

t	Specifies the first addend.

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

◆ sub() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__sub__ ( int t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__sub__ ( ConstLQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__rsub__ ( int t )

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__mul__ ( ConstLQuaternionExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ rmul()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ div() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ div() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__div__ ( ConstLQuaternionExpression e )

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

Parameters

e	Specifies the divisor.

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

◆ truediv()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rdiv()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__rdiv__ ( int t )

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

Parameters

t	Specifies the dividend.

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

◆ iadd() [1/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__iadd__ ( int t )

Adds the scalar t to component C1 of this view.

Parameters

t	The scalar summand.

Returns: self.

◆ iadd() [2/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__iadd__ ( LVectorQuaternionAdapter va )

Adds the vector adapter va componentwise to this view.

Parameters

va	The vector adapter to add.

Returns: self.

◆ iadd() [3/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__iadd__ ( ConstLQuaternionExpression e )

Adds the quaternion expression e componentwise to this view.

Parameters

e	The quaternion expression to add.

Returns: self.

◆ isub() [1/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__isub__ ( int t )

Subtracts the scalar t from component C1 of this view.

Parameters

t	The scalar subtrahend.

Returns: self.

◆ isub() [2/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__isub__ ( LVectorQuaternionAdapter va )

Subtracts the vector adapter va componentwise from this view.

Parameters

va	The vector adapter to subtract.

Returns: self.

◆ isub() [3/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__isub__ ( ConstLQuaternionExpression e )

Subtracts the quaternion expression e componentwise from this view.

Parameters

e	The quaternion expression to subtract.

Returns: self.

◆ imul() [1/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__imul__ ( int t )

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ imul() [2/3]

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

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

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__idiv__ ( int t )

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ idiv() [2/3]

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

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

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__itruediv__ ( int t )

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv() [2/3]

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

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