Eigen  3.4.90 (git rev 9589cc4e7fd8e4538bedef80dd36c7738977a8be)
 
Loading...
Searching...
No Matches
List of all members
Eigen::IndexedView< XprType, RowIndices, ColIndices > Class Template Reference
Dense matrix and array manipulation » Reference » Core module

#include <Eigen/src/Core/IndexedView.h>

Detailed Description

template<typename XprType, typename RowIndices, typename ColIndices>
class Eigen::IndexedView< XprType, RowIndices, ColIndices >

Expression of a non-sequential sub-matrix defined by arbitrary sequences of row and column indices.

Template Parameters
XprTypethe type of the expression in which we are taking the intersections of sub-rows and sub-columns
RowIndicesthe type of the object defining the sequence of row indices
ColIndicesthe type of the object defining the sequence of column indices

This class represents an expression of a sub-matrix (or sub-vector) defined as the intersection of sub-sets of rows and columns, that are themself defined by generic sequences of row indices $\{r_0,r_1,..r_{m-1}\} $ and column indices $ \{c_0,c_1,..c_{n-1} \}$. Let $ A $ be the nested matrix, then the resulting matrix $ B $ has m rows and n columns, and its entries are given by: $ B(i,j) = A(r_i,c_j) $.

The RowIndices and ColIndices types must be compatible with the following API:

<integral type> operator[](Index) const;
Index size() const;
Eigen::Index
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition Meta.h:82

Typical supported types thus include:

  • std::vector<int>
  • std::valarray<int>
  • std::array<int>
  • Eigen::ArrayXi
  • decltype(ArrayXi::LinSpaced(...))
  • Any view/expressions of the previous types
  • Eigen::ArithmeticSequence
  • Eigen::internal::AllRange (helper for Eigen::placeholders::all)
  • Eigen::internal::SingleRange (helper for single index)
  • etc.

In typical usages of Eigen, this class should never be used directly. It is the return type of DenseBase::operator()(const RowIndices&, const ColIndices&).

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