Adapter that exposes a quaternion as a 4 element vector expression (indices map to the components C1, C2, C3, C4). More...

Inheritance diagram for CDPL.Math.LQuaternionVectorAdapter:

Public Member Functions
None	__init__ (LQuaternionVectorAdapter a)
	Initializes a copy of the `LQuaternionVectorAdapter` instance a. More...

None	__init__ (LQuaternionExpression e)
	Initializes the `LQuaternionVectorAdapter` instance. More...

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

LQuaternionVectorAdapter	assign (ConstFVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion). More...

LQuaternionVectorAdapter	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion). More...

LQuaternionVectorAdapter	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion). More...

LQuaternionVectorAdapter	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion). More...

LQuaternionVectorAdapter	assign (LQuaternionVectorAdapter a)
	Copies the components of a into this view (writing through to the wrapped quaternion). More...

None	assign (object a)
	Copies the components of a into this view (writing through to the wrapped quaternion). More...

bool	isEmpty ()
	Tells whether the view is empty (always `False`, the view is fixed-size with 4 components). More...

int	getSize ()
	Returns the dimensionality of the view (always 4). More...

int	getElement (int i)

object	toArray ()

None	swap (LQuaternionVectorAdapter a)
	Swaps the components of this view with those of a. More...

None	setElement (int i, int v)

LQuaternionExpression	getData ()
	Returns a reference to the wrapped quaternion (via its stored closure). More...

bool	__eq__ (LQuaternionVectorAdapter a)
	Returns the result of the comparison operation `self == a`. More...

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

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

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

int	__call__ (int i)
	Returns a reference to the quaternion component at index i. More...

int	__getitem__ (int i)
	Returns a reference to the quaternion component at index i. More...

int	__len__ ()
	Returns the dimensionality of the view (always 4). More...

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

LQuaternionVectorAdapter	__pos__ ()

ConstLVectorExpression	__neg__ ()

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

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

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

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

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

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

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

None	__setitem__ (int i, int v)

LQuaternionVectorAdapter	__iadd__ (LQuaternionVectorAdapter a)
	Performs the in-place addition operation `self += a`. More...

LQuaternionVectorAdapter	__iadd__ (ConstLVectorExpression e)
	Adds the vector expression e componentwise to this view. More...

LQuaternionVectorAdapter	__isub__ (LQuaternionVectorAdapter a)
	Performs the in-place subtraction operation `self -= a`. More...

LQuaternionVectorAdapter	__isub__ (ConstLVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...

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

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

LQuaternionVectorAdapter	__itruediv__ (int t)

Properties
	objectID = property(getObjectID)

	size = property(getSize)

	data = property(getData)

Detailed Description

Adapter that exposes a quaternion as a 4 element vector expression (indices map to the components C1, C2, C3, C4).

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.LQuaternionVectorAdapter.__init__ ( LQuaternionVectorAdapter a )

Initializes a copy of the LQuaternionVectorAdapter instance a.

Parameters

a	The `LQuaternionVectorAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.LQuaternionVectorAdapter.__init__ ( LQuaternionExpression e )

Initializes the LQuaternionVectorAdapter instance.

Parameters

e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.LQuaternionVectorAdapter.getObjectID ( )

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

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

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.assign ( ConstFVectorExpression e )

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion).

Parameters

e	The source vector expression.

Returns: self

◆ assign() [2/6]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.assign ( ConstDVectorExpression e )

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion).

Parameters

e	The source vector expression.

Returns: self

◆ assign() [3/6]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.assign ( ConstLVectorExpression e )

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion).

Parameters

e	The source vector expression.

Returns: self

◆ assign() [4/6]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.assign ( ConstULVectorExpression e )

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped quaternion).

Parameters

e	The source vector expression.

Returns: self

◆ assign() [5/6]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.assign ( LQuaternionVectorAdapter a )

Copies the components of a into this view (writing through to the wrapped quaternion).

Parameters

a	The source adapter.

Returns: self

◆ assign() [6/6]

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

Copies the components of a into this view (writing through to the wrapped quaternion).

Parameters

a	The source adapter.

Returns: self

◆ isEmpty()

bool CDPL.Math.LQuaternionVectorAdapter.isEmpty ( )

Tells whether the view is empty (always False, the view is fixed-size with 4 components).

Returns: False.

◆ getSize()

int CDPL.Math.LQuaternionVectorAdapter.getSize ( )

Returns the dimensionality of the view (always 4).

Returns: 4.

◆ swap()

None CDPL.Math.LQuaternionVectorAdapter.swap ( LQuaternionVectorAdapter a )

Swaps the components of this view with those of a.

Parameters

a	The adapter to swap with.

◆ getData()

LQuaternionExpression CDPL.Math.LQuaternionVectorAdapter.getData ( )

Returns a reference to the wrapped quaternion (via its stored closure).

Returns: A reference to the wrapped quaternion closure.

◆ eq() [1/2]

bool CDPL.Math.LQuaternionVectorAdapter.__eq__ ( LQuaternionVectorAdapter a )

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

Parameters

a	The `LQuaternionVectorAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.LQuaternionVectorAdapter.__eq__ ( ConstLVectorExpression e )

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

Parameters

e	The `ConstLVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.LQuaternionVectorAdapter.__ne__ ( LQuaternionVectorAdapter a )

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

Parameters

a	The `LQuaternionVectorAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.LQuaternionVectorAdapter.__ne__ ( ConstLVectorExpression e )

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

Parameters

e	The `ConstLVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ call()

int CDPL.Math.LQuaternionVectorAdapter.__call__ ( int i )

Returns a reference to the quaternion component at index i.

Parameters

i	The zero-based component index (0 = C1, 1 = C2, 2 = C3, 3 = C4).

Returns: A reference to the component.

Exceptions

Base.IndexError if i is not in the range [0, 3].

◆ getitem()

int CDPL.Math.LQuaternionVectorAdapter.__getitem__ ( int i )

Returns a reference to the quaternion component at index i.

Parameters

i	The zero-based component index.

Returns: A reference to the component.

Exceptions

Base.IndexError if i is not in the range [0, 3].

◆ len()

int CDPL.Math.LQuaternionVectorAdapter.__len__ ( )

Returns the dimensionality of the view (always 4).

Returns: 4.

◆ str()

str CDPL.Math.LQuaternionVectorAdapter.__str__ ( )

Returns a string representation of the LQuaternionVectorAdapter instance.

Returns: The generated string representation.

◆ add()

ConstLVectorExpression CDPL.Math.LQuaternionVectorAdapter.__add__ ( ConstLVectorExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstLVectorExpression CDPL.Math.LQuaternionVectorAdapter.__sub__ ( ConstLVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstLVectorExpression CDPL.Math.LQuaternionVectorAdapter.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/2]

ConstLVectorExpression CDPL.Math.LQuaternionVectorAdapter.__mul__ ( ConstLMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstLVectorExpression CDPL.Math.LQuaternionVectorAdapter.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstLVectorExpression CDPL.Math.LQuaternionVectorAdapter.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstLVectorExpression CDPL.Math.LQuaternionVectorAdapter.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ iadd() [1/2]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.__iadd__ ( LQuaternionVectorAdapter a )

Performs the in-place addition operation self += a.

Parameters

a	Specifies the second addend.

Returns: The updated LQuaternionVectorAdapter instance self.

◆ iadd() [2/2]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.__iadd__ ( ConstLVectorExpression e )

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns: self

◆ isub() [1/2]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.__isub__ ( LQuaternionVectorAdapter a )

Performs the in-place subtraction operation self -= a.

Parameters

a	Specifies the subtrahend.

Returns: The updated LQuaternionVectorAdapter instance self.

◆ isub() [2/2]

LQuaternionVectorAdapter CDPL.Math.LQuaternionVectorAdapter.__isub__ ( ConstLVectorExpression e )

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns: self

◆ imul()

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

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self

◆ idiv()

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

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

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]

◆ isEmpty()

◆ getSize()

◆ swap()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()