CDPL.Math.FQuaternionExpression Class Reference

Represents the outcome of mathematical expressions/operations that result in a quaternion. More...

Inheritance diagram for CDPL.Math.FQuaternionExpression:

Public Member Functions
None	swap (FQuaternionExpression e)
	Swaps the four components of this quaternion expression with those of e. More...
FQuaternionExpression	assign (FQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
FQuaternionExpression	assign (ConstFQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
FQuaternionExpression	assign (ConstDQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
FQuaternionExpression	assign (ConstLQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
FQuaternionExpression	assign (ConstULQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
None	assign (object a)
	Assigns the contents of the numpy.ndarray object a to this quaternion expression. More...
None	setC1 (float v)
	Sets the value of the real component C1 to v. More...
None	setC2 (float v)
	Sets the value of the imaginary component C2 to v. More...
None	setC3 (float v)
	Sets the value of the imaginary component C3 to v. More...
None	setC4 (float v)
	Sets the value of the imaginary component C4 to v. More...
None	set (float c1=0.0, float c2=0.0, float c3=0.0, float c4=0.0)
	Sets the four quaternion components to the supplied values. More...
FQuaternionExpression	__iadd__ (float t)
	Adds the scalar t to the real component. More...
FQuaternionExpression	__iadd__ (FQuaternionExpression e)
	Adds the quaternion expression e to this expression. More...
FQuaternionExpression	__iadd__ (ConstFQuaternionExpression e)
	Adds the quaternion expression e to this expression. More...
FQuaternionExpression	__isub__ (float t)
	Subtracts the scalar t from the real component. More...
FQuaternionExpression	__isub__ (FQuaternionExpression e)
	Subtracts the quaternion expression e from this expression. More...
FQuaternionExpression	__isub__ (ConstFQuaternionExpression e)
	Subtracts the quaternion expression e from this expression. More...
FQuaternionExpression	__imul__ (float t)
	Multiplies every component by the scalar t. More...
FQuaternionExpression	__imul__ (FQuaternionExpression e)
	Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary). More...
FQuaternionExpression	__imul__ (ConstFQuaternionExpression e)
	Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary). More...
FQuaternionExpression	__idiv__ (float t)
	Divides every component by the scalar t. More...
FQuaternionExpression	__idiv__ (FQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
FQuaternionExpression	__idiv__ (ConstFQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
FQuaternionExpression	__itruediv__ (float t)
	Divides every component by the scalar t. More...
FQuaternionExpression	__itruediv__ (FQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
FQuaternionExpression	__itruediv__ (ConstFQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
Public Member Functions inherited from CDPL.Math.ConstFQuaternionExpression
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
float	getC1 ()
	Returns the real component C1. More...
float	getC2 ()
	Returns the imaginary component C2. More...
float	getC3 ()
	Returns the imaginary component C3. More...
float	getC4 ()
	Returns the imaginary component C4. More...
object	toArray ()
	Converts the ConstFQuaternionExpression instance into a corresponding numpy.ndarray object. More...
bool	__eq__ (ConstFQuaternionExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (ConstFQuaternionExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the ConstFQuaternionExpression instance. More...
ConstFQuaternionExpression	__pos__ ()
	Returns self. More...
ConstFQuaternionExpression	__neg__ ()
	Returns the result of the operation self * -1. More...
ConstFQuaternionExpression	__add__ (float t)
	Returns the result of the addition operation self + t. More...
ConstFQuaternionExpression	__add__ (ConstFQuaternionExpression e)
	Returns the result of the addition operation self + e. More...
ConstFQuaternionExpression	__radd__ (float t)
	Returns the result of the addition operation t + self. More...
ConstFQuaternionExpression	__sub__ (float t)
	Returns the result of the subtraction operation self - t. More...
ConstFQuaternionExpression	__sub__ (ConstFQuaternionExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstFQuaternionExpression	__rsub__ (float t)
	Returns the result of the subtraction operation t - self. More...
ConstFQuaternionExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstFQuaternionExpression	__mul__ (ConstFQuaternionExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstFQuaternionExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. More...
ConstFQuaternionExpression	__div__ (float t)
	Returns the result of the division operation self // t. More...
ConstFQuaternionExpression	__div__ (ConstFQuaternionExpression e)
	Returns the result of the division operation self // e. More...
ConstFQuaternionExpression	__truediv__ (float t)
	Returns the result of the true division operation self / t. More...
ConstFQuaternionExpression	__rdiv__ (float t)
	Returns the result of the division operation t // self. More...

Additional Inherited Members
Properties inherited from CDPL.Math.ConstFQuaternionExpression
	objectID = property(getObjectID)

Detailed Description

Represents the outcome of mathematical expressions/operations that result in a quaternion.

Member Function Documentation

swap()

None CDPL.Math.FQuaternionExpression.swap

(

FQuaternionExpression

e

)

Swaps the four components of this quaternion expression with those of e.

Parameters

e	The quaternion expression to swap with.

assign() [1/6]

FQuaternionExpression CDPL.Math.FQuaternionExpression.assign

(

FQuaternionExpression

e

)

Assigns the contents of the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

assign() [2/6]

FQuaternionExpression CDPL.Math.FQuaternionExpression.assign

(

ConstFQuaternionExpression

e

)

Assigns the contents of the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

assign() [3/6]

FQuaternionExpression CDPL.Math.FQuaternionExpression.assign

(

ConstDQuaternionExpression

e

)

Assigns the contents of the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

assign() [4/6]

FQuaternionExpression CDPL.Math.FQuaternionExpression.assign

(

ConstLQuaternionExpression

e

)

Assigns the contents of the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

assign() [5/6]

FQuaternionExpression CDPL.Math.FQuaternionExpression.assign

(

ConstULQuaternionExpression

e

)

Assigns the contents of the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

assign() [6/6]

None CDPL.Math.FQuaternionExpression.assign

(

object

a

)

Assigns the contents of the numpy.ndarray object a to this quaternion expression.

Parameters

a	The numpy.ndarray object.

See also

[NUMPY]

setC1()

None CDPL.Math.FQuaternionExpression.setC1

(

float

v

)

Sets the value of the real component C1 to v.

Parameters

v	The new value of the real component C1.

setC2()

None CDPL.Math.FQuaternionExpression.setC2

(

float

v

)

Sets the value of the imaginary component C2 to v.

Parameters

v	The new value of the imaginary component C2.

setC3()

None CDPL.Math.FQuaternionExpression.setC3

(

float

v

)

Sets the value of the imaginary component C3 to v.

Parameters

v	The new value of the imaginary component C3.

setC4()

None CDPL.Math.FQuaternionExpression.setC4

(

float

v

)

Sets the value of the imaginary component C4 to v.

Parameters

v	The new value of the imaginary component C4.

set()

None CDPL.Math.FQuaternionExpression.set	(	float	c1 = 0.0,
		float	c2 = 0.0,
		float	c3 = 0.0,
		float	c4 = 0.0
	)

Sets the four quaternion components to the supplied values.

Parameters

c1	The new real component.
c2	The new first imaginary component.
c3	The new second imaginary component.
c4	The new third imaginary component.

__iadd__() [1/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__iadd__

(

float

t

)

Adds the scalar t to the real component.

Parameters

t	The scalar addend.

Returns

self.

__iadd__() [2/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__iadd__

(

FQuaternionExpression

e

)

Adds the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__iadd__() [3/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__iadd__

(

ConstFQuaternionExpression

e

)

Adds the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__isub__() [1/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__isub__

(

float

t

)

Subtracts the scalar t from the real component.

Parameters

t	The scalar subtrahend.

Returns

self.

__isub__() [2/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__isub__

(

FQuaternionExpression

e

)

Subtracts the quaternion expression e from this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__isub__() [3/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__isub__

(

ConstFQuaternionExpression

e

)

Subtracts the quaternion expression e from this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__imul__() [1/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__imul__

(

float

t

)

Multiplies every component by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self.

__imul__() [2/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__imul__

(

FQuaternionExpression

e

)

Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns

self.

__imul__() [3/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__imul__

(

ConstFQuaternionExpression

e

)

Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns

self.

__idiv__() [1/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__idiv__

(

float

t

)

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.

__idiv__() [2/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__idiv__

(

FQuaternionExpression

e

)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns

self.

__idiv__() [3/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__idiv__

(

ConstFQuaternionExpression

e

)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns

self.

__itruediv__() [1/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__itruediv__

(

float

t

)

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.

__itruediv__() [2/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__itruediv__

(

FQuaternionExpression

e

)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns

self.

__itruediv__() [3/3]

FQuaternionExpression CDPL.Math.FQuaternionExpression.__itruediv__

(

ConstFQuaternionExpression

e

)

Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary).

Parameters

e	The right-hand quaternion expression.

Returns

self.