Public Types | Public Member Functions | Private Types
Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel > Class Template Reference

Expression of a fixed-size or dynamic-size block. More...

#include <Block.h>

Inheritance diagram for Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Impl Base

Public Member Functions

 Block (XprType &xpr, Index i)
 Block (XprType &xpr, Index a_startRow, Index a_startCol)
 Block (XprType &xpr, Index a_startRow, Index a_startCol, Index blockRows, Index blockCols)

Private Types

typedef BlockImpl< XprType,
BlockRows, BlockCols,
InnerPanel, typename
internal::traits< XprType >
::StorageKind > 
Impl

Detailed Description

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
class Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >

Expression of a fixed-size or dynamic-size block.

Parameters:
XprTypethe type of the expression in which we are taking a block
BlockRowsthe number of rows of the block we are taking at compile time (optional)
BlockColsthe number of columns of the block we are taking at compile time (optional)

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

However, if you want to directly maniputate block 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 XprType 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:
DenseBase::block(Index,Index,Index,Index), DenseBase::block(Index,Index), class VectorBlock

Definition at line 102 of file Core/Block.h.


Member Typedef Documentation

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
typedef Impl Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::Base

Reimplemented in Eigen::VectorBlock< VectorType, Size >.

Definition at line 108 of file Core/Block.h.

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
typedef BlockImpl<XprType, BlockRows, BlockCols, InnerPanel, typename internal::traits<XprType>::StorageKind> Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::Impl [private]

Definition at line 105 of file Core/Block.h.


Constructor & Destructor Documentation

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::Block ( XprType &  xpr,
Index  i 
) [inline]

Column or Row constructor

Definition at line 114 of file Core/Block.h.

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::Block ( XprType &  xpr,
Index  a_startRow,
Index  a_startCol 
) [inline]

Fixed-size constructor

Definition at line 123 of file Core/Block.h.

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::Block ( XprType &  xpr,
Index  a_startRow,
Index  a_startCol,
Index  blockRows,
Index  blockCols 
) [inline]

Dynamic-size constructor

Definition at line 133 of file Core/Block.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:30