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

#include <VectorProxy.hpp>

Inheritance diagram for CDPL::Math::VectorSlice< V >:

Public Types
typedef V	VectorType
	The wrapped vector type. More...

typedef V::SizeType	SizeType
	The size type used by the wrapped vector. More...

typedef V::DifferenceType	DifferenceType
	The signed difference type used by the wrapped vector. More...

typedef V::ValueType	ValueType
	The element value type of the wrapped vector. More...

typedef V::ConstReference	ConstReference
	Constant reference type to an element. More...

typedef std::conditional< std::is_const< V >::value, typename V::ConstReference, typename V::Reference >::type	Reference
	Mutable reference type (degrades to ConstReference when the wrapped vector is `const`). More...

typedef std::conditional< std::is_const< V >::value, typename V::ConstClosureType, typename V::ClosureType >::type	VectorClosureType
	Closure type used to store the wrapped vector internally (mutable or const flavor). More...

typedef const SelfType	ConstClosureType
	Constant closure type used when this proxy appears inside another expression. More...

typedef SelfType	ClosureType
	Closure type used when this proxy appears inside another expression. More...

typedef Slice< SizeType, DifferenceType >	SliceType
	The Math::Slice type defining the (start, stride, size) selection. More...

Public Types inherited from CDPL::Math::VectorExpression< VectorSlice< V > >
typedef VectorSlice< V >	ExpressionType
	The derived vector expression type. More...

Public Types inherited from CDPL::Math::Expression< E >
typedef E	ExpressionType
	The derived expression type (made available to expression-template machinery). More...

Public Member Functions
	VectorSlice (VectorType &v, const SliceType &s)
	Constructs the proxy viewing the slice s of v. More...

Reference	operator() (SizeType i)
	Returns a mutable reference to the element at index i of the view. More...

ConstReference	operator() (SizeType i) const
	Returns a `const` reference to the element at index i of the view. More...

Reference	operator[] (SizeType i)
	Returns a mutable reference to the element at index i of the view (alias for operator()). More...

ConstReference	operator[] (SizeType i) const
	Returns a `const` reference to the element at index i of the view (alias for operator()). More...

SizeType	getStart () const
	Returns the start index of the slice within the wrapped vector. More...

DifferenceType	getStride () const
	Returns the stride of the slice (step between successive viewed elements). More...

SizeType	getSize () const
	Returns the size of the view (number of elements covered by the slice). More...

bool	isEmpty () const
	Tells whether the view is empty (zero-length slice). More...

VectorClosureType &	getData ()
	Returns a reference to the wrapped vector (via its stored closure). More...

const VectorClosureType &	getData () const
	Returns a `const` reference to the wrapped vector (via its stored closure). More...

VectorSlice &	operator= (const VectorSlice &s)
	Copies the elements of s into this view (writing through to the wrapped vector). More...

template<typename E >
VectorSlice &	operator= (const VectorExpression< E > &e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

template<typename E >
VectorSlice &	operator+= (const VectorExpression< E > &e)
	Adds the vector expression e componentwise to this view. More...

template<typename E >
VectorSlice &	operator-= (const VectorExpression< E > &e)
	Subtracts the vector expression e componentwise from this view. More...

template<typename T >
std::enable_if< IsScalar< T >::value, VectorSlice >::type &	operator*= (const T &t)
	Multiplies every element of this view by the scalar t. More...

template<typename T >
std::enable_if< IsScalar< T >::value, VectorSlice >::type &	operator/= (const T &t)
	Divides every element of this view by the scalar t. More...

template<typename E >
VectorSlice &	assign (const VectorExpression< E > &e)
	Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...

template<typename E >
VectorSlice &	plusAssign (const VectorExpression< E > &e)
	Adds the vector expression e to this view without intermediate temporary. More...

template<typename E >
VectorSlice &	minusAssign (const VectorExpression< E > &e)
	Subtracts the vector expression e from this view without intermediate temporary. More...

void	swap (VectorSlice &s)
	Swaps the elements of this view with those of s. More...

Public Member Functions inherited from CDPL::Math::VectorExpression< VectorSlice< V > >
const ExpressionType &	operator() () const
	Returns a `const` reference to the derived vector expression. More...

ExpressionType &	operator() ()
	Returns a reference to the derived vector expression. More...

Friends
void	swap (VectorSlice &s1, VectorSlice &s2)
	ADL-enabled free-function form of swap(). More...

Additional Inherited Members
Protected Member Functions inherited from CDPL::Math::VectorExpression< VectorSlice< V > >
	VectorExpression ()

	~VectorExpression ()

Protected Member Functions inherited from CDPL::Math::Expression< E >
	Expression ()

	~Expression ()

Detailed Description

template<typename V>
class CDPL::Math::VectorSlice< V >

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

Template Parameters

V	The wrapped vector type.

Member Typedef Documentation

◆ VectorType

template<typename V >

typedef V CDPL::Math::VectorSlice< V >::VectorType

The wrapped vector type.

◆ SizeType

template<typename V >

typedef V::SizeType CDPL::Math::VectorSlice< V >::SizeType

The size type used by the wrapped vector.

◆ DifferenceType

template<typename V >

typedef V::DifferenceType CDPL::Math::VectorSlice< V >::DifferenceType

The signed difference type used by the wrapped vector.

◆ ValueType

template<typename V >

typedef V::ValueType CDPL::Math::VectorSlice< V >::ValueType

The element value type of the wrapped vector.

◆ ConstReference

template<typename V >

typedef V::ConstReference CDPL::Math::VectorSlice< V >::ConstReference

Constant reference type to an element.

◆ Reference

template<typename V >

typedef std::conditional<std::is_const<V>::value, typename V::ConstReference, typename V::Reference>::type CDPL::Math::VectorSlice< V >::Reference

Mutable reference type (degrades to ConstReference when the wrapped vector is const).

◆ VectorClosureType

template<typename V >

typedef std::conditional<std::is_const<V>::value, typename V::ConstClosureType, typename V::ClosureType>::type CDPL::Math::VectorSlice< V >::VectorClosureType

Closure type used to store the wrapped vector internally (mutable or const flavor).

◆ ConstClosureType

template<typename V >

typedef const SelfType CDPL::Math::VectorSlice< V >::ConstClosureType

Constant closure type used when this proxy appears inside another expression.

◆ ClosureType

template<typename V >

typedef SelfType CDPL::Math::VectorSlice< V >::ClosureType

Closure type used when this proxy appears inside another expression.

◆ SliceType

template<typename V >

typedef Slice<SizeType, DifferenceType> CDPL::Math::VectorSlice< V >::SliceType

The Math::Slice type defining the (start, stride, size) selection.

Constructor & Destructor Documentation

◆ VectorSlice()

template<typename V >

CDPL::Math::VectorSlice< V >::VectorSlice	(	VectorType &	v,
		const SliceType &	s
	)

inline

Constructs the proxy viewing the slice s of v.

Parameters

v	The wrapped vector.
s	The slice (start, stride, size) selecting the viewed elements.

Member Function Documentation

◆ operator()() [1/2]

template<typename V >

Reference CDPL::Math::VectorSlice< V >::operator() ( SizeType i )

inline

Returns a mutable reference to the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns: A mutable reference to the underlying element v(slice(i)).

◆ operator()() [2/2]

template<typename V >

ConstReference CDPL::Math::VectorSlice< V >::operator() ( SizeType i ) const

inline

Returns a const reference to the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns: A const reference to the underlying element v(slice(i)).

◆ operator[]() [1/2]

template<typename V >

Reference CDPL::Math::VectorSlice< V >::operator[] ( SizeType i )

inline

Returns a mutable reference to the element at index i of the view (alias for operator()).

Parameters

i	The zero-based index within the view.

Returns: A mutable reference to the underlying element.

◆ operator[]() [2/2]

template<typename V >

ConstReference CDPL::Math::VectorSlice< V >::operator[] ( SizeType i ) const

inline

Returns a const reference to the element at index i of the view (alias for operator()).

Parameters

i	The zero-based index within the view.

Returns: A const reference to the underlying element.

◆ getStart()

template<typename V >

SizeType CDPL::Math::VectorSlice< V >::getStart ( ) const

inline

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

Returns: The start index of the slice.

◆ getStride()

template<typename V >

DifferenceType CDPL::Math::VectorSlice< V >::getStride ( ) const

inline

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

Returns: The stride.

◆ getSize()

template<typename V >

SizeType CDPL::Math::VectorSlice< V >::getSize ( ) const

inline

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

Returns: The number of elements in the view.

◆ isEmpty()

template<typename V >

bool CDPL::Math::VectorSlice< V >::isEmpty ( ) const

inline

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

Returns: true if the slice is empty, and false otherwise.

◆ getData() [1/2]

template<typename V >

VectorClosureType& CDPL::Math::VectorSlice< V >::getData ( )

inline

Returns a reference to the wrapped vector (via its stored closure).

Returns: A reference to the wrapped vector closure.

◆ getData() [2/2]

template<typename V >

const VectorClosureType& CDPL::Math::VectorSlice< V >::getData ( ) const

inline

Returns a const reference to the wrapped vector (via its stored closure).

Returns: A const reference to the wrapped vector closure.

◆ operator=() [1/2]

template<typename V >

VectorSlice& CDPL::Math::VectorSlice< V >::operator= ( const VectorSlice< V > & s )

inline

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

Parameters

s	The source slice view.

Returns: A reference to itself.

◆ operator=() [2/2]

template<typename V >

template<typename E >

VectorSlice& CDPL::Math::VectorSlice< V >::operator= ( const VectorExpression< E > & e )

inline

Assigns the vector expression e to this view (writing through to the wrapped vector).

Template Parameters

E	The source vector expression type.

Parameters

e	The source vector expression.

Returns: A reference to itself.

◆ operator+=()

template<typename V >

template<typename E >

VectorSlice& CDPL::Math::VectorSlice< V >::operator+= ( const VectorExpression< E > & e )

inline

Adds the vector expression e componentwise to this view.

Template Parameters

E	The source vector expression type.

Parameters

e	The vector expression to add.

Returns: A reference to itself.

◆ operator-=()

template<typename V >

template<typename E >

VectorSlice& CDPL::Math::VectorSlice< V >::operator-= ( const VectorExpression< E > & e )

inline

Subtracts the vector expression e componentwise from this view.

Template Parameters

E	The source vector expression type.

Parameters

e	The vector expression to subtract.

Returns: A reference to itself.

◆ operator*=()

template<typename V >

template<typename T >

std::enable_if<IsScalar<T>::value, VectorSlice>::type& CDPL::Math::VectorSlice< V >::operator*= ( const T & t )

inline

Multiplies every element of this view by the scalar t.

Template Parameters

T	The scalar type.

Parameters

t	The scalar multiplier.

Returns: A reference to itself.

◆ operator/=()

template<typename V >

template<typename T >

std::enable_if<IsScalar<T>::value, VectorSlice>::type& CDPL::Math::VectorSlice< V >::operator/= ( const T & t )

inline

Divides every element of this view by the scalar t.

Template Parameters

T	The scalar type.

Parameters

t	The scalar divisor.

Returns: A reference to itself.

◆ assign()

template<typename V >

template<typename E >

VectorSlice& CDPL::Math::VectorSlice< V >::assign ( const VectorExpression< E > & e )

inline

Assigns the vector expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Template Parameters

E	The source vector expression type.

Parameters

e	The source vector expression.

Returns: A reference to itself.

◆ plusAssign()

template<typename V >

template<typename E >

VectorSlice& CDPL::Math::VectorSlice< V >::plusAssign ( const VectorExpression< E > & e )

inline

Adds the vector expression e to this view without intermediate temporary.

Template Parameters

E	The source vector expression type.

Parameters

e	The source vector expression.

Returns: A reference to itself.

◆ minusAssign()

template<typename V >

template<typename E >

VectorSlice& CDPL::Math::VectorSlice< V >::minusAssign ( const VectorExpression< E > & e )

inline

Subtracts the vector expression e from this view without intermediate temporary.

Template Parameters

E	The source vector expression type.

Parameters

e	The source vector expression.

Returns: A reference to itself.

◆ swap()

template<typename V >

void CDPL::Math::VectorSlice< V >::swap ( VectorSlice< V > & s )

inline

Swaps the elements of this view with those of s.

Parameters

s	The view to swap with.

Friends And Related Function Documentation

◆ swap

template<typename V >

void swap	(	VectorSlice< V > &	s1,
		VectorSlice< V > &	s2
	)

friend

ADL-enabled free-function form of swap().

Parameters

s1	The first view.
s2	The second view.

The documentation for this class was generated from the following file:

VectorProxy.hpp

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<typename V> class CDPL::Math::VectorSlice< V >

Member Typedef Documentation

◆ VectorType

◆ SizeType

◆ DifferenceType

◆ ValueType

◆ ConstReference

◆ Reference

◆ VectorClosureType

◆ ConstClosureType

◆ ClosureType

◆ SliceType

Constructor & Destructor Documentation

◆ VectorSlice()

Member Function Documentation

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ getStart()

◆ getStride()

◆ getSize()

◆ isEmpty()

◆ getData() [1/2]

◆ getData() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator*=()

◆ operator/=()

◆ assign()

◆ plusAssign()

◆ minusAssign()

◆ swap()

Friends And Related Function Documentation

◆ swap

template<typename V>
class CDPL::Math::VectorSlice< V >