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

Inheritance diagram for CDPL.Math.LVectorSlice:

Public Member Functions
None	__init__ (LVectorSlice s)
	Contructs a copy of the `LVectorSlice` instance s. More...

None	__init__ (LVectorExpression e, Slice s)
	Contructs the `LVectorSlice` 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...

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

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

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

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

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

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

int	getElement (int i)
	Returns the element at index i of the view. More...

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

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

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

LVectorExpression	getData ()
	Returns the wrapped vector. More...

bool	__eq__ (LVectorSlice s)
	Returns the result of the comparison operation `self == s`. More...

bool	__eq__ (ConstLVectorExpression e)
	Returns the result of the comparison operation `self == e`. More...

bool	__ne__ (LVectorSlice s)
	Returns the result of the comparison operation `self != s`. More...

bool	__ne__ (ConstLVectorExpression e)
	Returns the result of the comparison operation `self != e`. More...

int	__call__ (int i)
	Returns the element at index i of the view. More...

int	__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 `LVectorSlice` instance. More...

LVectorSlice	__pos__ ()
	Returns self. More...

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

ConstLVectorExpression	__add__ (ConstLVectorExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstLVectorExpression	__sub__ (ConstLVectorExpression e)
	Returns the result of the subtraction operation `self - e`. More...

ConstLVectorExpression	__mul__ (int t)
	Returns the result of the multiplication operation `self * t`. More...

ConstLVectorExpression	__mul__ (ConstLMatrixExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstLVectorExpression	__div__ (int t)
	Returns the result of the division operation `self // t`. More...

ConstLVectorExpression	__truediv__ (int t)
	Returns the result of the true division operation `self / t`. More...

ConstLVectorExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

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

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

LVectorSlice	__iadd__ (ConstLVectorExpression e)
	Adds the vector expression e componentwise to this view. More...

LVectorSlice	__isub__ (LVectorSlice s)
	Subtracts the vector slice s componentwise from this view. More...

LVectorSlice	__isub__ (ConstLVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...

LVectorSlice	__imul__ (int t)
	Multiplies every element of this view by the scalar t. More...

LVectorSlice	__idiv__ (int t)
	Divides every element of this view by the scalar t. More...

LVectorSlice	__itruediv__ (int 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.LVectorSlice.__init__ ( LVectorSlice s )

Contructs a copy of the LVectorSlice instance s.

Parameters

s	The `LVectorSlice` instance to copy.

◆ init() [2/2]

None CDPL.Math.LVectorSlice.__init__	(	LVectorExpression	e,
		Slice	s
	)

Contructs the LVectorSlice instance.

Parameters

e
s

Member Function Documentation

◆ getStart()

int CDPL.Math.LVectorSlice.getStart ( )

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

Returns: The start index of the slice.

◆ getStride()

int CDPL.Math.LVectorSlice.getStride ( )

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

Returns: The stride.

◆ getObjectID()

int CDPL.Math.LVectorSlice.getObjectID ( )

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

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

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

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

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

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

LVectorSlice CDPL.Math.LVectorSlice.assign ( LVectorSlice 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]

LVectorSlice CDPL.Math.LVectorSlice.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.LVectorSlice.isEmpty ( )

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

Returns: True if the slice is empty, and False otherwise.

◆ getSize()

int CDPL.Math.LVectorSlice.getSize ( )

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

Returns: The number of elements in the view.

◆ getElement()

int CDPL.Math.LVectorSlice.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.LVectorSlice.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.LVectorSlice.swap ( LVectorSlice s )

Swaps the elements of this view with those of s.

Parameters

s	The view to swap with.

◆ setElement()

None CDPL.Math.LVectorSlice.setElement	(	int	i,
		int	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()

LVectorExpression CDPL.Math.LVectorSlice.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

bool CDPL.Math.LVectorSlice.__eq__ ( LVectorSlice s )

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

Parameters

s	The `LVectorSlice` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.LVectorSlice.__eq__ ( ConstLVectorExpression e )

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

Parameters

e	The `ConstLVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.LVectorSlice.__ne__ ( LVectorSlice s )

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

Parameters

s	The `LVectorSlice` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.LVectorSlice.__ne__ ( ConstLVectorExpression e )

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

Parameters

e	The `ConstLVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ call()

int CDPL.Math.LVectorSlice.__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()

int CDPL.Math.LVectorSlice.__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.LVectorSlice.__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.LVectorSlice.__str__ ( )

Returns a string representation of the LVectorSlice instance.

Returns: The generated string representation.

◆ pos()

LVectorSlice CDPL.Math.LVectorSlice.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstLVectorExpression CDPL.Math.LVectorSlice.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstLVectorExpression CDPL.Math.LVectorSlice.__add__ ( ConstLVectorExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns: A ConstLVectorExpression instance holding the result of the addition.

◆ sub()

ConstLVectorExpression CDPL.Math.LVectorSlice.__sub__ ( ConstLVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns: A LVectorSlice instance holding the result of the subtraction.

◆ mul() [1/2]

ConstLVectorExpression CDPL.Math.LVectorSlice.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A ConstLVectorExpression instance holding the result of the multiplication.

◆ mul() [2/2]

ConstLVectorExpression CDPL.Math.LVectorSlice.__mul__ ( ConstLMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstLVectorExpression instance holding the result of the multiplication.

◆ div()

ConstLVectorExpression CDPL.Math.LVectorSlice.__div__ ( int t )

Returns the result of the division operation self // t.

Parameters

t	Specifies the divisor.

Returns: A ConstLVectorExpression instance holding the result of the division.

◆ truediv()

ConstLVectorExpression CDPL.Math.LVectorSlice.__truediv__ ( int t )

Returns the result of the true division operation self / t.

Parameters

t	Specifies the divisor.

Returns: A ConstLVectorExpression instance holding the result of the division.

◆ rmul()

ConstLVectorExpression CDPL.Math.LVectorSlice.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstLVectorExpression instance holding the result of the multiplication.

◆ setitem()

None CDPL.Math.LVectorSlice.__setitem__	(	int	i,
		int	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]

LVectorSlice CDPL.Math.LVectorSlice.__iadd__ ( LVectorSlice s )

Adds the vector slice s componentwise to this view.

Parameters

s	The vector slice to add.

Returns: self.

◆ iadd() [2/2]

LVectorSlice CDPL.Math.LVectorSlice.__iadd__ ( ConstLVectorExpression e )

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns: self.

◆ isub() [1/2]

LVectorSlice CDPL.Math.LVectorSlice.__isub__ ( LVectorSlice s )

Subtracts the vector slice s componentwise from this view.

Parameters

s	The vector slice to subtract.

Returns: self.

◆ isub() [2/2]

LVectorSlice CDPL.Math.LVectorSlice.__isub__ ( ConstLVectorExpression e )

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns: self.

◆ imul()

LVectorSlice CDPL.Math.LVectorSlice.__imul__ ( int t )

Multiplies every element of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

LVectorSlice CDPL.Math.LVectorSlice.__idiv__ ( int t )

Divides every element of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

LVectorSlice CDPL.Math.LVectorSlice.__itruediv__ ( int 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()