Eigen::VectorBlock< VectorType, Size > Class Template Reference

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

#include <VectorBlock.h>

Inheritance diagram for Eigen::VectorBlock< VectorType, Size >:

List of all members.

Public Member Functions
	VectorBlock (VectorType &vector, Index start, Index size)
	VectorBlock (VectorType &vector, Index start)
Private Types
enum	{ IsColVector = !(internal::traits<VectorType>::Flags & RowMajorBit) }
typedef Block< VectorType, internal::traits< VectorType > ::Flags &RowMajorBit?1:Size, internal::traits< VectorType > ::Flags &RowMajorBit?Size:1 >	Base

---

Detailed Description

template<typename VectorType, int Size>
class Eigen::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)

Definition at line 57 of file Core/VectorBlock.h.

---

Member Typedef Documentation

template<typename VectorType, int Size>

typedef Block<VectorType, internal::traits<VectorType>::Flags & RowMajorBit ? 1 : Size, internal::traits<VectorType>::Flags & RowMajorBit ? Size : 1> Eigen::VectorBlock< VectorType, Size >::Base [private]

Reimplemented from Eigen::Block< VectorType, internal::traits< VectorType >::Flags &RowMajorBit?1:Size, internal::traits< VectorType >::Flags &RowMajorBit?Size:1 >.

Definition at line 64 of file Core/VectorBlock.h.

---

Member Enumeration Documentation

template<typename VectorType, int Size>

anonymous enum [private]

Enumerator:

IsColVector

Definition at line 65 of file Core/VectorBlock.h.

---

Constructor & Destructor Documentation

template<typename VectorType, int Size>

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

Dynamic-size constructor

Definition at line 75 of file Core/VectorBlock.h.

template<typename VectorType, int Size>

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

Fixed-size constructor

Definition at line 85 of file Core/VectorBlock.h.

---

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

• Core/VectorBlock.h