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

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

None	__init__ (ConstLVectorExpression 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 `ConstLVectorQuaternionAdapter` instance into a corresponding `numpy.ndarray` object. More...

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

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

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

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.ConstLVectorQuaternionAdapter.__init__ ( ConstLVectorQuaternionAdapter va )

Contructs a copy of the ConstLVectorQuaternionAdapter instance va.

Parameters

va	The `ConstLVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

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

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

Different Python ConstLVectorQuaternionAdapter 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 ConstLVectorQuaternionAdapter 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.ConstLVectorQuaternionAdapter.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

int CDPL.Math.ConstLVectorQuaternionAdapter.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

int CDPL.Math.ConstLVectorQuaternionAdapter.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

int CDPL.Math.ConstLVectorQuaternionAdapter.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.ConstLVectorQuaternionAdapter.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ getData()

ConstLVectorExpression CDPL.Math.ConstLVectorQuaternionAdapter.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

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

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

Parameters

va	The `ConstLVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

va	The `ConstLVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the ConstLVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ pos()

ConstLVectorQuaternionAdapter CDPL.Math.ConstLVectorQuaternionAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstLQuaternionExpression CDPL.Math.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__sub__ ( int t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

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

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstLQuaternionExpression CDPL.Math.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.ConstLVectorQuaternionAdapter.__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.

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