CDPL.Math.FVectorSlice Class Reference

Vector expression proxy that views a strided slice of an underlying vector. More...

Inheritance diagram for CDPL.Math.FVectorSlice:

Public Member Functions
None	__init__ (FVectorSlice s)
	Initializes a copy of the FVectorSlice instance s. More...
None	__init__ (FVectorExpression e, Slice s)
	Initializes the FVectorSlice instance. More...
int	getStart ()
	Returns the start index of the slice within the wrapped vector. More...
int	getStride ()
	Returns the stride of the slice (step between successive viewed elements). More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
FVectorSlice	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...
FVectorSlice	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...
FVectorSlice	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...
FVectorSlice	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...
FVectorSlice	assign (FVectorSlice s)
	Copies the elements of s 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 slice). More...
int	getSize ()
	Returns the size of the view (number of elements covered by the slice). More...
float	getElement (int i)
object	toArray ()
None	swap (FVectorSlice s)
	Swaps the elements of this view with those of s. More...
None	setElement (int i, float v)
FVectorExpression	getData ()
	Returns a reference to the wrapped vector (via its stored closure). More...
bool	__eq__ (FVectorSlice s)
	Returns the result of the comparison operation self == s. More...
bool	__eq__ (ConstFVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (FVectorSlice s)
	Returns the result of the comparison operation self != s. 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 slice). More...
str	__str__ ()
	Returns a string representation of the FVectorSlice instance. More...
FVectorSlice	__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)
FVectorSlice	__iadd__ (FVectorSlice s)
	Performs the in-place addition operation self += s. More...
FVectorSlice	__iadd__ (ConstFVectorExpression e)
	Adds the vector expression e componentwise to this view. More...
FVectorSlice	__isub__ (FVectorSlice s)
	Performs the in-place subtraction operation self -= s. More...
FVectorSlice	__isub__ (ConstFVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...
FVectorSlice	__imul__ (float t)
	Multiplies every element of this view by the scalar t. More...
FVectorSlice	__idiv__ (float t)
	Divides every element of this view by the scalar t. More...
FVectorSlice	__itruediv__ (float t)

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

Detailed Description

Vector expression proxy that views a strided slice of an underlying vector.

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.FVectorSlice.__init__

(

FVectorSlice

s

)

Initializes a copy of the FVectorSlice instance s.

Parameters

s	The FVectorSlice instance to copy.

__init__() [2/2]

None CDPL.Math.FVectorSlice.__init__	(	FVectorExpression	e,
		Slice	s
	)

Initializes the FVectorSlice instance.

Parameters

e
s

Member Function Documentation

getStart()

int CDPL.Math.FVectorSlice.getStart

(

)

Returns the start index of the slice within the wrapped vector.

Returns

The start index of the slice.

getStride()

int CDPL.Math.FVectorSlice.getStride

(

)

Returns the stride of the slice (step between successive viewed elements).

Returns

The stride.

getObjectID()

int CDPL.Math.FVectorSlice.getObjectID

(

)

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

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

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

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

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

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

FVectorSlice CDPL.Math.FVectorSlice.assign

(

FVectorSlice

s

)

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

Parameters

s	The source slice view.

Returns

self

assign() [6/6]

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

(

)

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

Returns

True if the slice is empty, and False otherwise.

getSize()

int CDPL.Math.FVectorSlice.getSize

(

)

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

Returns

The number of elements in the view.

swap()

None CDPL.Math.FVectorSlice.swap

(

FVectorSlice

s

)

Swaps the elements of this view with those of s.

Parameters

s	The view to swap with.

getData()

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

(

FVectorSlice

s

)

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

Parameters

s	The FVectorSlice instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

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

(

FVectorSlice

s

)

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

Parameters

s	The FVectorSlice instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.FVectorSlice.__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.FVectorSlice.__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(slice(i)).

__getitem__()

float CDPL.Math.FVectorSlice.__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.FVectorSlice.__len__

(

)

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

Returns

The number of elements in the view.

__str__()

str CDPL.Math.FVectorSlice.__str__

(

)

Returns a string representation of the FVectorSlice instance.

Returns

The generated string representation.

__add__()

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

(

ConstFVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A FVectorSlice instance holding the result of the subtraction.

__mul__() [1/2]

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

FVectorSlice CDPL.Math.FVectorSlice.__iadd__

(

FVectorSlice

s

)

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

Parameters

s	Specifies the second addend.

Returns

The updated FVectorSlice instance self.

__iadd__() [2/2]

FVectorSlice CDPL.Math.FVectorSlice.__iadd__

(

ConstFVectorExpression

e

)

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns

self

__isub__() [1/2]

FVectorSlice CDPL.Math.FVectorSlice.__isub__

(

FVectorSlice

s

)

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

Parameters

s	Specifies the subtrahend.

Returns

The updated FVectorSlice instance self.

__isub__() [2/2]

FVectorSlice CDPL.Math.FVectorSlice.__isub__

(

ConstFVectorExpression

e

)

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns

self

__imul__()

FVectorSlice CDPL.Math.FVectorSlice.__imul__

(

float

t

)

Multiplies every element of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__idiv__()

FVectorSlice CDPL.Math.FVectorSlice.__idiv__

(

float

t

)

Divides every element of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns

self