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

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

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

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

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

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

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

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

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

FQuaternionVectorAdapter	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this view. 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 `FQuaternionVectorAdapter` instance into a corresponding `numpy.ndarray` object. More...

None	swap (FQuaternionVectorAdapter qa)
	Swaps the components of this view with those of qa. More...

None	setElement (int i, float v)
	Sets the value of the quaternion component at index i to v. More...

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

bool	__eq__ (FQuaternionVectorAdapter 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__ (FQuaternionVectorAdapter 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 `FQuaternionVectorAdapter` instance. More...

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

None	__setitem__ (int i, float v)
	Sets the value of the quaternion component at index i to v. More...

FQuaternionVectorAdapter	__iadd__ (FQuaternionVectorAdapter qa)
	Adds the quaternion adapter qa componentwise to this view. More...

FQuaternionVectorAdapter	__iadd__ (ConstFVectorExpression e)
	Adds the vector expression e componentwise to this view. More...

FQuaternionVectorAdapter	__isub__ (FQuaternionVectorAdapter qa)
	Subtracts the quaternion adapter qa componentwise from this view. More...

FQuaternionVectorAdapter	__isub__ (ConstFVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...

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

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

FQuaternionVectorAdapter	__itruediv__ (float t)
	Divides every component of this view by the scalar t. 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.FQuaternionVectorAdapter.__init__ ( FQuaternionVectorAdapter qa )

Contructs a copy of the FQuaternionVectorAdapter instance qa.

Parameters

qa	The `FQuaternionVectorAdapter` instance to copy.

◆ init() [2/2]

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

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

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

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [2/6]

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [3/6]

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [4/6]

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [5/6]

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.assign ( FQuaternionVectorAdapter qa )

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

Parameters

qa	The source adapter.

Returns: self.

◆ assign() [6/6]

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.assign ( object a )

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

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ isEmpty()

bool CDPL.Math.FQuaternionVectorAdapter.isEmpty ( )

Tells whether the view is empty (always False).

Returns: False.

◆ getSize()

int CDPL.Math.FQuaternionVectorAdapter.getSize ( )

Returns the dimensionality of the view (always 4).

Returns: 4.

◆ getElement()

float CDPL.Math.FQuaternionVectorAdapter.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.FQuaternionVectorAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.FQuaternionVectorAdapter.swap ( FQuaternionVectorAdapter qa )

Swaps the components of this view with those of qa.

Parameters

qa	The adapter to swap with.

◆ setElement()

None CDPL.Math.FQuaternionVectorAdapter.setElement	(	int	i,
		float	v
	)

Sets the value of the quaternion component at index i to v.

Parameters

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

Exceptions

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

◆ getData()

FQuaternionExpression CDPL.Math.FQuaternionVectorAdapter.getData ( )

Returns the wrapped quaternion.

Returns: The wrapped quaternion closure.

◆ eq() [1/2]

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

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

Parameters

qa	The `FQuaternionVectorAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

qa	The `FQuaternionVectorAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__len__ ( )

Returns the dimensionality of the view (always 4).

Returns: 4.

◆ str()

str CDPL.Math.FQuaternionVectorAdapter.__str__ ( )

Returns a string representation of the FQuaternionVectorAdapter instance.

Returns: The generated string representation.

◆ pos()

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFVectorExpression CDPL.Math.FQuaternionVectorAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstFVectorExpression CDPL.Math.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__sub__ ( ConstFVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstFVectorExpression CDPL.Math.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__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.FQuaternionVectorAdapter.__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.

◆ setitem()

None CDPL.Math.FQuaternionVectorAdapter.__setitem__	(	int	i,
		float	v
	)

Sets the value of the quaternion component at index i to v.

Parameters

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

Exceptions

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

◆ iadd() [1/2]

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.__iadd__ ( FQuaternionVectorAdapter qa )

Adds the quaternion adapter qa componentwise to this view.

Parameters

qa	The quaternion adapter to add.

Returns: self.

◆ iadd() [2/2]

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.__iadd__ ( ConstFVectorExpression e )

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns: self.

◆ isub() [1/2]

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.__isub__ ( FQuaternionVectorAdapter qa )

Subtracts the quaternion adapter qa componentwise from this view.

Parameters

qa	The quaternion adapter to subtract.

Returns: self.

◆ isub() [2/2]

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.__isub__ ( ConstFVectorExpression e )

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns: self.

◆ imul()

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

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

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

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

FQuaternionVectorAdapter CDPL.Math.FQuaternionVectorAdapter.__itruediv__ ( float 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()

◆ getElement()

◆ toArray()

◆ swap()

◆ setElement()

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

◆ __setitem__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

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

◆ setitem()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()