Public Types | Public Member Functions | Private Types | List of all members
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]

Public Types

typedef Impl Base
 
typedef internal::remove_all< XprType >::type NestedExpression
 

Public Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Block (XprType &xpr, Index i)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Block (XprType &xpr, Index startRow, Index startCol)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Block (XprType &xpr, Index startRow, Index 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.

Template 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)
InnerPanelis true, if the block maps to a set of rows of a row major matrix or to set of columns of a column major matrix (optional). The parameter allows to determine at compile time whether aligned access is possible on the block expression.

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:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;
template<typename Derived>
{
return Eigen::Block<Derived>(m.derived(), 0, 0, rows, cols);
}
template<typename Derived>
{
return Eigen::Block<const Derived>(m.derived(), 0, 0, rows, cols);
}
int main(int, char**)
{
Matrix4d m = Matrix4d::Identity();
cout << topLeftCorner(4*m, 2, 3) << endl; // calls the const version
topLeftCorner(m, 2, 3) *= 5; // calls the non-const version
cout << "Now the matrix m is:" << endl << m << endl;
return 0;
}

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:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;
template<typename Derived>
{
return Eigen::Block<Derived, 2, 2>(m.derived(), 0, 0);
}
template<typename Derived>
{
return Eigen::Block<const Derived, 2, 2>(m.derived(), 0, 0);
}
int main(int, char**)
{
Matrix3d m = Matrix3d::Identity();
cout << topLeft2x2Corner(4*m) << endl; // calls the const version
topLeft2x2Corner(m) *= 2; // calls the non-const version
cout << "Now the matrix m is:" << endl << m << endl;
return 0;
}

Output:

See also
DenseBase::block(Index,Index,Index,Index), DenseBase::block(Index,Index), class VectorBlock

Definition at line 103 of file Block.h.

Member Typedef Documentation

◆ Base

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

Definition at line 109 of file Block.h.

◆ Impl

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

◆ NestedExpression

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
typedef internal::remove_all<XprType>::type Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::NestedExpression

Definition at line 113 of file Block.h.

Constructor & Destructor Documentation

◆ Block() [1/3]

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

Column or Row constructor

Definition at line 118 of file Block.h.

◆ Block() [2/3]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::Block ( XprType xpr,
Index  startRow,
Index  startCol 
)
inline

Fixed-size constructor

Definition at line 128 of file Block.h.

◆ Block() [3/3]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel >::Block ( XprType xpr,
Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
)
inline

Dynamic-size constructor

Definition at line 139 of file Block.h.


The documentation for this class was generated from the following file:
Eigen
Namespace containing all symbols from the Eigen library.
Definition: jet.h:637
Eigen::Block
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:103
rows
int rows
Definition: Tutorial_commainit_02.cpp:1
main
int main(int argc, char **argv)
Definition: cmake/example_cmake_find_gtsam/main.cpp:63
topLeft2x2Corner
Eigen::Block< Derived, 2, 2 > topLeft2x2Corner(MatrixBase< Derived > &m)
Definition: class_FixedBlock.cpp:8
topLeftCorner
Eigen::Block< Derived > topLeftCorner(MatrixBase< Derived > &m, int rows, int cols)
Definition: class_Block.cpp:8
m
Matrix3f m
Definition: AngleAxis_mimic_euler.cpp:1
std
Definition: BFloat16.h:88
Eigen::MatrixBase
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:48
cols
int cols
Definition: Tutorial_commainit_02.cpp:1


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:44:26