Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator Class Reference

#include <AmbiVector.h>

Public Types
typedef _Scalar	Scalar
typedef NumTraits< Scalar >::Real	RealScalar

Public Member Functions
	Iterator (const AmbiVector &vec, const RealScalar &epsilon=0)
StorageIndex	index () const
Scalar	value () const
	operator bool () const
Iterator &	operator++ ()

Protected Attributes
const AmbiVector &	m_vector
StorageIndex	m_currentEl
RealScalar	m_epsilon
StorageIndex	m_cachedIndex
Scalar	m_cachedValue
bool	m_isDense

Detailed Description

template<typename _Scalar, typename _StorageIndex>
class Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator

Iterator over the nonzero coefficients

Member Typedef Documentation

RealScalar

template<typename _Scalar , typename _StorageIndex >

typedef NumTraits<Scalar>::Real Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::RealScalar

Scalar

template<typename _Scalar , typename _StorageIndex >

typedef _Scalar Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::Scalar

Constructor & Destructor Documentation

Iterator()

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::Iterator ( const AmbiVector &  vec, const RealScalar &  epsilon = 0  )

inlineexplicit

Default constructor

Parameters

vec	the vector on which we iterate
epsilon	the minimal value used to prune zero coefficients. In practice, all coefficients having a magnitude smaller than epsilon are skipped.

Member Function Documentation

index()

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::index ( ) const

inline

operator bool()

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::operator bool ( ) const

inline

operator++()

template<typename _Scalar , typename _StorageIndex >

Iterator& Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::operator++ ( )

inline

value()

template<typename _Scalar , typename _StorageIndex >

Scalar Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::value ( ) const

inline

Member Data Documentation

m_cachedIndex

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::m_cachedIndex

protected

m_cachedValue

template<typename _Scalar , typename _StorageIndex >

Scalar Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::m_cachedValue

protected

m_currentEl

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::m_currentEl

protected

m_epsilon

template<typename _Scalar , typename _StorageIndex >

RealScalar Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::m_epsilon

protected

m_isDense

template<typename _Scalar , typename _StorageIndex >

bool Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::m_isDense

protected

m_vector

template<typename _Scalar , typename _StorageIndex >

const AmbiVector& Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Iterator::m_vector

protected

---

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

• /home/runner/work/NDDEM/NDDEM/src/CoarseGraining/Eigen/src/SparseCore/AmbiVector.h