CDPL.Math.FUnitVector Class Reference

Inheritance diagram for CDPL.Math.FUnitVector:

Public Member Functions
None	__init__ ()
	Initializes the FUnitVector instance.
None	__init__ (FUnitVector v)
	Initializes a copy of the FUnitVector instance v. More...
None	__init__ (int n, int i)
	Initializes the FUnitVector instance. More...
None	resize (int n)
int	getIndex ()
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
bool	isEmpty ()
int	getSize ()
float	getElement (int i)
object	toArray ()
FUnitVector	assign (FUnitVector v)
	Replaces the current state of self with a copy of the state of the FUnitVector instance v. More...
None	swap (FUnitVector v)
bool	__eq__ (FUnitVector v)
	Returns the result of the comparison operation self == v. More...
bool	__eq__ (ConstFVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (FUnitVector v)
	Returns the result of the comparison operation self != v. More...
bool	__ne__ (ConstFVectorExpression e)
	Returns the result of the comparison operation self != e. More...
float	__call__ (int i)
float	__getitem__ (int i)
int	__len__ ()
str	__str__ ()
	Returns a string representation of the FUnitVector instance. More...
FUnitVector	__pos__ ()
ConstFVectorExpression	__neg__ ()
ConstFVectorExpression	__add__ (ConstFVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstFVectorExpression	__sub__ (ConstFVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstFVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstFVectorExpression	__mul__ (ConstFMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstFVectorExpression	__div__ (float t)
	Returns the result of the division operation self / t. More...
ConstFVectorExpression	__truediv__ (float t)
ConstFVectorExpression	__rmul__ (float t)

Properties
	index = property(getIndex)
	objectID = property(getObjectID)
	size = property(getSize)

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.FUnitVector.__init__

(

FUnitVector

v

)

Initializes a copy of the FUnitVector instance v.

Parameters

v	The FUnitVector instance to copy.

__init__() [2/2]

None CDPL.Math.FUnitVector.__init__	(	int	n,
		int	i
	)

Initializes the FUnitVector instance.

Parameters

n
i

Member Function Documentation

resize()

None CDPL.Math.FUnitVector.resize

(

int

n

)

Parameters

n

getIndex()

int CDPL.Math.FUnitVector.getIndex

(

)

Parameters

arg1

Returns

getObjectID()

int CDPL.Math.FUnitVector.getObjectID

(

)

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

Different Python FUnitVector 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 FUnitVector 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.

isEmpty()

bool CDPL.Math.FUnitVector.isEmpty

(

)

Returns

getSize()

int CDPL.Math.FUnitVector.getSize

(

)

Returns

getElement()

float CDPL.Math.FUnitVector.getElement

(

int

i

)

Parameters

i

Returns

toArray()

object CDPL.Math.FUnitVector.toArray

(

)

Returns

assign()

FUnitVector CDPL.Math.FUnitVector.assign

(

FUnitVector

v

)

Replaces the current state of self with a copy of the state of the FUnitVector instance v.

Parameters

v	The FUnitVector instance to copy.

Returns

self

swap()

None CDPL.Math.FUnitVector.swap

(

FUnitVector

v

)

Parameters

v

__eq__() [1/2]

bool CDPL.Math.FUnitVector.__eq__

(

FUnitVector

v

)

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

Parameters

v	The FUnitVector instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.FUnitVector.__eq__

(

ConstFVectorExpression

e

)

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

Parameters

e	The ConstFVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.FUnitVector.__ne__

(

FUnitVector

v

)

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

Parameters

v	The FUnitVector instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.FUnitVector.__ne__

(

ConstFVectorExpression

e

)

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

Parameters

e	The ConstFVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

float CDPL.Math.FUnitVector.__call__

(

int

i

)

Parameters

i

Returns

__getitem__()

float CDPL.Math.FUnitVector.__getitem__

(

int

i

)

Parameters

i

Returns

__len__()

int CDPL.Math.FUnitVector.__len__

(

)

Returns

__str__()

str CDPL.Math.FUnitVector.__str__

(

)

Returns a string representation of the FUnitVector instance.

Returns

The generated string representation.

__pos__()

FUnitVector CDPL.Math.FUnitVector.__pos__

(

)

Returns

__neg__()

ConstFVectorExpression CDPL.Math.FUnitVector.__neg__

(

)

Returns

__add__()

ConstFVectorExpression CDPL.Math.FUnitVector.__add__

(

ConstFVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstFVectorExpression instance holding the result of the addition.

__sub__()

ConstFVectorExpression CDPL.Math.FUnitVector.__sub__

(

ConstFVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A FUnitVector instance holding the result of the subtraction.

__mul__() [1/2]

ConstFVectorExpression CDPL.Math.FUnitVector.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstFVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstFVectorExpression CDPL.Math.FUnitVector.__mul__

(

ConstFMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstFVectorExpression instance holding the result of the multiplication.

__div__()

ConstFVectorExpression CDPL.Math.FUnitVector.__div__

(

float

t

)

Returns the result of the division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstFVectorExpression instance holding the result of the division.

__truediv__()

ConstFVectorExpression CDPL.Math.FUnitVector.__truediv__

(

float

t

)

Parameters

t

Returns

__rmul__()

ConstFVectorExpression CDPL.Math.FUnitVector.__rmul__

(

float

t

)

Parameters

t

Returns