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

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

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

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

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

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

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

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

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

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

ConstULVectorQuaternionAdapter	__pos__ ()
	Returns self. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

ConstULQuaternionExpression	__rdiv__ (int t)
	Returns the result of the division operation `t // self`. 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.ConstULVectorQuaternionAdapter.__init__ ( ConstULVectorQuaternionAdapter va )

Contructs a copy of the ConstULVectorQuaternionAdapter instance va.

Parameters

va	The `ConstULVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

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

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

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

◆ getC1()

int CDPL.Math.ConstULVectorQuaternionAdapter.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

int CDPL.Math.ConstULVectorQuaternionAdapter.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

int CDPL.Math.ConstULVectorQuaternionAdapter.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

int CDPL.Math.ConstULVectorQuaternionAdapter.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.ConstULVectorQuaternionAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ getData()

ConstULVectorExpression CDPL.Math.ConstULVectorQuaternionAdapter.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

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

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

Parameters

va	The `ConstULVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.ConstULVectorQuaternionAdapter.__eq__ ( ConstULQuaternionExpression q )

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

Parameters

q	The `ConstULQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

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

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

Parameters

va	The `ConstULVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.ConstULVectorQuaternionAdapter.__ne__ ( ConstULQuaternionExpression q )

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

Parameters

q	The `ConstULQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.ConstULVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the ConstULVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ pos()

ConstULVectorQuaternionAdapter CDPL.Math.ConstULVectorQuaternionAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add() [1/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__add__ ( int t )

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

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

◆ add() [2/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__add__ ( ConstULQuaternionExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ radd()

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__radd__ ( int t )

Returns the result of the addition operation t + self.

Parameters

t	Specifies the first addend.

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

◆ sub() [1/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__sub__ ( int t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__sub__ ( ConstULQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__rsub__ ( int t )

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__mul__ ( ConstULQuaternionExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ rmul()

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ div() [1/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ div() [2/2]

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__div__ ( ConstULQuaternionExpression e )

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

Parameters

e	Specifies the divisor.

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

◆ truediv()

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rdiv()

ConstULQuaternionExpression CDPL.Math.ConstULVectorQuaternionAdapter.__rdiv__ ( int t )

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

Parameters

t	Specifies the dividend.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getObjectID()

◆ getC1()

◆ getC2()

◆ getC3()

◆ getC4()

◆ toArray()

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

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