Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator Class Reference

#include <Eigen/src/SparseCore/BlockSparseMatrix.h>

Detailed Description

template<typename Scalar_, int Options_, int BlockRows_, int BlockCols_, typename StorageIndex_ = int>
class Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator

Iterates over stored blocks in outer vector outer.

Usage mirrors SparseMatrix::InnerIterator but value() returns a Map to a BlockRows×BlockCols matrix, not a scalar.

Public Member Functions
Index	blockCol () const
Index	blockRow () const
Index	index () const
Index	outer () const
ConstBlockMap	value () const
BlockMap	valueRef ()

Member Function Documentation

blockCol()

template<typename Scalar_, int Options_, int BlockRows_, int BlockCols_, typename StorageIndex_ = int>

Index Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator::blockCol ( ) const

inline

Block-column of the current block.

blockRow()

template<typename Scalar_, int Options_, int BlockRows_, int BlockCols_, typename StorageIndex_ = int>

Index Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator::blockRow ( ) const

inline

Block-row of the current block.

index()

template<typename Scalar_, int Options_, int BlockRows_, int BlockCols_, typename StorageIndex_ = int>

Index Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator::index ( ) const

inline

Current block inner index (block-row for ColMajor, block-col for RowMajor).

outer()

template<typename Scalar_, int Options_, int BlockRows_, int BlockCols_, typename StorageIndex_ = int>

Index Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator::outer ( ) const

inline

Current block outer index (block-col for ColMajor, block-row for RowMajor).

value()

template<typename Scalar_, int Options_, int BlockRows_, int BlockCols_, typename StorageIndex_ = int>

ConstBlockMap Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator::value ( ) const

inline

Read-only Map to the current block value.

valueRef()

template<typename Scalar_, int Options_, int BlockRows_, int BlockCols_, typename StorageIndex_ = int>

BlockMap Eigen::BlockSparseMatrix< Scalar_, Options_, BlockRows_, BlockCols_, StorageIndex_ >::InnerIterator::valueRef ( )

inline

Mutable Map to the current block value.

---

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

• /builds/libeigen/eigen/Eigen/src/SparseCore/BlockSparseMatrix.h