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

Inheritance diagram for CDPL.Math.ConstLVectorExpression:

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

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

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

bool	__eq__ (ConstLVectorExpression e)
	Returns the result of the comparison operation `self == e`. More...

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

int	__call__ (int i)
	Returns the element at index i. More...

int	__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 `ConstLVectorExpression` instance. More...

ConstLVectorExpression	__pos__ ()
	Returns self. More...

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

ConstLVectorExpression	__add__ (ConstLVectorExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstLVectorExpression	__sub__ (ConstLVectorExpression e)
	Returns the result of the subtraction operation `self - e`. More...

ConstLVectorExpression	__mul__ (int t)
	Returns the result of the multiplication operation `self * t`. More...

ConstLVectorExpression	__mul__ (ConstLMatrixExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstLVectorExpression	__div__ (int t)
	Returns the result of the division operation `self // t`. More...

ConstLVectorExpression	__truediv__ (int t)
	Returns the result of the true division operation `self / t`. More...

ConstLVectorExpression	__rmul__ (int 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.ConstLVectorExpression.getObjectID ( )

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

Different Python ConstLVectorExpression 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 ConstLVectorExpression 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.ConstLVectorExpression.isEmpty ( )

Tells whether the vector is empty.

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

◆ getSize()

int CDPL.Math.ConstLVectorExpression.getSize ( )

Returns the current element count.

Returns: The number of elements.

◆ getElement()

int CDPL.Math.ConstLVectorExpression.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.ConstLVectorExpression.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ eq()

bool CDPL.Math.ConstLVectorExpression.__eq__ ( ConstLVectorExpression e )

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

Parameters

e	The `ConstLVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne()

bool CDPL.Math.ConstLVectorExpression.__ne__ ( ConstLVectorExpression e )

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

Parameters

e	The `ConstLVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ call()

int CDPL.Math.ConstLVectorExpression.__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()

int CDPL.Math.ConstLVectorExpression.__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.ConstLVectorExpression.__len__ ( )

Returns the current element count.

Returns: The number of elements.

◆ str()

str CDPL.Math.ConstLVectorExpression.__str__ ( )

Returns a string representation of the ConstLVectorExpression instance.

Returns: The generated string representation.

◆ pos()

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__add__ ( ConstLVectorExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns: A ConstLVectorExpression instance holding the result of the addition.

◆ sub()

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__sub__ ( ConstLVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A ConstLVectorExpression instance holding the result of the multiplication.

◆ mul() [2/2]

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__mul__ ( ConstLMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstLVectorExpression instance holding the result of the multiplication.

◆ div()

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

Returns: A ConstLVectorExpression instance holding the result of the division.

◆ truediv()

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

Returns: A ConstLVectorExpression instance holding the result of the division.

◆ rmul()

ConstLVectorExpression CDPL.Math.ConstLVectorExpression.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstLVectorExpression 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()