CDPL.Math.ConstDVectorSlice Class Reference

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

Inheritance diagram for CDPL.Math.ConstDVectorSlice:

Public Member Functions
None	__init__ (ConstDVectorSlice s)
	Contructs a copy of the ConstDVectorSlice instance s. More...
None	__init__ (ConstDVectorExpression e, Slice s)
	Contructs the ConstDVectorSlice 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...
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 ConstDVectorSlice instance into a corresponding numpy.ndarray object. More...
ConstDVectorExpression	getData ()
	Returns the wrapped vector. More...
bool	__eq__ (ConstDVectorSlice s)
	Returns the result of the comparison operation self == s. More...
bool	__eq__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (ConstDVectorSlice s)
	Returns the result of the comparison operation self != s. More...
bool	__ne__ (ConstDVectorExpression 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 ConstDVectorSlice instance. More...
ConstDVectorSlice	__pos__ ()
	Returns self. More...
ConstDVectorExpression	__neg__ ()
	Returns the result of the operation self * -1. More...
ConstDVectorExpression	__add__ (ConstDVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstDVectorExpression	__sub__ (ConstDVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstDVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstDVectorExpression	__mul__ (ConstDMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDVectorExpression	__div__ (float t)
	Returns the result of the division operation self // t. More...
ConstDVectorExpression	__truediv__ (float t)
	Returns the result of the true division operation self / t. More...
ConstDVectorExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. 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.ConstDVectorSlice.__init__

(

ConstDVectorSlice

s

)

Contructs a copy of the ConstDVectorSlice instance s.

Parameters

s	The ConstDVectorSlice instance to copy.

__init__() [2/2]

None CDPL.Math.ConstDVectorSlice.__init__	(	ConstDVectorExpression	e,
		Slice	s
	)

Contructs the ConstDVectorSlice instance.

Parameters

e
s

Member Function Documentation

getStart()

int CDPL.Math.ConstDVectorSlice.getStart

(

)

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

Returns

The start index of the slice.

getStride()

int CDPL.Math.ConstDVectorSlice.getStride

(

)

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

Returns

The stride.

getObjectID()

int CDPL.Math.ConstDVectorSlice.getObjectID

(

)

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

Different Python ConstDVectorSlice 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 ConstDVectorSlice 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.

isEmpty()

bool CDPL.Math.ConstDVectorSlice.isEmpty

(

)

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

Returns

True if the slice is empty, and False otherwise.

getSize()

int CDPL.Math.ConstDVectorSlice.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.ConstDVectorSlice.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.ConstDVectorSlice.toArray

(

)

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

Returns

The generated numpy.ndarray object.

See also

[NUMPY]

getData()

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.getData

(

)

Returns the wrapped vector.

Returns

The wrapped vector closure.

__eq__() [1/2]

bool CDPL.Math.ConstDVectorSlice.__eq__

(

ConstDVectorSlice

s

)

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

Parameters

s	The ConstDVectorSlice instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.ConstDVectorSlice.__eq__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.ConstDVectorSlice.__ne__

(

ConstDVectorSlice

s

)

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

Parameters

s	The ConstDVectorSlice instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.ConstDVectorSlice.__ne__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

float CDPL.Math.ConstDVectorSlice.__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.ConstDVectorSlice.__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.ConstDVectorSlice.__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.ConstDVectorSlice.__str__

(

)

Returns a string representation of the ConstDVectorSlice instance.

Returns

The generated string representation.

__pos__()

ConstDVectorSlice CDPL.Math.ConstDVectorSlice.__pos__

(

)

Returns self.

Returns

self.

__neg__()

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__neg__

(

)

Returns the result of the operation self * -1.

Returns

A ConstDVectorExpression instance holding the result of the element negation.

__add__()

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__add__

(

ConstDVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstDVectorExpression instance holding the result of the addition.

__sub__()

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__sub__

(

ConstDVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A ConstDVectorSlice instance holding the result of the subtraction.

__mul__() [1/2]

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__mul__

(

ConstDMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__div__()

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__div__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__truediv__()

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__truediv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__rmul__()

ConstDVectorExpression CDPL.Math.ConstDVectorSlice.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.