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

#include <AmbiVector.h>

List of all members.

Public Types
typedef NumTraits< Scalar >::Real	RealScalar
typedef _Scalar	Scalar
Public Member Functions
Index	index () const
	Iterator (const AmbiVector &vec, const RealScalar &epsilon=0)
	operator bool () const
Iterator &	operator++ ()
Scalar	value () const
Protected Attributes
Index	m_cachedIndex
Scalar	m_cachedValue
Index	m_currentEl
RealScalar	m_epsilon
bool	m_isDense
const AmbiVector &	m_vector

---

Detailed Description

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

Iterator over the nonzero coefficients

Definition at line 279 of file AmbiVector.h.

---

Member Typedef Documentation

template<typename _Scalar , typename _Index >

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

Definition at line 283 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

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

Definition at line 282 of file AmbiVector.h.

---

Constructor & Destructor Documentation

template<typename _Scalar , typename _Index >

Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::Iterator	(	const AmbiVector &	vec,
		const RealScalar &	epsilon = 0
	)		[inline]

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 291 of file AmbiVector.h.

---

Member Function Documentation

template<typename _Scalar , typename _Index >

Index Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::index

(

)

const [inline]

Definition at line 323 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::operator bool

(

)

const [inline]

Definition at line 326 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

Iterator& Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::operator++

(

)

[inline]

Definition at line 328 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

Scalar Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::value

(

)

const [inline]

Definition at line 324 of file AmbiVector.h.

---

Member Data Documentation

template<typename _Scalar , typename _Index >

Index Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::m_cachedIndex [protected]

Definition at line 364 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

Scalar Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::m_cachedValue [protected]

Definition at line 365 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

Index Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::m_currentEl [protected]

Definition at line 362 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

RealScalar Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::m_epsilon [protected]

Definition at line 363 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

bool Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::m_isDense [protected]

Definition at line 366 of file AmbiVector.h.

template<typename _Scalar , typename _Index >

const AmbiVector& Eigen::internal::AmbiVector< _Scalar, _Index >::Iterator::m_vector [protected]

Definition at line 361 of file AmbiVector.h.

---

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

• AmbiVector.h