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

None	__init__ (LVectorExpression e, Slice s)
	Initializes 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 without intermediate temporary (use only when e does not alias the wrapped vector). More...

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

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

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

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

int	getElement (int i)

object	toArray ()

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

None	setElement (int i, int v)

LVectorExpression	getData ()
	Returns a reference to the wrapped vector (via its stored closure). 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 a reference to the element at index i of the view. More...

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

LVectorSlice	__pos__ ()

ConstLVectorExpression	__neg__ ()

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)

LVectorSlice	__iadd__ (LVectorSlice s)
	Performs the in-place addition operation `self += s`. More...

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

LVectorSlice	__isub__ (LVectorSlice s)
	Performs the in-place subtraction operation `self -= s`. 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)

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 )

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

Initializes 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 without intermediate temporary (use only when e does not alias 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 without intermediate temporary (use only when e does not alias 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 without intermediate temporary (use only when e does not alias 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 without intermediate temporary (use only when e does not alias 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]

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

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

◆ getData()

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

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

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

◆ iadd() [1/2]

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

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

Parameters

s	Specifies the second addend.

Returns: The updated LVectorSlice instance 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 )

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

Parameters

s	Specifies the subtrahend.

Returns: The updated LVectorSlice instance 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

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

◆ swap()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()