CDPL.Math.DQuaternionVectorAdapter Class Reference

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

Public Member Functions
None	__init__ (DQuaternionVectorAdapter a)
	Initializes a copy of the DQuaternionVectorAdapter instance a. More...
None	__init__ (DQuaternionExpression e)
	Initializes the DQuaternionVectorAdapter instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
DQuaternionVectorAdapter	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...
DQuaternionVectorAdapter	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...
DQuaternionVectorAdapter	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...
DQuaternionVectorAdapter	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...
DQuaternionVectorAdapter	assign (DQuaternionVectorAdapter 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...
float	getElement (int i)
object	toArray ()
None	swap (DQuaternionVectorAdapter a)
	Swaps the components of this view with those of a. More...
None	setElement (int i, float v)
DQuaternionExpression	getData ()
	Returns a reference to the wrapped quaternion (via its stored closure). More...
bool	__eq__ (DQuaternionVectorAdapter a)
	Returns the result of the comparison operation self == a. More...
bool	__eq__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (DQuaternionVectorAdapter a)
	Returns the result of the comparison operation self != a. More...
bool	__ne__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self != e. More...
float	__call__ (int i)
	Returns a reference to the quaternion component at index i. More...
float	__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 DQuaternionVectorAdapter instance. More...
DQuaternionVectorAdapter	__pos__ ()
ConstDVectorExpression	__neg__ ()
ConstDVectorExpression	__add__ (ConstDVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstDVectorExpression	__sub__ (ConstDVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstDVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstDVectorExpression	__mul__ (ConstDMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDVectorExpression	__div__ (float t)
	Returns the result of the division operation self // t. More...
ConstDVectorExpression	__truediv__ (float t)
	Returns the result of the true division operation self / t. More...
ConstDVectorExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. More...
None	__setitem__ (int i, float v)
DQuaternionVectorAdapter	__iadd__ (DQuaternionVectorAdapter a)
	Performs the in-place addition operation self += a. More...
DQuaternionVectorAdapter	__iadd__ (ConstDVectorExpression e)
	Adds the vector expression e componentwise to this view. More...
DQuaternionVectorAdapter	__isub__ (DQuaternionVectorAdapter a)
	Performs the in-place subtraction operation self -= a. More...
DQuaternionVectorAdapter	__isub__ (ConstDVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...
DQuaternionVectorAdapter	__imul__ (float t)
	Multiplies every component of this view by the scalar t. More...
DQuaternionVectorAdapter	__idiv__ (float t)
	Divides every component of this view by the scalar t. More...
DQuaternionVectorAdapter	__itruediv__ (float 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.DQuaternionVectorAdapter.__init__

(

DQuaternionVectorAdapter

a

)

Initializes a copy of the DQuaternionVectorAdapter instance a.

Parameters

a	The DQuaternionVectorAdapter instance to copy.

__init__() [2/2]

None CDPL.Math.DQuaternionVectorAdapter.__init__

(

DQuaternionExpression

e

)

Initializes the DQuaternionVectorAdapter instance.

Parameters

e

Member Function Documentation

getObjectID()

int CDPL.Math.DQuaternionVectorAdapter.getObjectID

(

)

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

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

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.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]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.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]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.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]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.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]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.assign

(

DQuaternionVectorAdapter

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.DQuaternionVectorAdapter.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.DQuaternionVectorAdapter.isEmpty

(

)

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

Returns

False.

getSize()

int CDPL.Math.DQuaternionVectorAdapter.getSize

(

)

Returns the dimensionality of the view (always 4).

Returns

4.

swap()

None CDPL.Math.DQuaternionVectorAdapter.swap

(

DQuaternionVectorAdapter

a

)

Swaps the components of this view with those of a.

Parameters

a	The adapter to swap with.

getData()

DQuaternionExpression CDPL.Math.DQuaternionVectorAdapter.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.DQuaternionVectorAdapter.__eq__

(

DQuaternionVectorAdapter

a

)

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

Parameters

a	The DQuaternionVectorAdapter instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.DQuaternionVectorAdapter.__eq__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.DQuaternionVectorAdapter.__ne__

(

DQuaternionVectorAdapter

a

)

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

Parameters

a	The DQuaternionVectorAdapter instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.DQuaternionVectorAdapter.__ne__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

float CDPL.Math.DQuaternionVectorAdapter.__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__()

float CDPL.Math.DQuaternionVectorAdapter.__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.DQuaternionVectorAdapter.__len__

(

)

Returns the dimensionality of the view (always 4).

Returns

4.

__str__()

str CDPL.Math.DQuaternionVectorAdapter.__str__

(

)

Returns a string representation of the DQuaternionVectorAdapter instance.

Returns

The generated string representation.

__add__()

ConstDVectorExpression CDPL.Math.DQuaternionVectorAdapter.__add__

(

ConstDVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstDVectorExpression instance holding the result of the addition.

__sub__()

ConstDVectorExpression CDPL.Math.DQuaternionVectorAdapter.__sub__

(

ConstDVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A DQuaternionVectorAdapter instance holding the result of the subtraction.

__mul__() [1/2]

ConstDVectorExpression CDPL.Math.DQuaternionVectorAdapter.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstDVectorExpression CDPL.Math.DQuaternionVectorAdapter.__mul__

(

ConstDMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__div__()

ConstDVectorExpression CDPL.Math.DQuaternionVectorAdapter.__div__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__truediv__()

ConstDVectorExpression CDPL.Math.DQuaternionVectorAdapter.__truediv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__rmul__()

ConstDVectorExpression CDPL.Math.DQuaternionVectorAdapter.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__iadd__() [1/2]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.__iadd__

(

DQuaternionVectorAdapter

a

)

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

Parameters

a	Specifies the second addend.

Returns

The updated DQuaternionVectorAdapter instance self.

__iadd__() [2/2]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.__iadd__

(

ConstDVectorExpression

e

)

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns

self

__isub__() [1/2]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.__isub__

(

DQuaternionVectorAdapter

a

)

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

Parameters

a	Specifies the subtrahend.

Returns

The updated DQuaternionVectorAdapter instance self.

__isub__() [2/2]

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.__isub__

(

ConstDVectorExpression

e

)

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns

self

__imul__()

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.__imul__

(

float

t

)

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__idiv__()

DQuaternionVectorAdapter CDPL.Math.DQuaternionVectorAdapter.__idiv__

(

float

t

)

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns

self