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.

                                                                          : m_vector(vec) {
    using std::abs;
    m_epsilon = epsilon;
    m_isDense = m_vector.m_mode == IsDense;
    if (m_isDense) {
      m_currentEl = 0;    // this is to avoid a compilation warning
      m_cachedValue = 0;  // this is to avoid a compilation warning
      m_cachedIndex = m_vector.m_start - 1;
      ++(*this);
    } else {
      ListEl* EIGEN_RESTRICT llElements = reinterpret_cast<ListEl*>(m_vector.m_buffer);
      m_currentEl = m_vector.m_llStart;
      while (m_currentEl >= 0 && abs(llElements[m_currentEl].value) <= m_epsilon)
        m_currentEl = llElements[m_currentEl].next;
      if (m_currentEl < 0) {
        m_cachedValue = 0;  // this is to avoid a compilation warning
        m_cachedIndex = -1;
      } else {
        m_cachedIndex = llElements[m_currentEl].index;
        m_cachedValue = llElements[m_currentEl].value;
      }
    }
  }

References abs(), EIGEN_RESTRICT, oomph::SarahBL::epsilon, Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::ListEl::index, Eigen::IsDense, and Eigen::value.

Member Function Documentation

index()

template<typename Scalar_ , typename StorageIndex_ >

StorageIndex Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::Iterator::index ( ) const

inline

{ return m_cachedIndex; }

operator bool()

template<typename Scalar_ , typename StorageIndex_ >

Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::Iterator::operator bool ( ) const

inline

{ return m_cachedIndex >= 0; }

operator++()

template<typename Scalar_ , typename StorageIndex_ >

Iterator& Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::Iterator::operator++ ( )

inline

                         {
    using std::abs;
    if (m_isDense) {
      do {
        ++m_cachedIndex;
      } while (m_cachedIndex < m_vector.m_end && abs(m_vector.m_buffer[m_cachedIndex]) <= m_epsilon);
      if (m_cachedIndex < m_vector.m_end)
        m_cachedValue = m_vector.m_buffer[m_cachedIndex];
      else
        m_cachedIndex = -1;
    } else {
      ListEl* EIGEN_RESTRICT llElements = reinterpret_cast<ListEl*>(m_vector.m_buffer);
      do {
        m_currentEl = llElements[m_currentEl].next;
      } while (m_currentEl >= 0 && abs(llElements[m_currentEl].value) <= m_epsilon);
      if (m_currentEl < 0) {
        m_cachedIndex = -1;
      } else {
        m_cachedIndex = llElements[m_currentEl].index;
        m_cachedValue = llElements[m_currentEl].value;
      }
    }
    return *this;
  }

References abs(), EIGEN_RESTRICT, Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::ListEl::next, and Eigen::value.

value()

template<typename Scalar_ , typename StorageIndex_ >

Scalar Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::Iterator::value ( ) const

inline

{ return m_cachedValue; }

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:

• AmbiVector.h