Eigne Matrix Class Library

Dependents:   Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more

Embed: (wiki syntax)

« Back to documentation index

Block< XprType, BlockRows, BlockCols, InnerPanel > Class Template Reference

Block< XprType, BlockRows, BlockCols, InnerPanel > Class Template Reference
[Core module]

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

#include <Block.h>

Inherits BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, internal::traits< XprType >::StorageKind >.

Public Member Functions

 EIGEN_GENERIC_PUBLIC_INTERFACE (Block) EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Block) inline Block(XprType &xpr
 Column or Row constructor.
 Block (XprType &xpr, Index a_startRow, Index a_startCol)
 Fixed-size constructor.
 Block (XprType &xpr, Index a_startRow, Index a_startCol, Index blockRows, Index blockCols)
 Dynamic-size constructor.

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 103 of file Block.h.


Constructor & Destructor Documentation

Block ( XprType &  xpr,
Index  a_startRow,
Index  a_startCol 
)

Fixed-size constructor.

Definition at line 124 of file Block.h.

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

Dynamic-size constructor.

Definition at line 134 of file Block.h.


Member Function Documentation

EIGEN_GENERIC_PUBLIC_INTERFACE ( Block< XprType, BlockRows, BlockCols, InnerPanel >   )

Column or Row constructor.