Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::Iterator Class Reference

#include <Eigen/src/SparseCore/AmbiVector.h>

Detailed Description

template<typename Scalar_, typename StorageIndex_>
class Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::Iterator

Iterator over the nonzero coefficients

Public Member Functions
	Iterator (const AmbiVector &vec, const RealScalar &epsilon=0)
Index	nonZeros () const
void	restart ()
void	setBounds (Index start, Index end)
void	setZero ()

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

nonZeros()

Index Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::nonZeros

(

)

const

Returns

the number of non zeros in the current sub vector

restart()

void Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::restart

(

)

Must be called whenever we might perform a write access with an index smaller than the previous one.

Don't worry, this function is extremely cheap.

setBounds()

void Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::setBounds ( Index start, Index end )

inline

Specifies a sub-vector to work on

setZero()

void Eigen::internal::AmbiVector< Scalar_, StorageIndex_ >::setZero

(

)

Set all coefficients of current subvector to zero

---

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

• /builds/libeigen/eigen/Eigen/src/SparseCore/AmbiVector.h