CDPL.Math.LQuaternion Class Reference

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

Inheritance diagram for CDPL.Math.LQuaternion:

Public Member Functions
None	__init__ ()
	Constructs an uninitialized quaternion.
None	__init__ (LQuaternion 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 (omitted components default to the value-initialized ValueType). More...
None	__init__ (ConstFQuaternionExpression e)
	Initializes the LQuaternion instance. More...
None	__init__ (ConstDQuaternionExpression e)
	Initializes the LQuaternion instance. More...
None	__init__ (ConstLQuaternionExpression e)
	Initializes the LQuaternion instance. More...
None	__init__ (ConstULQuaternionExpression e)
	Initializes the LQuaternion instance. More...
None	__init__ (object a)
	Initializes the LQuaternion instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
LQuaternion	assign (ConstFQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
LQuaternion	assign (ConstDQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
LQuaternion	assign (ConstLQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
LQuaternion	assign (ConstULQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
LQuaternion	assign (LQuaternion q)
	Copy-assigns the components of q to this quaternion. More...
None	assign (object a)
	Replaces the current state of self with a copy of the state of the object instance a. More...
int	getC1 ()
	Returns a reference to the real component C1. More...
int	getC2 ()
	Returns a reference to the imaginary component C2. More...
int	getC3 ()
	Returns a reference to the imaginary component C3. More...
int	getC4 ()
	Returns a reference to the imaginary component C4. More...
object	toArray ()
None	swap (LQuaternion q)
	Swaps the four components of this quaternion with those of q. More...
None	setC1 (int v)
None	setC2 (int v)
None	setC3 (int v)
None	setC4 (int v)
None	set (int c1=0, int c2=0, int c3=0, int c4=0)
	Sets the four quaternion components to the supplied values (omitted arguments default to the value-initialized ValueType). More...
bool	__eq__ (LQuaternion q)
	Returns the result of the comparison operation self == q. More...
bool	__eq__ (ConstLQuaternionExpression q)
	Returns the result of the comparison operation self == q. More...
bool	__ne__ (LQuaternion q)
	Returns the result of the comparison operation self != q. More...
bool	__ne__ (ConstLQuaternionExpression q)
	Returns the result of the comparison operation self != q. More...
str	__str__ ()
	Returns a string representation of the LQuaternion instance. More...
LQuaternion	__pos__ ()
ConstLQuaternionExpression	__neg__ ()
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)
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)
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)
LQuaternion	__iadd__ (int t)
	Adds the scalar t to the real component. More...
LQuaternion	__iadd__ (LQuaternion q)
	Performs the in-place addition operation self += q. More...
LQuaternion	__iadd__ (ConstLQuaternionExpression q)
	Performs the in-place addition operation self += q. More...
LQuaternion	__isub__ (int t)
	Subtracts the scalar t from the real component. More...
LQuaternion	__isub__ (LQuaternion q)
	Performs the in-place subtraction operation self -= q. More...
LQuaternion	__isub__ (ConstLQuaternionExpression q)
	Performs the in-place subtraction operation self -= q. More...
LQuaternion	__imul__ (int t)
	Multiplies every component by the scalar t. More...
LQuaternion	__imul__ (LQuaternion q)
	Performs the in-place multiplication operation self *= q. More...
LQuaternion	__imul__ (ConstLQuaternionExpression q)
	Performs the in-place multiplication operation self *= q. More...
LQuaternion	__idiv__ (int t)
	Divides every component by the scalar t. More...
LQuaternion	__idiv__ (LQuaternion q)
	Performs the in-place division operation self /= q. More...
LQuaternion	__idiv__ (ConstLQuaternionExpression q)
	Performs the in-place division operation self /= q. More...
LQuaternion	__itruediv__ (int t)
LQuaternion	__itruediv__ (LQuaternion q)
LQuaternion	__itruediv__ (ConstLQuaternionExpression q)

Properties
	objectID = property(getObjectID)

Detailed Description

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

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.LQuaternion.__init__

(

LQuaternion

q

)

Constructs a copy of the quaternion q.

Parameters

q	The quaternion to copy.

__init__() [2/7]

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

Constructs the quaternion with the supplied component values (omitted components default to the value-initialized ValueType).

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.LQuaternion.__init__

(

ConstFQuaternionExpression

e

)

Initializes the LQuaternion instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.LQuaternion.__init__

(

ConstDQuaternionExpression

e

)

Initializes the LQuaternion instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.LQuaternion.__init__

(

ConstLQuaternionExpression

e

)

Initializes the LQuaternion instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.LQuaternion.__init__

(

ConstULQuaternionExpression

e

)

Initializes the LQuaternion instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.LQuaternion.__init__

(

object

a

)

Initializes the LQuaternion instance.

Parameters

a

Member Function Documentation

getObjectID()

int CDPL.Math.LQuaternion.getObjectID

(

)

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

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

LQuaternion CDPL.Math.LQuaternion.assign

(

ConstFQuaternionExpression

e

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [2/6]

LQuaternion CDPL.Math.LQuaternion.assign

(

ConstDQuaternionExpression

e

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [3/6]

LQuaternion CDPL.Math.LQuaternion.assign

(

ConstLQuaternionExpression

e

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [4/6]

LQuaternion CDPL.Math.LQuaternion.assign

(

ConstULQuaternionExpression

e

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [5/6]

LQuaternion CDPL.Math.LQuaternion.assign

(

LQuaternion

q

)

Copy-assigns the components of q to this quaternion.

Parameters

q	The source quaternion.

Returns

self

assign() [6/6]

None CDPL.Math.LQuaternion.assign

(

object

a

)

Replaces the current state of self with a copy of the state of the object instance a.

Parameters

a	The object instance to copy.

Returns

self

getC1()

int CDPL.Math.LQuaternion.getC1

(

)

Returns a reference to the real component C1.

Returns

A reference to C1.

getC2()

int CDPL.Math.LQuaternion.getC2

(

)

Returns a reference to the imaginary component C2.

Returns

A reference to C2.

getC3()

int CDPL.Math.LQuaternion.getC3

(

)

Returns a reference to the imaginary component C3.

Returns

A reference to C3.

getC4()

int CDPL.Math.LQuaternion.getC4

(

)

Returns a reference to the imaginary component C4.

Returns

A reference to C4.

swap()

None CDPL.Math.LQuaternion.swap

(

LQuaternion

q

)

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

Parameters

q	The quaternion to swap with.

set()

None CDPL.Math.LQuaternion.set	(	int	c1 = 0,
		int	c2 = 0,
		int	c3 = 0,
		int	c4 = 0
	)

Sets the four quaternion components to the supplied values (omitted arguments default to the value-initialized ValueType).

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.LQuaternion.__eq__

(

LQuaternion

q

)

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

Parameters

q	The LQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.LQuaternion.__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.LQuaternion.__ne__

(

LQuaternion

q

)

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

Parameters

q	The LQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.LQuaternion.__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.LQuaternion.__str__

(

)

Returns a string representation of the LQuaternion instance.

Returns

The generated string representation.

__add__() [1/2]

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

__sub__() [1/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__sub__

(

int

t

)

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

Returns

A LQuaternion instance holding the result of the subtraction.

__sub__() [2/2]

ConstLQuaternionExpression CDPL.Math.LQuaternion.__sub__

(

ConstLQuaternionExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A LQuaternion instance holding the result of the subtraction.

__mul__() [1/2]

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

__iadd__() [1/3]

LQuaternion CDPL.Math.LQuaternion.__iadd__

(

int

t

)

Adds the scalar t to the real component.

Parameters

t	The scalar addend.

Returns

self

__iadd__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__iadd__

(

LQuaternion

q

)

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

Parameters

q	Specifies the second addend.

Returns

The updated LQuaternion instance self.

__iadd__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__iadd__

(

ConstLQuaternionExpression

q

)

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

Parameters

q	Specifies the second addend.

Returns

The updated LQuaternion instance self.

__isub__() [1/3]

LQuaternion CDPL.Math.LQuaternion.__isub__

(

int

t

)

Subtracts the scalar t from the real component.

Parameters

t	The scalar subtrahend.

Returns

self

__isub__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__isub__

(

LQuaternion

q

)

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

Parameters

q	Specifies the subtrahend.

Returns

The updated LQuaternion instance self.

__isub__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__isub__

(

ConstLQuaternionExpression

q

)

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

Parameters

q	Specifies the subtrahend.

Returns

The updated LQuaternion instance self.

__imul__() [1/3]

LQuaternion CDPL.Math.LQuaternion.__imul__

(

int

t

)

Multiplies every component by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__imul__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__imul__

(

LQuaternion

q

)

Performs the in-place multiplication operation self *= q.

Parameters

q	Specifies the multiplier.

Returns

The updated LQuaternion instance self.

__imul__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__imul__

(

ConstLQuaternionExpression

q

)

Performs the in-place multiplication operation self *= q.

Parameters

q	Specifies the multiplier.

Returns

The updated LQuaternion instance self.

__idiv__() [1/3]

LQuaternion CDPL.Math.LQuaternion.__idiv__

(

int

t

)

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns

self

__idiv__() [2/3]

LQuaternion CDPL.Math.LQuaternion.__idiv__

(

LQuaternion

q

)

Performs the in-place division operation self /= q.

Parameters

q	Specifies the divisor.

Returns

The updated LQuaternion instance self.

__idiv__() [3/3]

LQuaternion CDPL.Math.LQuaternion.__idiv__

(

ConstLQuaternionExpression

q

)

Performs the in-place division operation self /= q.

Parameters

q	Specifies the divisor.

Returns

The updated LQuaternion instance self.