Public Member Functions

VectorBlock< VectorType, Size > Class Template Reference

Expression of a fixed-size or dynamic-size sub-vector. More...

#include <VectorBlock.h>

Inheritance diagram for VectorBlock< VectorType, Size >:
Block< VectorType, internal::traits< VectorType >::Flags &RowMajorBit?1:Size, internal::traits< VectorType >::Flags &RowMajorBit?Size:1 > type

List of all members.

Public Member Functions

 VectorBlock (VectorType &vector, Index start, Index size)
 VectorBlock (VectorType &vector, Index start)

Detailed Description

template<typename VectorType, int Size>
class VectorBlock< VectorType, Size >

Expression of a fixed-size or dynamic-size sub-vector.

Parameters:
VectorType the type of the object in which we are taking a sub-vector
Size size of the sub-vector we are taking at compile time (optional)

This class represents an expression of either a fixed-size or dynamic-size sub-vector. It is the return type of DenseBase::segment(Index,Index) and DenseBase::segment<int>(Index) and most of the time this is the only way it is used.

However, if you want to directly maniputate sub-vector expressions, for instance if you want to write a function returning such an expression, you will need to use this class.

Here is an example illustrating the dynamic case:

Output:

Note:
Even though this expression has dynamic size, in the case where VectorType has fixed size, this expression inherits a fixed maximal size which means that evaluating it does not cause a dynamic memory allocation.

Here is an example illustrating the fixed-size case:

Output:

See also:
class Block, DenseBase::segment(Index,Index,Index,Index), DenseBase::segment(Index,Index)

Constructor & Destructor Documentation

template<typename VectorType, int Size>
VectorBlock< VectorType, Size >::VectorBlock ( VectorType &  vector,
Index  start,
Index  size 
) [inline]

Dynamic-size constructor

template<typename VectorType, int Size>
VectorBlock< VectorType, Size >::VectorBlock ( VectorType &  vector,
Index  start 
) [inline]

Fixed-size constructor


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