CDPL.Math.FVectorRange Class Reference

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

Inheritance diagram for CDPL.Math.FVectorRange:

Public Member Functions
None	__init__ (FVectorRange r)
	Initializes a copy of the FVectorRange instance r. More...
None	__init__ (FVectorExpression e, Range r)
	Initializes the FVectorRange 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...
FVectorRange	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...
FVectorRange	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...
FVectorRange	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...
FVectorRange	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...
FVectorRange	assign (FVectorRange 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 (FVectorRange r)
	Swaps the elements of this view with those of r. More...
None	setElement (int i, float v)
FVectorExpression	getData ()
	Returns a reference to the wrapped vector (via its stored closure). More...
bool	__eq__ (FVectorRange r)
	Returns the result of the comparison operation self == r. More...
bool	__eq__ (ConstFVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (FVectorRange r)
	Returns the result of the comparison operation self != r. More...
bool	__ne__ (ConstFVectorExpression 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 FVectorRange instance. More...
FVectorRange	__pos__ ()
ConstFVectorExpression	__neg__ ()
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...
None	__setitem__ (int i, float v)
FVectorRange	__iadd__ (FVectorRange r)
	Performs the in-place addition operation self += r. More...
FVectorRange	__iadd__ (ConstFVectorExpression e)
	Adds the vector expression e componentwise to this view. More...
FVectorRange	__isub__ (FVectorRange r)
	Performs the in-place subtraction operation self -= r. More...
FVectorRange	__isub__ (ConstFVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...
FVectorRange	__imul__ (float t)
	Multiplies every element of this view by the scalar t. More...
FVectorRange	__idiv__ (float t)
	Divides every element of this view by the scalar t. More...
FVectorRange	__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.FVectorRange.__init__

(

FVectorRange

r

)

Initializes a copy of the FVectorRange instance r.

Parameters

r	The FVectorRange instance to copy.

__init__() [2/2]

None CDPL.Math.FVectorRange.__init__	(	FVectorExpression	e,
		Range	r
	)

Initializes the FVectorRange instance.

Parameters

e
r

Member Function Documentation

getStart()

int CDPL.Math.FVectorRange.getStart

(

)

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

Returns

The start index of the range.

getObjectID()

int CDPL.Math.FVectorRange.getObjectID

(

)

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

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

FVectorRange CDPL.Math.FVectorRange.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]

FVectorRange CDPL.Math.FVectorRange.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]

FVectorRange CDPL.Math.FVectorRange.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]

FVectorRange CDPL.Math.FVectorRange.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]

FVectorRange CDPL.Math.FVectorRange.assign

(

FVectorRange

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

(

)

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

Returns

True if the range is empty, and False otherwise.

getSize()

int CDPL.Math.FVectorRange.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.FVectorRange.swap

(

FVectorRange

r

)

Swaps the elements of this view with those of r.

Parameters

r	The view to swap with.

getData()

FVectorExpression CDPL.Math.FVectorRange.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.FVectorRange.__eq__

(

FVectorRange

r

)

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

Parameters

r	The FVectorRange instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

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

(

FVectorRange

r

)

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

Parameters

r	The FVectorRange instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.FVectorRange.__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.FVectorRange.__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.FVectorRange.__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.FVectorRange.__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.FVectorRange.__str__

(

)

Returns a string representation of the FVectorRange instance.

Returns

The generated string representation.

__add__()

ConstFVectorExpression CDPL.Math.FVectorRange.__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.FVectorRange.__sub__

(

ConstFVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A FVectorRange instance holding the result of the subtraction.

__mul__() [1/2]

ConstFVectorExpression CDPL.Math.FVectorRange.__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.FVectorRange.__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.FVectorRange.__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.FVectorRange.__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.FVectorRange.__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.

__iadd__() [1/2]

FVectorRange CDPL.Math.FVectorRange.__iadd__

(

FVectorRange

r

)

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

Parameters

r	Specifies the second addend.

Returns

The updated FVectorRange instance self.

__iadd__() [2/2]

FVectorRange CDPL.Math.FVectorRange.__iadd__

(

ConstFVectorExpression

e

)

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns

self

__isub__() [1/2]

FVectorRange CDPL.Math.FVectorRange.__isub__

(

FVectorRange

r

)

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

Parameters

r	Specifies the subtrahend.

Returns

The updated FVectorRange instance self.

__isub__() [2/2]

FVectorRange CDPL.Math.FVectorRange.__isub__

(

ConstFVectorExpression

e

)

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns

self

__imul__()

FVectorRange CDPL.Math.FVectorRange.__imul__

(

float

t

)

Multiplies every element of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__idiv__()

FVectorRange CDPL.Math.FVectorRange.__idiv__

(

float

t

)

Divides every element of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns

self