General 4-component quaternion with component values of type unsigned long. More...

Inheritance diagram for CDPL.Math.ULQuaternion:

Public Member Functions
None	__init__ ()
	Constructs an uninitialized quaternion.

None	__init__ (ULQuaternion q)
	Constructs a copy of the quaternion q. More...

None	__init__ (int c1, int c2=0, int c3=0, int c4=0)
	Constructs the quaternion with the supplied component values. More...

None	__init__ (ConstFQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (ConstDQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (ConstLQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (ConstULQuaternionExpression e)
	Constructs the quaternion from the quaternion expression e. More...

None	__init__ (object a)
	Constructs the quaternion from the `numpy.ndarray` object a. More...

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

ULQuaternion	assign (ConstFQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	assign (ConstDQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	assign (ConstLQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	assign (ConstULQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	assign (ULQuaternion q)
	Copy-assigns the components of q to this quaternion. More...

None	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this quaternion. 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 `ULQuaternion` instance into a corresponding `numpy.ndarray` object. More...

None	swap (ULQuaternion q)
	Swaps the four components of this quaternion with those of q. 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...

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

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

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

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

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

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

ULQuaternion	__iadd__ (int t)
	Adds the scalar t to the real component. More...

ULQuaternion	__iadd__ (ULQuaternion q)
	Adds the quaternion q to this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	__iadd__ (ConstULQuaternionExpression e)
	Adds the quaternion expression e to this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	__isub__ (int t)
	Subtracts the scalar t from the real component. More...

ULQuaternion	__isub__ (ULQuaternion q)
	Subtracts the quaternion q from this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	__isub__ (ConstULQuaternionExpression e)
	Subtracts the quaternion expression e from this quaternion (via a temporary to handle aliasing). More...

ULQuaternion	__imul__ (int t)
	Multiplies every component by the scalar t. More...

ULQuaternion	__imul__ (ULQuaternion q)
	Right-multiplies this quaternion by the quaternion q (Hamilton product, via a temporary). More...

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

ULQuaternion	__idiv__ (int t)
	Divides every component by the scalar t. More...

ULQuaternion	__idiv__ (ULQuaternion q)
	Right-divides this quaternion by the quaternion q (Hamilton-product inverse, via a temporary). More...

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

ULQuaternion	__itruediv__ (int t)
	Divides every component by the scalar t. More...

ULQuaternion	__itruediv__ (ULQuaternion q)
	Right-divides this quaternion by the quaternion q (Hamilton-product inverse, via a temporary). More...

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

Properties
	objectID = property(getObjectID)

Detailed Description

General 4-component quaternion with component values of type unsigned long.

Constructor & Destructor Documentation

◆ init() [1/7]

None CDPL.Math.ULQuaternion.__init__ ( ULQuaternion q )

Constructs a copy of the quaternion q.

Parameters

q	The quaternion to copy.

◆ init() [2/7]

None CDPL.Math.ULQuaternion.__init__	(	int	c1,
		int	c2 = `0`,
		int	c3 = `0`,
		int	c4 = `0`
	)

Constructs the quaternion with the supplied component values.

Parameters

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

◆ init() [3/7]

None CDPL.Math.ULQuaternion.__init__ ( ConstFQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [4/7]

None CDPL.Math.ULQuaternion.__init__ ( ConstDQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [5/7]

None CDPL.Math.ULQuaternion.__init__ ( ConstLQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [6/7]

None CDPL.Math.ULQuaternion.__init__ ( ConstULQuaternionExpression e )

Constructs the quaternion from the quaternion expression e.

Parameters

e	The quaternion expression to materialize.

◆ init() [7/7]

None CDPL.Math.ULQuaternion.__init__ ( object a )

Constructs the quaternion from the numpy.ndarray object a.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ULQuaternion.getObjectID ( )

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

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

ULQuaternion CDPL.Math.ULQuaternion.assign ( ConstFQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [2/6]

ULQuaternion CDPL.Math.ULQuaternion.assign ( ConstDQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [3/6]

ULQuaternion CDPL.Math.ULQuaternion.assign ( ConstLQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [4/6]

ULQuaternion CDPL.Math.ULQuaternion.assign ( ConstULQuaternionExpression e )

Assigns the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ assign() [5/6]

ULQuaternion CDPL.Math.ULQuaternion.assign ( ULQuaternion q )

Copy-assigns the components of q to this quaternion.

Parameters

q	The source quaternion.

Returns: self.

◆ assign() [6/6]

None CDPL.Math.ULQuaternion.assign ( object a )

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

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ getC1()

int CDPL.Math.ULQuaternion.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

int CDPL.Math.ULQuaternion.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

int CDPL.Math.ULQuaternion.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

int CDPL.Math.ULQuaternion.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.ULQuaternion.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.ULQuaternion.swap ( ULQuaternion q )

Swaps the four components of this quaternion with those of q.

Parameters

q	The quaternion to swap with.

◆ setC1()

None CDPL.Math.ULQuaternion.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.ULQuaternion.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.ULQuaternion.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.ULQuaternion.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.ULQuaternion.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.

◆ eq() [1/2]

bool CDPL.Math.ULQuaternion.__eq__ ( ULQuaternion q )

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

Parameters

q	The `ULQuaternion` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

q	The `ULQuaternion` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the ULQuaternion instance.

Returns: The generated string representation.

◆ pos()

ULQuaternion CDPL.Math.ULQuaternion.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

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

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

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

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__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.ULQuaternion.__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.ULQuaternion.__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.ULQuaternion.__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.ULQuaternion.__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.ULQuaternion.__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.ULQuaternion.__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.

◆ iadd() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__iadd__ ( int t )

Adds the scalar t to the real component.

Parameters

t	The scalar addend.

Returns: self.

◆ iadd() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__iadd__ ( ULQuaternion q )

Adds the quaternion q to this quaternion (via a temporary to handle aliasing).

Parameters

q	The source quaternion.

Returns: self.

◆ iadd() [3/3]

ULQuaternion CDPL.Math.ULQuaternion.__iadd__ ( ConstULQuaternionExpression e )

Adds the quaternion expression e to this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ isub() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__isub__ ( int t )

Subtracts the scalar t from the real component.

Parameters

t	The scalar subtrahend.

Returns: self.

◆ isub() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__isub__ ( ULQuaternion q )

Subtracts the quaternion q from this quaternion (via a temporary to handle aliasing).

Parameters

q	The source quaternion.

Returns: self.

◆ isub() [3/3]

ULQuaternion CDPL.Math.ULQuaternion.__isub__ ( ConstULQuaternionExpression e )

Subtracts the quaternion expression e from this quaternion (via a temporary to handle aliasing).

Parameters

e	The source quaternion expression.

Returns: self.

◆ imul() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__imul__ ( int t )

Multiplies every component by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ imul() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__imul__ ( ULQuaternion q )

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

Parameters

q	The right-hand quaternion.

Returns: self.

◆ imul() [3/3]

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

ULQuaternion CDPL.Math.ULQuaternion.__idiv__ ( int t )

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ idiv() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__idiv__ ( ULQuaternion q )

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

Parameters

q	The right-hand quaternion.

Returns: self.

◆ idiv() [3/3]

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

ULQuaternion CDPL.Math.ULQuaternion.__itruediv__ ( int t )

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__itruediv__ ( ULQuaternion q )

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

Parameters

q	The right-hand quaternion.

Returns: self.

◆ itruediv() [3/3]

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/7]

◆ __init__() [2/7]

◆ __init__() [3/7]

◆ __init__() [4/7]

◆ __init__() [5/7]

◆ __init__() [6/7]

◆ __init__() [7/7]

Member Function Documentation

◆ getObjectID()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ getC1()

◆ getC2()

◆ getC3()

◆ getC4()

◆ toArray()

◆ swap()

◆ setC1()

◆ setC2()

◆ setC3()

◆ setC4()

◆ set()

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

◆ __iadd__() [1/3]

◆ __iadd__() [2/3]

◆ __iadd__() [3/3]

◆ __isub__() [1/3]

◆ __isub__() [2/3]

◆ __isub__() [3/3]

◆ __imul__() [1/3]

◆ __imul__() [2/3]

◆ __imul__() [3/3]

◆ __idiv__() [1/3]

◆ __idiv__() [2/3]

◆ __idiv__() [3/3]

◆ __itruediv__() [1/3]

◆ __itruediv__() [2/3]

◆ __itruediv__() [3/3]

◆ init() [1/7]

◆ init() [2/7]

◆ init() [3/7]

◆ init() [4/7]

◆ init() [5/7]

◆ init() [6/7]

◆ init() [7/7]

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

◆ iadd() [1/3]

◆ iadd() [2/3]

◆ iadd() [3/3]

◆ isub() [1/3]

◆ isub() [2/3]

◆ isub() [3/3]

◆ imul() [1/3]

◆ imul() [2/3]

◆ imul() [3/3]

◆ idiv() [1/3]

◆ idiv() [2/3]

◆ idiv() [3/3]

◆ itruediv() [1/3]

◆ itruediv() [2/3]

◆ itruediv() [3/3]