Represents the outcome of mathematical expressions/operations that result in a vector. 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 ()
	Tells whether the vector is empty. More...

int	getSize ()
	Returns the current element count. More...

float	getElement (int i)
	Returns the element at index i. More...

object	toArray ()
	Converts the `ConstDVectorExpression` instance into a corresponding `numpy.ndarray` object. More...

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)
	Returns the element at index i. More...

float	__getitem__ (int i)
	Returns the element at index i. More...

int	__len__ ()
	Returns the current element count. More...

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

ConstDVectorExpression	__pos__ ()
	Returns self. More...

ConstDVectorExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

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

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

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.

◆ isEmpty()

bool CDPL.Math.ConstDVectorExpression.isEmpty ( )

Tells whether the vector is empty.

Returns: True if the vector contains no elements, and False otherwise.

◆ getSize()

int CDPL.Math.ConstDVectorExpression.getSize ( )

Returns the current element count.

Returns: The number of elements.

◆ getElement()

float CDPL.Math.ConstDVectorExpression.getElement ( int i )

Returns the element at index i.

Parameters

i	The zero-based element index.

Returns: The value of the element.

Exceptions

Base.IndexError if i is out of range.

◆ toArray()

object CDPL.Math.ConstDVectorExpression.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ 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.

◆ call()

float CDPL.Math.ConstDVectorExpression.__call__ ( int i )

Returns the element at index i.

Parameters

i	The zero-based element index.

Returns: The value of the element.

Exceptions

Base.IndexError if i is out of range.

◆ getitem()

float CDPL.Math.ConstDVectorExpression.__getitem__ ( int i )

Returns the element at index i.

Parameters

i	The zero-based element index.

Returns: The value of the element.

Exceptions

Base.IndexError if i is out of range.

◆ len()

int CDPL.Math.ConstDVectorExpression.__len__ ( )

Returns the current element count.

Returns: The number of elements.

◆ str()

str CDPL.Math.ConstDVectorExpression.__str__ ( )

Returns a string representation of the ConstDVectorExpression instance.

Returns: The generated string representation.

◆ pos()

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstDVectorExpression CDPL.Math.ConstDVectorExpression.__neg__ ( )

Returns the result of the operation self * -1.

Returns: A ConstDVectorExpression instance holding the result of the element negation.

◆ 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.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ getObjectID()

◆ isEmpty()

◆ getSize()

◆ getElement()

◆ toArray()

◆ __eq__()

◆ __ne__()

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ eq()

◆ ne()

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()