Eigen::InnerIterator< XprType > Class Template Reference

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

#include <CoreIterators.h>

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

Protected Types
typedef internal::inner_iterator_selector< XprType, typename internal::evaluator_traits< XprType >::Kind >	IteratorType
typedef internal::evaluator< XprType >	EvaluatorType
typedef internal::traits< XprType >::Scalar	Scalar

Protected Attributes
EvaluatorType	m_eval
IteratorType	m_iter

Private Member Functions
template<typename T >
	InnerIterator (const EigenBase< T > &, Index outer)

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

Member Typedef Documentation

EvaluatorType

template<typename XprType >

typedef internal::evaluator<XprType> Eigen::InnerIterator< XprType >::EvaluatorType

protected

IteratorType

template<typename XprType >

typedef internal::inner_iterator_selector<XprType, typename internal::evaluator_traits<XprType>::Kind> Eigen::InnerIterator< XprType >::IteratorType

protected

Scalar

template<typename XprType >

typedef internal::traits<XprType>::Scalar Eigen::InnerIterator< XprType >::Scalar

protected

Constructor & Destructor Documentation

InnerIterator() [1/2]

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

: m_eval(xpr), m_iter(m_eval, outerId, xpr.innerSize()) {}

InnerIterator() [2/2]

template<typename XprType >

template<typename T >

Eigen::InnerIterator< XprType >::InnerIterator ( const EigenBase< T > &  , Index  outer  )

private

Member Function Documentation

col()

template<typename XprType >

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

inline

Returns

the column index of the current coefficient.

{ return m_iter.col(); }

References Eigen::InnerIterator< XprType >::m_iter.

index()

template<typename XprType >

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

inline

Returns

the column or row index of the current coefficient.

{ return m_iter.index(); }

References Eigen::InnerIterator< XprType >::m_iter.

Referenced by Eigen::internal::binary_evaluator< CwiseBinaryOp< BinaryOp, Lhs, Rhs >, IteratorBased, IteratorBased >::InnerIterator::operator++(), Eigen::internal::sparse_disjunction_evaluator< XprType, IteratorBased, IteratorBased >::InnerIterator::operator++(), and sparse_block().

operator bool()

template<typename XprType >

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

inline

Returns

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

{ return m_iter; }

References Eigen::InnerIterator< XprType >::m_iter.

operator+()

template<typename XprType >

EIGEN_STRONG_INLINE InnerIterator Eigen::InnerIterator< XprType >::operator+ ( Index  i )

inline

                                                       {
    InnerIterator result(*this);
    result += i;
    return result;
  }

References i.

operator++()

template<typename XprType >

EIGEN_STRONG_INLINE 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

                                                  {
    m_iter.operator++();
    return *this;
  }

References Eigen::InnerIterator< XprType >::m_iter.

operator+=()

template<typename XprType >

EIGEN_STRONG_INLINE InnerIterator& Eigen::InnerIterator< XprType >::operator+= ( Index  i )

inline

                                                         {
    m_iter.operator+=(i);
    return *this;
  }

References i, and Eigen::InnerIterator< XprType >::m_iter.

row()

template<typename XprType >

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

inline

Returns

the row index of the current coefficient.

{ return m_iter.row(); }

References Eigen::InnerIterator< XprType >::m_iter.

value()

template<typename XprType >

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

inline

Returns

the value of the current coefficient.

{ return m_iter.value(); }

References Eigen::InnerIterator< XprType >::m_iter.

Member Data Documentation

m_eval

template<typename XprType >

EvaluatorType Eigen::InnerIterator< XprType >::m_eval

protected

m_iter

template<typename XprType >

IteratorType Eigen::InnerIterator< XprType >::m_iter

protected

Referenced by Eigen::InnerIterator< XprType >::col(), Eigen::InnerIterator< XprType >::index(), Eigen::InnerIterator< XprType >::operator bool(), Eigen::InnerIterator< XprType >::operator++(), Eigen::InnerIterator< XprType >::operator+=(), Eigen::InnerIterator< XprType >::row(), and Eigen::InnerIterator< XprType >::value().

---

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

• CoreIterators.h