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

#include <ForwardDeclarations.h>

Public Member Functions
EIGEN_DEVICE_FUNC	VectorBlock (VectorType &vector, Index start)

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

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

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

Template 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 87 of file ForwardDeclarations.h.

Member Typedef Documentation

◆ Base

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

private

Definition at line 63 of file VectorBlock.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
IsColVector

Definition at line 64 of file VectorBlock.h.

Constructor & Destructor Documentation

◆ VectorBlock() [1/2]

EIGEN_DEVICE_FUNC Eigen::VectorBlock::VectorBlock	(	VectorType &	vector,
		Index	start,
		Index	size
	)

inline

Dynamic-size constructor

Definition at line 75 of file VectorBlock.h.

◆ VectorBlock() [2/2]

EIGEN_DEVICE_FUNC Eigen::VectorBlock::VectorBlock	(	VectorType &	vector,
		Index	start
	)

inline

Fixed-size constructor

Definition at line 86 of file VectorBlock.h.

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

Public Member Functions

Private Types