CDPL.Math.DVectorRange Class Reference

Vector expression proxy that views a contiguous half-open subrange of an underlying vector. More...

Inheritance diagram for CDPL.Math.DVectorRange:

Public Member Functions
None	__init__ (DVectorRange r)
	Initializes a copy of the DVectorRange instance r. More...
None	__init__ (DVectorExpression e, Range r)
	Initializes the DVectorRange instance. More...
int	getStart ()
	Returns the start index of the viewed range within the wrapped vector. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
DVectorRange	assign (ConstFVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...
DVectorRange	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...
DVectorRange	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...
DVectorRange	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...
DVectorRange	assign (DVectorRange r)
	Copies the elements of r into this view (writing through to the wrapped 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 view is empty (zero-length range). More...
int	getSize ()
	Returns the size of the view (number of elements covered by the range). More...
float	getElement (int i)
object	toArray ()
None	swap (DVectorRange r)
	Swaps the elements of this view with those of r. More...
None	setElement (int i, float v)
DVectorExpression	getData ()
	Returns a reference to the wrapped vector (via its stored closure). More...
bool	__eq__ (DVectorRange r)
	Returns the result of the comparison operation self == r. More...
bool	__eq__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (DVectorRange r)
	Returns the result of the comparison operation self != r. 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 of the view. More...
float	__getitem__ (int i)
	Returns a reference to the element at index i of the view. More...
int	__len__ ()
	Returns the size of the view (number of elements covered by the range). More...
str	__str__ ()
	Returns a string representation of the DVectorRange instance. More...
DVectorRange	__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)
DVectorRange	__iadd__ (DVectorRange r)
	Performs the in-place addition operation self += r. More...
DVectorRange	__iadd__ (ConstDVectorExpression e)
	Adds the vector expression e componentwise to this view. More...
DVectorRange	__isub__ (DVectorRange r)
	Performs the in-place subtraction operation self -= r. More...
DVectorRange	__isub__ (ConstDVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...
DVectorRange	__imul__ (float t)
	Multiplies every element of this view by the scalar t. More...
DVectorRange	__idiv__ (float t)
	Divides every element of this view by the scalar t. More...
DVectorRange	__itruediv__ (float t)

Properties
	objectID = property(getObjectID)
	size = property(getSize)
	data = property(getData)
	start = property(getStart)

Detailed Description

Vector expression proxy that views a contiguous half-open subrange of an underlying vector.

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.DVectorRange.__init__

(

DVectorRange

r

)

Initializes a copy of the DVectorRange instance r.

Parameters

r	The DVectorRange instance to copy.

__init__() [2/2]

None CDPL.Math.DVectorRange.__init__	(	DVectorExpression	e,
		Range	r
	)

Initializes the DVectorRange instance.

Parameters

e
r

Member Function Documentation

getStart()

int CDPL.Math.DVectorRange.getStart

(

)

Returns the start index of the viewed range within the wrapped vector.

Returns

The start index of the range.

getObjectID()

int CDPL.Math.DVectorRange.getObjectID

(

)

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

Different Python DVectorRange 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 DVectorRange 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]

DVectorRange CDPL.Math.DVectorRange.assign

(

ConstFVectorExpression

e

)

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source vector expression.

Returns

self

assign() [2/6]

DVectorRange CDPL.Math.DVectorRange.assign

(

ConstDVectorExpression

e

)

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source vector expression.

Returns

self

assign() [3/6]

DVectorRange CDPL.Math.DVectorRange.assign

(

ConstLVectorExpression

e

)

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source vector expression.

Returns

self

assign() [4/6]

DVectorRange CDPL.Math.DVectorRange.assign

(

ConstULVectorExpression

e

)

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source vector expression.

Returns

self

assign() [5/6]

DVectorRange CDPL.Math.DVectorRange.assign

(

DVectorRange

r

)

Copies the elements of r into this view (writing through to the wrapped vector).

Parameters

r	The source range view.

Returns

self

assign() [6/6]

None CDPL.Math.DVectorRange.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.DVectorRange.isEmpty

(

)

Tells whether the view is empty (zero-length range).

Returns

True if the range is empty, and False otherwise.

getSize()

int CDPL.Math.DVectorRange.getSize

(

)

Returns the size of the view (number of elements covered by the range).

Returns

The number of elements in the view.

swap()

None CDPL.Math.DVectorRange.swap

(

DVectorRange

r

)

Swaps the elements of this view with those of r.

Parameters

r	The view to swap with.

getData()

DVectorExpression CDPL.Math.DVectorRange.getData

(

)

Returns a reference to the wrapped vector (via its stored closure).

Returns

A reference to the wrapped vector closure.

__eq__() [1/2]

bool CDPL.Math.DVectorRange.__eq__

(

DVectorRange

r

)

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

Parameters

r	The DVectorRange instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.DVectorRange.__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.DVectorRange.__ne__

(

DVectorRange

r

)

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

Parameters

r	The DVectorRange instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.DVectorRange.__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.DVectorRange.__call__

(

int

i

)

Returns a reference to the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns

A reference to the underlying element v(range(i)).

__getitem__()

float CDPL.Math.DVectorRange.__getitem__

(

int

i

)

Returns a reference to the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns

A reference to the underlying element.

__len__()

int CDPL.Math.DVectorRange.__len__

(

)

Returns the size of the view (number of elements covered by the range).

Returns

The number of elements in the view.

__str__()

str CDPL.Math.DVectorRange.__str__

(

)

Returns a string representation of the DVectorRange instance.

Returns

The generated string representation.

__add__()

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

(

ConstDVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A DVectorRange instance holding the result of the subtraction.

__mul__() [1/2]

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

DVectorRange CDPL.Math.DVectorRange.__iadd__

(

DVectorRange

r

)

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

Parameters

r	Specifies the second addend.

Returns

The updated DVectorRange instance self.

__iadd__() [2/2]

DVectorRange CDPL.Math.DVectorRange.__iadd__

(

ConstDVectorExpression

e

)

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns

self

__isub__() [1/2]

DVectorRange CDPL.Math.DVectorRange.__isub__

(

DVectorRange

r

)

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

Parameters

r	Specifies the subtrahend.

Returns

The updated DVectorRange instance self.

__isub__() [2/2]

DVectorRange CDPL.Math.DVectorRange.__isub__

(

ConstDVectorExpression

e

)

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns

self

__imul__()

DVectorRange CDPL.Math.DVectorRange.__imul__

(

float

t

)

Multiplies every element of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__idiv__()

DVectorRange CDPL.Math.DVectorRange.__idiv__

(

float

t

)

Divides every element of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns

self