CDPL.Math.ULQuaternionExpression Class Reference

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

Inheritance diagram for CDPL.Math.ULQuaternionExpression:

Public Member Functions
None	swap (ULQuaternionExpression e)
	Swaps the four components of this quaternion expression with those of e. More...
ULQuaternionExpression	assign (ULQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
ULQuaternionExpression	assign (ConstFQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
ULQuaternionExpression	assign (ConstDQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
ULQuaternionExpression	assign (ConstLQuaternionExpression e)
	Assigns the contents of the quaternion expression e to this expression. More...
ULQuaternionExpression	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 (int v)
	Sets the value of the real component C1 to v. More...
None	setC2 (int v)
	Sets the value of the imaginary component C2 to v. More...
None	setC3 (int v)
	Sets the value of the imaginary component C3 to v. More...
None	setC4 (int v)
	Sets the value of the imaginary component C4 to v. More...
None	set (int c1=0, int c2=0, int c3=0, int c4=0)
	Sets the four quaternion components to the supplied values. More...
ULQuaternionExpression	__iadd__ (int t)
	Adds the scalar t to the real component. More...
ULQuaternionExpression	__iadd__ (ULQuaternionExpression e)
	Adds the quaternion expression e to this expression. More...
ULQuaternionExpression	__iadd__ (ConstULQuaternionExpression e)
	Adds the quaternion expression e to this expression. More...
ULQuaternionExpression	__isub__ (int t)
	Subtracts the scalar t from the real component. More...
ULQuaternionExpression	__isub__ (ULQuaternionExpression e)
	Subtracts the quaternion expression e from this expression. More...
ULQuaternionExpression	__isub__ (ConstULQuaternionExpression e)
	Subtracts the quaternion expression e from this expression. More...
ULQuaternionExpression	__imul__ (int t)
	Multiplies every component by the scalar t. More...
ULQuaternionExpression	__imul__ (ULQuaternionExpression e)
	Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary). More...
ULQuaternionExpression	__imul__ (ConstULQuaternionExpression e)
	Right-multiplies this quaternion by the quaternion expression e (Hamilton product, via a temporary). More...
ULQuaternionExpression	__idiv__ (int t)
	Divides every component by the scalar t. More...
ULQuaternionExpression	__idiv__ (ULQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
ULQuaternionExpression	__idiv__ (ConstULQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
ULQuaternionExpression	__itruediv__ (int t)
	Divides every component by the scalar t. More...
ULQuaternionExpression	__itruediv__ (ULQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
ULQuaternionExpression	__itruediv__ (ConstULQuaternionExpression e)
	Right-divides this quaternion by the quaternion expression e (Hamilton-product inverse, via a temporary). More...
Public Member Functions inherited from CDPL.Math.ConstULQuaternionExpression
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 ConstULQuaternionExpression instance into a corresponding numpy.ndarray object. More...
bool	__eq__ (ConstULQuaternionExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (ConstULQuaternionExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the ConstULQuaternionExpression instance. More...
ConstULQuaternionExpression	__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...

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

Detailed Description

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

Member Function Documentation

swap()

None CDPL.Math.ULQuaternionExpression.swap

(

ULQuaternionExpression

e

)

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

Parameters

e	The quaternion expression to swap with.

assign() [1/6]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.assign

(

ULQuaternionExpression

e

)

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

Parameters

e	The source quaternion expression.

Returns

self.

assign() [2/6]

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

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

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

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.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.ULQuaternionExpression.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.ULQuaternionExpression.setC1

(

int

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.ULQuaternionExpression.setC2

(

int

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.ULQuaternionExpression.setC3

(

int

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.ULQuaternionExpression.setC4

(

int

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.ULQuaternionExpression.set	(	int	c1 = 0,
		int	c2 = 0,
		int	c3 = 0,
		int	c4 = 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]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__iadd__

(

int

t

)

Adds the scalar t to the real component.

Parameters

t	The scalar addend.

Returns

self.

__iadd__() [2/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__iadd__

(

ULQuaternionExpression

e

)

Adds the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__iadd__() [3/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__iadd__

(

ConstULQuaternionExpression

e

)

Adds the quaternion expression e to this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__isub__() [1/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__isub__

(

int

t

)

Subtracts the scalar t from the real component.

Parameters

t	The scalar subtrahend.

Returns

self.

__isub__() [2/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__isub__

(

ULQuaternionExpression

e

)

Subtracts the quaternion expression e from this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__isub__() [3/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__isub__

(

ConstULQuaternionExpression

e

)

Subtracts the quaternion expression e from this expression.

Parameters

e	The source quaternion expression.

Returns

self.

__imul__() [1/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__imul__

(

int

t

)

Multiplies every component by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self.

__imul__() [2/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__imul__

(

ULQuaternionExpression

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]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__imul__

(

ConstULQuaternionExpression

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]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__idiv__

(

int

t

)

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.

__idiv__() [2/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__idiv__

(

ULQuaternionExpression

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]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__idiv__

(

ConstULQuaternionExpression

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]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__itruediv__

(

int

t

)

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.

__itruediv__() [2/3]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__itruediv__

(

ULQuaternionExpression

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]

ULQuaternionExpression CDPL.Math.ULQuaternionExpression.__itruediv__

(

ConstULQuaternionExpression

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.