Eigen::InnerIterator< XprType > Class Template Reference

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

Detailed Description

template<typename XprType>
class Eigen::InnerIterator< XprType >

An InnerIterator allows to loop over the element of any matrix expression.

Warning

To be used with care because an evaluator is constructed every time an InnerIterator iterator is constructed.

TODO: add a usage example

Public Member Functions
Index	col () const
Index	index () const
	InnerIterator (const XprType &xpr, const Index &outerId)
	operator bool () const
InnerIterator &	operator++ ()
Index	row () const
Scalar	value () const

Constructor & Destructor Documentation

InnerIterator()

template<typename XprType>

Eigen::InnerIterator< XprType >::InnerIterator ( const XprType & xpr, const Index & outerId )

inline

Construct an iterator over the outerId -th row or column of xpr

Member Function Documentation

col()

template<typename XprType>

Index Eigen::InnerIterator< XprType >::col ( ) const

inline

Returns

the column index of the current coefficient.

index()

template<typename XprType>

Index Eigen::InnerIterator< XprType >::index ( ) const

inline

Returns

the column or row index of the current coefficient.

operator bool()

template<typename XprType>

Eigen::InnerIterator< XprType >::operator bool ( ) const

inline

Returns

true if the iterator *this still references a valid coefficient.

operator++()

template<typename XprType>

InnerIterator & Eigen::InnerIterator< XprType >::operator++ ( )

inline

Increment the iterator *this to the next non-zero coefficient. Explicit zeros are not skipped over. To skip explicit zeros, see class SparseView

row()

template<typename XprType>

Index Eigen::InnerIterator< XprType >::row ( ) const

inline

Returns

the row index of the current coefficient.

value()

template<typename XprType>

Scalar Eigen::InnerIterator< XprType >::value ( ) const

inline

Returns

the value of the current coefficient.

---

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

• /builds/libeigen/eigen/Eigen/src/Core/CoreIterators.h