CDPL.Math.DVector Class Reference

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)
	Move-constructs a vector from v (v is left in a valid empty state). 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)
	Initializes the DVector instance. More...
None	__init__ (ConstDVectorExpression e)
	Initializes the DVector instance. More...
None	__init__ (ConstLVectorExpression e)
	Initializes the DVector instance. More...
None	__init__ (ConstULVectorExpression e)
	Initializes the DVector instance. More...
None	__init__ (object a)
	Initializes the DVector instance. 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)
	Resizes this vector to match e and assigns the elements of e without intermediate temporary. More...
DVector	assign (ConstDVectorExpression e)
	Resizes this vector to match e and assigns the elements of e without intermediate temporary. More...
DVector	assign (ConstLVectorExpression e)
	Resizes this vector to match e and assigns the elements of e without intermediate temporary. More...
DVector	assign (ConstULVectorExpression e)
	Resizes this vector to match e and assigns the elements of e without intermediate temporary. More...
DVector	assign (DVector v)
	Move-assigns the elements of v to this vector. More...
None	assign (object a)
	Replaces the current state of self with a copy of the state of the object instance a. More...
bool	isEmpty ()
	Tells whether the vector is empty. More...
int	getSize ()
	Returns the current element count. More...
float	getElement (int i)
object	toArray ()
None	swap (DVector v)
	Swaps the contents of this vector with those of v. More...
None	setElement (int i, float v)
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 a reference to the element at index i. More...
float	__getitem__ (int i)
	Returns a reference to 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__ ()
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...
None	__setitem__ (int i, float v)
DVector	__iadd__ (DVector v)
	Performs the in-place addition operation self += v. 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)
	Performs the in-place subtraction operation self -= v. 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)

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

)

Move-constructs a vector from v (v is left in a valid empty state).

Parameters

v	The vector to move from.

__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

)

Initializes the DVector instance.

Parameters

e

__init__() [5/8]

None CDPL.Math.DVector.__init__

(

ConstDVectorExpression

e

)

Initializes the DVector instance.

Parameters

e

__init__() [6/8]

None CDPL.Math.DVector.__init__

(

ConstLVectorExpression

e

)

Initializes the DVector instance.

Parameters

e

__init__() [7/8]

None CDPL.Math.DVector.__init__

(

ConstULVectorExpression

e

)

Initializes the DVector instance.

Parameters

e

__init__() [8/8]

None CDPL.Math.DVector.__init__

(

object

a

)

Initializes the DVector instance.

Parameters

a

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

)

Resizes this vector to match e and assigns the elements of e without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [2/6]

DVector CDPL.Math.DVector.assign

(

ConstDVectorExpression

e

)

Resizes this vector to match e and assigns the elements of e without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [3/6]

DVector CDPL.Math.DVector.assign

(

ConstLVectorExpression

e

)

Resizes this vector to match e and assigns the elements of e without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [4/6]

DVector CDPL.Math.DVector.assign

(

ConstULVectorExpression

e

)

Resizes this vector to match e and assigns the elements of e without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [5/6]

DVector CDPL.Math.DVector.assign

(

DVector

v

)

Move-assigns the elements of v to this vector.

Parameters

v	The source vector (left in a valid but unspecified state).

Returns

self

assign() [6/6]

None CDPL.Math.DVector.assign

(

object

a

)

Replaces the current state of self with a copy of the state of the object instance a.

Parameters

a	The object instance to copy.

Returns

self

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.

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.

__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 a reference to the element at index i.

Parameters

i	The zero-based element index.

Returns

A reference to the element.

Exceptions

Base.IndexError

if i is out of range.

__getitem__()

float CDPL.Math.DVector.__getitem__

(

int

i

)

Returns a reference to the element at index i.

Parameters

i	The zero-based element index.

Returns

A reference to 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.

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

__iadd__() [1/2]

DVector CDPL.Math.DVector.__iadd__

(

DVector

v

)

Performs the in-place addition operation self += v.

Parameters

v	Specifies the second addend.

Returns

The updated DVector instance 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

)

Performs the in-place subtraction operation self -= v.

Parameters

v	Specifies the subtrahend.

Returns

The updated DVector instance 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