Public Types | Public Member Functions | Protected Attributes | List of all members
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
 
Iteratoroperator++ ()
 
Scalar value () const
 

Protected Attributes

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

Detailed Description

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

Iterator over the nonzero coefficients

Definition at line 284 of file AmbiVector.h.

Member Typedef Documentation

◆ RealScalar

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

Definition at line 288 of file AmbiVector.h.

◆ Scalar

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

Definition at line 287 of file AmbiVector.h.

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

Member Function Documentation

◆ index()

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

Definition at line 328 of file AmbiVector.h.

◆ operator bool()

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

Definition at line 331 of file AmbiVector.h.

◆ operator++()

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

Definition at line 333 of file AmbiVector.h.

◆ value()

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

Definition at line 329 of file AmbiVector.h.

Member Data Documentation

◆ m_cachedIndex

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

Definition at line 369 of file AmbiVector.h.

◆ m_cachedValue

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

Definition at line 370 of file AmbiVector.h.

◆ m_currentEl

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

Definition at line 367 of file AmbiVector.h.

◆ m_epsilon

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

Definition at line 368 of file AmbiVector.h.

◆ m_isDense

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

Definition at line 371 of file AmbiVector.h.

◆ m_vector

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

Definition at line 366 of file AmbiVector.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:44:21