CDPL.Math.ConstDVectorExpression Class Reference

CRTP base class of all vector expression types. More...

Inheritance diagram for CDPL.Math.ConstDVectorExpression:

Public Member Functions
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
bool	isEmpty ()
int	getSize ()
float	getElement (int i)
object	toArray ()
bool	__eq__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (ConstDVectorExpression 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 ConstDVectorExpression instance. More...
ConstDVectorExpression	__pos__ ()
ConstDVectorExpression	__neg__ ()
ConstDVectorExpression	__add__ (ConstDVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstDVectorExpression	__sub__ (ConstDVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstDVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstDVectorExpression	__mul__ (ConstDMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDVectorExpression	__div__ (float t)
	Returns the result of the division operation self // t. More...
ConstDVectorExpression	__truediv__ (float t)
	Returns the result of the true division operation self / t. More...
ConstDVectorExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. More...

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

Detailed Description

CRTP base class of all vector expression types.

Provides downcast access to the concrete derived expression class instance via the function call operator.

Member Function Documentation

getObjectID()

int CDPL.Math.ConstDVectorExpression.getObjectID

(

)

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

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

__eq__()

bool CDPL.Math.ConstDVectorExpression.__eq__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__()

bool CDPL.Math.ConstDVectorExpression.__ne__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__str__()

str CDPL.Math.ConstDVectorExpression.__str__

(

)

Returns a string representation of the ConstDVectorExpression instance.

Returns

The generated string representation.

__add__()

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__add__

(

ConstDVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstDVectorExpression instance holding the result of the addition.

__sub__()

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__sub__

(

ConstDVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A ConstDVectorExpression instance holding the result of the subtraction.

__mul__() [1/2]

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__mul__

(

ConstDMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__div__()

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__div__

(

float

t

)

Returns the result of the division operation self // t.

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__truediv__()

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__truediv__

(

float

t

)

Returns the result of the true division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__rmul__()

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.