Unbounded dense vector holding floating-point values of type double. More...

Inheritance diagram for CDPL.Math.DVector:

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

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

None	__init__ (int n)
	Constructs a vector of size n with default-initialized elements. More...

None	__init__ (int n, float v)
	Constructs a vector of size n with every element initialized to v. More...

None	__init__ (ConstFVectorExpression e)
	Constructs the vector from the vector expression e (materializing the expression result). More...

None	__init__ (ConstDVectorExpression e)
	Constructs the vector from the vector expression e (materializing the expression result). More...

None	__init__ (ConstLVectorExpression e)
	Constructs the vector from the vector expression e (materializing the expression result). More...

None	__init__ (ConstULVectorExpression e)
	Constructs the vector from the vector expression e (materializing the expression result). More...

None	__init__ (object a)
	Constructs the vector from the `numpy.ndarray` object a. More...

None	resize (int n, float v=0.0)
	Resizes the vector to n elements. More...

None	clear (float v=0.0)
	Sets every element of the vector to the value v. More...

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

DVector	assign (ConstFVectorExpression e)
	Assigns the vector expression e to this vector (via a temporary to handle aliasing). More...

DVector	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this vector (via a temporary to handle aliasing). More...

DVector	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this vector (via a temporary to handle aliasing). More...

DVector	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this vector (via a temporary to handle aliasing). More...

DVector	assign (DVector v)
	Copy-assigns the elements of v to this vector. More...

None	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this vector. 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 `DVector` instance into a corresponding `numpy.ndarray` object. More...

None	swap (DVector v)
	Swaps the contents of this vector with those of v. More...

None	setElement (int i, float v)
	Sets the value of the element at index i to v. More...

bool	__eq__ (DVector v)
	Returns the result of the comparison operation `self == v`. More...

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

bool	__ne__ (DVector v)
	Returns the result of the comparison operation `self != v`. 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 `DVector` instance. More...

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

None	__setitem__ (int i, float v)
	Sets the value of the element at index i to v. More...

DVector	__iadd__ (DVector v)
	Adds the contents of the vector v element-wise to this vector (no alias check needed). More...

DVector	__iadd__ (ConstDVectorExpression e)
	Adds the vector expression e element-wise to this vector (via a temporary to handle aliasing). More...

DVector	__isub__ (DVector v)
	Subtracts the contents of the vector v element-wise from this vector (no alias check needed). More...

DVector	__isub__ (ConstDVectorExpression e)
	Subtracts the vector expression e element-wise from this vector (via a temporary to handle aliasing). More...

DVector	__imul__ (float t)
	Multiplies every element by the scalar t. More...

DVector	__idiv__ (float t)
	Divides every element by the scalar t. More...

DVector	__itruediv__ (float t)
	Divides every element by the scalar t. More...

Properties
	objectID = property(getObjectID)

	size = property(getSize)

Detailed Description

Unbounded dense vector holding floating-point values of type double.

Constructor & Destructor Documentation

◆ init() [1/8]

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

Constructs a copy of the vector v.

Parameters

v	The vector to copy.

◆ init() [2/8]

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

Constructs a vector of size n with default-initialized elements.

Parameters

n	The desired vector size.

◆ init() [3/8]

None CDPL.Math.DVector.__init__	(	int	n,
		float	v
	)

Constructs a vector of size n with every element initialized to v.

Parameters

n	The desired vector size.
v	The value used for element initialization.

◆ init() [4/8]

None CDPL.Math.DVector.__init__ ( ConstFVectorExpression e )

Constructs the vector from the vector expression e (materializing the expression result).

Parameters

e	The vector expression to materialize.

◆ init() [5/8]

None CDPL.Math.DVector.__init__ ( ConstDVectorExpression e )

Constructs the vector from the vector expression e (materializing the expression result).

Parameters

e	The vector expression to materialize.

◆ init() [6/8]

None CDPL.Math.DVector.__init__ ( ConstLVectorExpression e )

Constructs the vector from the vector expression e (materializing the expression result).

Parameters

e	The vector expression to materialize.

◆ init() [7/8]

None CDPL.Math.DVector.__init__ ( ConstULVectorExpression e )

Constructs the vector from the vector expression e (materializing the expression result).

Parameters

e	The vector expression to materialize.

◆ init() [8/8]

None CDPL.Math.DVector.__init__ ( object a )

Constructs the vector from the numpy.ndarray object a.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

Member Function Documentation

◆ resize()

None CDPL.Math.DVector.resize	(	int	n,
		float	v = `0.0`
	)

Resizes the vector to n elements.

Parameters

n	The new element count.
v	The fill value for newly added elements.

◆ clear()

None CDPL.Math.DVector.clear ( float v = 0.0 )

Sets every element of the vector to the value v.

Parameters

v	The fill value.

◆ getObjectID()

int CDPL.Math.DVector.getObjectID ( )

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

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

◆ assign() [1/6]

DVector CDPL.Math.DVector.assign ( ConstFVectorExpression e )

Assigns the vector expression e to this vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [2/6]

DVector CDPL.Math.DVector.assign ( ConstDVectorExpression e )

Assigns the vector expression e to this vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [3/6]

DVector CDPL.Math.DVector.assign ( ConstLVectorExpression e )

Assigns the vector expression e to this vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [4/6]

DVector CDPL.Math.DVector.assign ( ConstULVectorExpression e )

Assigns the vector expression e to this vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [5/6]

DVector CDPL.Math.DVector.assign ( DVector v )

Copy-assigns the elements of v to this vector.

Parameters

v	The source vector.

Returns: self.

◆ assign() [6/6]

None CDPL.Math.DVector.assign ( object a )

Assigns the contents of the numpy.ndarray object a to this vector.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ isEmpty()

bool CDPL.Math.DVector.isEmpty ( )

Tells whether the vector is empty.

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

◆ getSize()

int CDPL.Math.DVector.getSize ( )

Returns the current element count.

Returns: The number of elements.

◆ getElement()

float CDPL.Math.DVector.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.DVector.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

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

Swaps the contents of this vector with those of v.

Parameters

v	The vector to swap with.

◆ setElement()

None CDPL.Math.DVector.setElement	(	int	i,
		float	v
	)

Sets the value of the element at index i to v.

Parameters

i	The zero-based element index.
v	The new value of the element.

Exceptions

Base.IndexError if i is not in the range [0, getSize()).

◆ eq() [1/2]

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

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

Parameters

v	The `DVector` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.DVector.__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() [1/2]

bool CDPL.Math.DVector.__ne__ ( DVector v )

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

Parameters

v	The `DVector` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.DVector.__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.DVector.__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.DVector.__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.DVector.__len__ ( )

Returns the current element count.

Returns: The number of elements.

◆ str()

str CDPL.Math.DVector.__str__ ( )

Returns a string representation of the DVector instance.

Returns: The generated string representation.

◆ pos()

DVector CDPL.Math.DVector.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstDVectorExpression CDPL.Math.DVector.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstDVectorExpression CDPL.Math.DVector.__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.DVector.__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.DVector.__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.DVector.__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.DVector.__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.

◆ setitem()

None CDPL.Math.DVector.__setitem__	(	int	i,
		float	v
	)

Sets the value of the element at index i to v.

Parameters

i	The zero-based element index.
v	The new value of the element.

Exceptions

Base.IndexError if i is not in the range [0, getSize()).

◆ iadd() [1/2]

DVector CDPL.Math.DVector.__iadd__ ( DVector v )

Adds the contents of the vector v element-wise to this vector (no alias check needed).

Parameters

v	The source vector.

Returns: self.

◆ iadd() [2/2]

DVector CDPL.Math.DVector.__iadd__ ( ConstDVectorExpression e )

Adds the vector expression e element-wise to this vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ isub() [1/2]

DVector CDPL.Math.DVector.__isub__ ( DVector v )

Subtracts the contents of the vector v element-wise from this vector (no alias check needed).

Parameters

v	The source vector.

Returns: self.

◆ isub() [2/2]

DVector CDPL.Math.DVector.__isub__ ( ConstDVectorExpression e )

Subtracts the vector expression e element-wise from this vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ imul()

DVector CDPL.Math.DVector.__imul__ ( float t )

Multiplies every element by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

DVector CDPL.Math.DVector.__idiv__ ( float t )

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

DVector CDPL.Math.DVector.__itruediv__ ( float t )

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/8]

◆ __init__() [2/8]

◆ __init__() [3/8]

◆ __init__() [4/8]

◆ __init__() [5/8]

◆ __init__() [6/8]

◆ __init__() [7/8]

◆ __init__() [8/8]

Member Function Documentation

◆ resize()

◆ clear()

◆ getObjectID()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ isEmpty()

◆ getSize()

◆ getElement()

◆ toArray()

◆ swap()

◆ setElement()

◆ __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__()

◆ __setitem__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

◆ init() [1/8]

◆ init() [2/8]

◆ init() [3/8]

◆ init() [4/8]

◆ init() [5/8]

◆ init() [6/8]

◆ init() [7/8]

◆ init() [8/8]

◆ 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()

◆ setitem()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()