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

#include <AmbiVector.h>

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

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

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

Detailed Description

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

Iterator over the nonzero coefficients

Definition at line 283 of file AmbiVector.h.

Member Typedef Documentation

template<typename _Scalar , typename _StorageIndex >

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

Definition at line 287 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

Definition at line 286 of file AmbiVector.h.

Constructor & Destructor Documentation

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.

Definition at line 295 of file AmbiVector.h.

Member Function Documentation

template<typename _Scalar , typename _StorageIndex >

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

inline

Definition at line 327 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

inline

Definition at line 330 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

inline

Definition at line 332 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

inline

Definition at line 328 of file AmbiVector.h.

Member Data Documentation

template<typename _Scalar , typename _StorageIndex >

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

protected

Definition at line 368 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

protected

Definition at line 369 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

protected

Definition at line 366 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

protected

Definition at line 367 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

protected

Definition at line 370 of file AmbiVector.h.

template<typename _Scalar , typename _StorageIndex >

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

protected

Definition at line 365 of file AmbiVector.h.

---

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

• AmbiVector.h