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

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

None	__init__ (ConstFQuaternionExpression q)
	Constructs the adapter wrapping the quaternion q. More...

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

bool	isEmpty ()
	Tells whether the view is empty (always `False`). More...

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

float	getElement (int i)
	Returns the quaternion component at index i. More...

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

ConstFQuaternionExpression	getData ()
	Returns the wrapped quaternion. More...

bool	__eq__ (ConstFQuaternionVectorAdapter qa)
	Returns the result of the comparison operation `self == qa`. More...

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

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

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

float	__call__ (int i)
	Returns the quaternion component at index i. More...

float	__getitem__ (int i)
	Returns 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 `ConstFQuaternionVectorAdapter` instance. More...

ConstFQuaternionVectorAdapter	__pos__ ()
	Returns self. More...

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

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

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

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

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

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

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

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

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.ConstFQuaternionVectorAdapter.__init__ ( ConstFQuaternionVectorAdapter qa )

Contructs a copy of the ConstFQuaternionVectorAdapter instance qa.

Parameters

qa	The `ConstFQuaternionVectorAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.ConstFQuaternionVectorAdapter.__init__ ( ConstFQuaternionExpression q )

Constructs the adapter wrapping the quaternion q.

Parameters

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

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstFQuaternionVectorAdapter.getObjectID ( )

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

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

◆ isEmpty()

bool CDPL.Math.ConstFQuaternionVectorAdapter.isEmpty ( )

Tells whether the view is empty (always False).

Returns: False.

◆ getSize()

int CDPL.Math.ConstFQuaternionVectorAdapter.getSize ( )

Returns the dimensionality of the view (always 4).

Returns: 4.

◆ getElement()

float CDPL.Math.ConstFQuaternionVectorAdapter.getElement ( int i )

Returns the quaternion component at index i.

Parameters

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

Returns: The value of the component.

Exceptions

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

◆ toArray()

object CDPL.Math.ConstFQuaternionVectorAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ getData()

ConstFQuaternionExpression CDPL.Math.ConstFQuaternionVectorAdapter.getData ( )

Returns the wrapped quaternion.

Returns: The wrapped quaternion closure.

◆ eq() [1/2]

bool CDPL.Math.ConstFQuaternionVectorAdapter.__eq__ ( ConstFQuaternionVectorAdapter qa )

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

Parameters

qa	The `ConstFQuaternionVectorAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.ConstFQuaternionVectorAdapter.__eq__ ( ConstFVectorExpression e )

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

Parameters

e	The `ConstFVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.ConstFQuaternionVectorAdapter.__ne__ ( ConstFQuaternionVectorAdapter qa )

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

Parameters

qa	The `ConstFQuaternionVectorAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.ConstFQuaternionVectorAdapter.__ne__ ( ConstFVectorExpression e )

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

Parameters

e	The `ConstFVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ call()

float CDPL.Math.ConstFQuaternionVectorAdapter.__call__ ( int i )

Returns the quaternion component at index i.

Parameters

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

Returns: The value of the component.

Exceptions

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

◆ getitem()

float CDPL.Math.ConstFQuaternionVectorAdapter.__getitem__ ( int i )

Returns the quaternion component at index i.

Parameters

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

Returns: The value of the component.

Exceptions

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

◆ len()

int CDPL.Math.ConstFQuaternionVectorAdapter.__len__ ( )

Returns the dimensionality of the view (always 4).

Returns: 4.

◆ str()

str CDPL.Math.ConstFQuaternionVectorAdapter.__str__ ( )

Returns a string representation of the ConstFQuaternionVectorAdapter instance.

Returns: The generated string representation.

◆ pos()

ConstFQuaternionVectorAdapter CDPL.Math.ConstFQuaternionVectorAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__add__ ( ConstFVectorExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub()

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__sub__ ( ConstFVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/2]

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__mul__ ( ConstFMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ div()

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__div__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ truediv()

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstFVectorExpression CDPL.Math.ConstFQuaternionVectorAdapter.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getObjectID()

◆ isEmpty()

◆ getSize()

◆ getElement()

◆ toArray()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()