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

---

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 71 of file Core.

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

List of all members.

Public Member Functions
	VectorBlock (VectorType &vector, Index start, Index size)
	Dynamic-size constructor.
	VectorBlock (VectorType &vector, Index start)
	Fixed-size constructor.
Index	rows () const
Index	cols () const
Scalar &	coeffRef (Index row, Index col)
const Scalar &	coeffRef (Index row, Index col) const
Scalar &	coeffRef (Index index)
const Scalar &	coeffRef (Index index) const
EIGEN_STRONG_INLINE const CoeffReturnType	coeff (Index row, Index col) const
const CoeffReturnType	coeff (Index index) const
PacketScalar	packet (Index row, Index col) const
PacketScalar	packet (Index index) const
void	writePacket (Index row, Index col, const PacketScalar &x)
void	writePacket (Index index, const PacketScalar &x)
const Scalar *	data () const
Index	innerStride () const
Index	outerStride () const
Protected Attributes
const VectorType::Nested	m_xpr
const internal::variable_if_dynamic < Index, VectorType::RowsAtCompileTime==1?0:Dynamic >	m_startRow
const internal::variable_if_dynamic < Index, VectorType::ColsAtCompileTime==1?0:Dynamic >	m_startCol
const internal::variable_if_dynamic < Index, RowsAtCompileTime >	m_blockRows
const internal::variable_if_dynamic < Index, ColsAtCompileTime >	m_blockCols
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

---

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 78 of file Core.

---

Member Enumeration Documentation

template<typename VectorType , int Size>

anonymous enum [private]

Enumerator:

IsColVector

Definition at line 79 of file Core.

---

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 89 of file Core.

template<typename VectorType , int Size>

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

Fixed-size constructor.

Definition at line 99 of file Core.

---

Member Function Documentation

EIGEN_STRONG_INLINE const CoeffReturnType Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::coeff	(	Index	row,
		Index	col
	)		const [inline, inherited]

Definition at line 182 of file Core.

const CoeffReturnType Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::coeff

(

Index

index

)

const [inline, inherited]

Definition at line 202 of file Core.

const Scalar& Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::coeffRef	(	Index	row,
		Index	col
	)		const [inline, inherited]

Definition at line 176 of file Core.

Scalar& Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::coeffRef

(

Index

index

)

[inline, inherited]

Definition at line 187 of file Core.

Scalar& Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::coeffRef	(	Index	row,
		Index	col
	)		[inline, inherited]

Definition at line 169 of file Core.

const Scalar& Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::coeffRef

(

Index

index

)

const [inline, inherited]

Definition at line 195 of file Core.

Index Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::cols

(

void

)

const [inline, inherited]

Definition at line 167 of file Core.

const Scalar* Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::data

(

)

const [inline, inherited]

See also:

MapBase::data()

Index Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::innerStride

(

)

const [inline, inherited]

Index Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::outerStride

(

)

const [inline, inherited]

PacketScalar Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::packet	(	Index	row,
		Index	col
	)		const [inline, inherited]

Definition at line 210 of file Core.

PacketScalar Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::packet

(

Index

index

)

const [inline, inherited]

Definition at line 224 of file Core.

Index Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::rows

(

void

)

const [inline, inherited]

Definition at line 166 of file Core.

void Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::writePacket	(	Index	index,
		const PacketScalar &	x
	)		[inline, inherited]

Definition at line 232 of file Core.

void Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::writePacket	(	Index	row,
		Index	col,
		const PacketScalar &	x
	)		[inline, inherited]

Definition at line 217 of file Core.

---

Member Data Documentation

const internal::variable_if_dynamic<Index, ColsAtCompileTime> Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::m_blockCols [protected, inherited]

Definition at line 252 of file Core.

const internal::variable_if_dynamic<Index, RowsAtCompileTime> Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::m_blockRows [protected, inherited]

Definition at line 251 of file Core.

const internal::variable_if_dynamic<Index, VectorType ::ColsAtCompileTime == 1 ? 0 : Dynamic> Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::m_startCol [protected, inherited]

Definition at line 250 of file Core.

const internal::variable_if_dynamic<Index, VectorType ::RowsAtCompileTime == 1 ? 0 : Dynamic> Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::m_startRow [protected, inherited]

Definition at line 249 of file Core.

const VectorType ::Nested Eigen::Block< VectorType , BlockRows, BlockCols, InnerPanel, HasDirectAccess >::m_xpr [protected, inherited]

Definition at line 248 of file Core.