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)
	Contructs a copy of the `FVectorSlice` instance s. More...

None	__init__ (FVectorExpression e, Slice s)
	Contructs 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 (writing through to the wrapped vector). More...

FVectorSlice	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

FVectorSlice	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

FVectorSlice	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

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

FVectorSlice	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this view. 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)
	Returns the element at index i of the view. More...

object	toArray ()
	Converts the `FVectorSlice` instance into a corresponding `numpy.ndarray` object. More...

None	swap (FVectorSlice s)
	Swaps the elements of this view with those of s. More...

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

FVectorExpression	getData ()
	Returns the wrapped vector. 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 the element at index i of the view. More...

float	__getitem__ (int i)
	Returns 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__ ()
	Returns self. More...

ConstFVectorExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

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)
	Sets the value of the element at index i of the view to v. More...

FVectorSlice	__iadd__ (FVectorSlice s)
	Adds the vector slice s componentwise to this view. More...

FVectorSlice	__iadd__ (ConstFVectorExpression e)
	Adds the vector expression e componentwise to this view. More...

FVectorSlice	__isub__ (FVectorSlice s)
	Subtracts the vector slice s componentwise from this view. 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)
	Divides every element of this view by the scalar t. More...

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 )

Contructs 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
	)

Contructs 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 (writing through to 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 (writing through to 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 (writing through to 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 (writing through to 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]

FVectorSlice CDPL.Math.FVectorSlice.assign ( object a )

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

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

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

◆ getElement()

float CDPL.Math.FVectorSlice.getElement ( int i )

Returns the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns: The value of the element v(slice(i)).

◆ toArray()

object CDPL.Math.FVectorSlice.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

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

◆ setElement()

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

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

Parameters

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

Exceptions

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

◆ getData()

FVectorExpression CDPL.Math.FVectorSlice.getData ( )

Returns the wrapped vector.

Returns: 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 the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns: The value of the element v(slice(i)).

◆ getitem()

float CDPL.Math.FVectorSlice.__getitem__ ( int i )

Returns the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns: The value of the element v(slice(i)).

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

◆ pos()

FVectorSlice CDPL.Math.FVectorSlice.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFVectorExpression CDPL.Math.FVectorSlice.__neg__ ( )

Returns the result of the operation self * -1.

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

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

◆ setitem()

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

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

Parameters

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

Exceptions

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

◆ iadd() [1/2]

FVectorSlice CDPL.Math.FVectorSlice.__iadd__ ( FVectorSlice s )

Adds the vector slice s componentwise to this view.

Parameters

s	The vector slice to add.

Returns: 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 )

Subtracts the vector slice s componentwise from this view.

Parameters

s	The vector slice to subtract.

Returns: 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.

◆ itruediv()

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

Divides every element of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getStart()

◆ getStride()

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

◆ getData()

◆ __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/2]

◆ init() [2/2]

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