Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Attributes

AmbiVector< _Scalar, _Index >::Iterator Class Reference


Detailed Description

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

Iterator over the nonzero coefficients.

Definition at line 290 of file AmbiVector.h.

#include <src/Sparse/AmbiVector.h>

List of all members.

Public Types

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

Public Member Functions

 Iterator (const AmbiVector &vec, RealScalar epsilon=RealScalar(0.1)*NumTraits< RealScalar >::dummy_precision())
 Default constructor.
Index index () const
Scalar value () const
 operator bool () const
Iteratoroperator++ ()

Protected Attributes

const AmbiVectorm_vector
Index m_currentEl
RealScalar m_epsilon
Index m_cachedIndex
Scalar m_cachedValue
bool m_isDense

Member Typedef Documentation

template<typename _Scalar , typename _Index >
typedef NumTraits<Scalar>::Real AmbiVector< _Scalar, _Index >::Iterator::RealScalar

Definition at line 294 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
typedef _Scalar AmbiVector< _Scalar, _Index >::Iterator::Scalar

Definition at line 293 of file AmbiVector.h.


Constructor & Destructor Documentation

template<typename _Scalar , typename _Index >
AmbiVector< _Scalar, _Index >::Iterator::Iterator ( const AmbiVector vec,
RealScalar  epsilon = RealScalar(0.1)*NumTraits<RealScalar>::dummy_precision() 
) [inline]

Default constructor.

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

Definition at line 302 of file AmbiVector.h.

References abs(), EIGEN_RESTRICT, AmbiVector< _Scalar, _Index >::ListEl::index, and IsDense.


Member Function Documentation

template<typename _Scalar , typename _Index >
Index AmbiVector< _Scalar, _Index >::Iterator::index ( ) const [inline]

Definition at line 333 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
AmbiVector< _Scalar, _Index >::Iterator::operator bool ( void  ) const [inline]

Definition at line 336 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
Iterator& AmbiVector< _Scalar, _Index >::Iterator::operator++ ( ) [inline]

Definition at line 338 of file AmbiVector.h.

References abs(), EIGEN_RESTRICT, and AmbiVector< _Scalar, _Index >::ListEl::next.

template<typename _Scalar , typename _Index >
Scalar AmbiVector< _Scalar, _Index >::Iterator::value ( void  ) const [inline]

Definition at line 334 of file AmbiVector.h.


Member Data Documentation

template<typename _Scalar , typename _Index >
Index AmbiVector< _Scalar, _Index >::Iterator::m_cachedIndex [protected]

Definition at line 373 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
Scalar AmbiVector< _Scalar, _Index >::Iterator::m_cachedValue [protected]

Definition at line 374 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
Index AmbiVector< _Scalar, _Index >::Iterator::m_currentEl [protected]

Definition at line 371 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
RealScalar AmbiVector< _Scalar, _Index >::Iterator::m_epsilon [protected]

Definition at line 372 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
bool AmbiVector< _Scalar, _Index >::Iterator::m_isDense [protected]

Definition at line 375 of file AmbiVector.h.

template<typename _Scalar , typename _Index >
const AmbiVector& AmbiVector< _Scalar, _Index >::Iterator::m_vector [protected]

Definition at line 370 of file AmbiVector.h.




Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011