Memory-efficient immutable vector where all elements have the value zero of type float. More...

Inheritance diagram for CDPL.Math.FZeroVector:

Public Member Functions
None	__init__ ()
	Constructs an empty zero vector.

None	__init__ (FZeroVector v)
	Constructs a copy of the zero vector v. More...

None	__init__ (int n)
	Constructs a zero vector of size n. More...

None	resize (int n)
	Resizes the logical element count to n. More...

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

bool	isEmpty ()
	Tells whether the vector has zero logical size. More...

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

float	getElement (int i)
	Returns the zero element. More...

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

FZeroVector	assign (FZeroVector v)
	Copy-assigns the logical size from v. More...

None	swap (FZeroVector v)
	Swaps the logical sizes with v. More...

bool	__eq__ (FZeroVector 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__ (FZeroVector 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)
	Returns the zero element. More...

float	__getitem__ (int i)
	Returns the zero element. More...

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

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

FZeroVector	__pos__ ()
	Returns self. More...

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

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)
	Returns the result of the true division operation `self / t`. More...

ConstFVectorExpression	__rmul__ (float t)
	Returns the result of the multiplication operation `t * self`. More...

Properties
	objectID = property(getObjectID)

	size = property(getSize)

Detailed Description

Memory-efficient immutable vector where all elements have the value zero of type float.

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.FZeroVector.__init__ ( FZeroVector v )

Constructs a copy of the zero vector v.

Parameters

v	The zero vector to copy.

◆ init() [2/2]

None CDPL.Math.FZeroVector.__init__ ( int n )

Constructs a zero vector of size n.

Parameters

n	The element count.

Member Function Documentation

◆ resize()

None CDPL.Math.FZeroVector.resize ( int n )

Resizes the logical element count to n.

Parameters

n	The new element count.

◆ getObjectID()

int CDPL.Math.FZeroVector.getObjectID ( )

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

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

Tells whether the vector has zero logical size.

Returns: True if the logical size is zero, and False otherwise.

◆ getSize()

int CDPL.Math.FZeroVector.getSize ( )

Returns the logical element count.

Returns: The element count.

◆ getElement()

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

Returns the zero element.

Parameters

i	The zero-based element index.

Returns: The zero element.

Exceptions

Base.IndexError if i is out of range.

◆ toArray()

object CDPL.Math.FZeroVector.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ assign()

FZeroVector CDPL.Math.FZeroVector.assign ( FZeroVector v )

Copy-assigns the logical size from v.

Parameters

v	The source zero vector.

Returns: self.

◆ swap()

None CDPL.Math.FZeroVector.swap ( FZeroVector v )

Swaps the logical sizes with v.

Parameters

v	The zero vector to swap with.

◆ eq() [1/2]

bool CDPL.Math.FZeroVector.__eq__ ( FZeroVector v )

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

Parameters

v	The `FZeroVector` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.FZeroVector.__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.FZeroVector.__ne__ ( FZeroVector v )

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

Parameters

v	The `FZeroVector` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.FZeroVector.__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.FZeroVector.__call__ ( int i )

Returns the zero element.

Parameters

i	The zero-based element index.

Returns: The zero element.

Exceptions

Base.IndexError if i is out of range.

◆ getitem()

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

Returns the zero element.

Parameters

i	The zero-based element index.

Returns: The zero element.

Exceptions

Base.IndexError if i is out of range.

◆ len()

int CDPL.Math.FZeroVector.__len__ ( )

Returns the logical element count.

Returns: The element count.

◆ str()

str CDPL.Math.FZeroVector.__str__ ( )

Returns a string representation of the FZeroVector instance.

Returns: The generated string representation.

◆ pos()

FZeroVector CDPL.Math.FZeroVector.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFVectorExpression CDPL.Math.FZeroVector.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstFVectorExpression CDPL.Math.FZeroVector.__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.FZeroVector.__sub__ ( ConstFVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstFVectorExpression CDPL.Math.FZeroVector.__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.FZeroVector.__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.FZeroVector.__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.FZeroVector.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstFVectorExpression CDPL.Math.FZeroVector.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ resize()

◆ getObjectID()

◆ isEmpty()

◆ getSize()

◆ getElement()

◆ toArray()

◆ assign()

◆ swap()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()