lar::sparse_vector< T >::const_iterator Class Reference

Iterator to the sparse vector values. More...

#include "sparse_vector.h"

Inheritance diagram for lar::sparse_vector< T >::const_iterator:

Classes
struct	special
	Namespace for special initialization. More...

Public Types
typedef std::forward_iterator_tag	iterator_category
typedef container_t::value_type	value_type
typedef container_t::difference_type	difference_type
typedef container_t::pointer	pointer
typedef container_t::reference	reference
typedef vector_t::const_reference	const_reference

Public Member Functions
	const_iterator ()
	Default constructor, does not iterate anywhere. More...
	const_iterator (const container_t &c, size_type offset)
	Constructor from a container and a offset. More...
	const_iterator (const container_t &c, const typename special::begin)
	Special constructor: initializes at the beginning of the container. More...
	const_iterator (const container_t &c, const typename special::end)
	Special constructor: initializes at the end of the container. More...
const_reference	operator[] (size_type offset) const
	Random access. More...
const_reference	operator* () const
	Constant dereferenciation operator. More...
difference_type	operator- (const const_iterator &iter) const
	Distance operator. More...
range_const_iterator	get_current_range () const
	Returns the current range internal value; use it at your own risk!! More...
const_iterator &	operator++ ()
	Increment and decrement operators. More...
const_iterator	operator++ (int)
	Increment and decrement operators. More...
const_iterator &	operator+= (difference_type delta)
	Increment and decrement operators. More...
const_iterator &	operator-= (difference_type delta)
	Increment and decrement operators. More...
const_iterator	operator+ (difference_type delta) const
	Increment and decrement operators. More...
const_iterator	operator- (difference_type delta) const
	Increment and decrement operators. More...
bool	operator== (const const_iterator &as) const
	Iterator comparisons. More...
bool	operator!= (const const_iterator &as) const
	Iterator comparisons. More...
bool	operator< (const const_iterator &than) const
	Iterator comparisons. More...
bool	operator> (const const_iterator &than) const
	Iterator comparisons. More...
bool	operator<= (const const_iterator &than) const
	Iterator comparisons. More...
bool	operator>= (const const_iterator &than) const
	Iterator comparisons. More...

Protected Types
typedef sparse_vector< T >	container_t
typedef container_t::size_type	size_type
typedef container_t::range_list_t::const_iterator	ranges_const_iterator

Protected Member Functions
void	refresh_state ()
	Reassigns the internal state according to the index. More...

Protected Attributes
const container_t *	cont
	pointer to the container More...
size_type	index
	pointer to the current value, as absolute index More...
ranges_const_iterator	currentRange
	pointer to the current (or next) range More...

Friends
class	container_t

Detailed Description

template<typename T>
class lar::sparse_vector< T >::const_iterator

Iterator to the sparse vector values.

Definition at line 1247 of file sparse_vector.h.

Member Typedef Documentation

template<typename T>

typedef vector_t::const_reference lar::sparse_vector< T >::const_iterator::const_reference

Definition at line 1278 of file sparse_vector.h.

template<typename T>

typedef sparse_vector<T> lar::sparse_vector< T >::const_iterator::container_t

protected

Definition at line 1255 of file sparse_vector.h.

template<typename T>

typedef container_t::difference_type lar::sparse_vector< T >::const_iterator::difference_type

Definition at line 1273 of file sparse_vector.h.

template<typename T>

typedef std::forward_iterator_tag lar::sparse_vector< T >::const_iterator::iterator_category

Definition at line 1263 of file sparse_vector.h.

template<typename T>

typedef container_t::pointer lar::sparse_vector< T >::const_iterator::pointer

Definition at line 1274 of file sparse_vector.h.

template<typename T>

typedef container_t::range_list_t::const_iterator lar::sparse_vector< T >::const_iterator::ranges_const_iterator

protected

Definition at line 1257 of file sparse_vector.h.

template<typename T>

typedef container_t::reference lar::sparse_vector< T >::const_iterator::reference

Definition at line 1275 of file sparse_vector.h.

template<typename T>

typedef container_t::size_type lar::sparse_vector< T >::const_iterator::size_type

protected

Definition at line 1256 of file sparse_vector.h.

template<typename T>

typedef container_t::value_type lar::sparse_vector< T >::const_iterator::value_type

Definition at line 1272 of file sparse_vector.h.

Constructor & Destructor Documentation

template<typename T>

lar::sparse_vector< T >::const_iterator::const_iterator ( )

inline

Default constructor, does not iterate anywhere.

Definition at line 1282 of file sparse_vector.h.

: cont(nullptr), index(0), currentRange() {}

template<typename T>

lar::sparse_vector< T >::const_iterator::const_iterator ( const container_t &  c, size_type  offset  )

inline

Constructor from a container and a offset.

Definition at line 1285 of file sparse_vector.h.

                                                              :
                cont(&c), index(std::min(offset, c.size())), currentRange()
                { refresh_state(); }

template<typename T>

lar::sparse_vector< T >::const_iterator::const_iterator ( const container_t &  c, const typename special::begin    )

inline

Special constructor: initializes at the beginning of the container.

Definition at line 1290 of file sparse_vector.h.

                                                                         :
                cont(&c), index(0), currentRange(c.get_ranges().begin())
                {}

template<typename T>

lar::sparse_vector< T >::const_iterator::const_iterator ( const container_t &  c, const typename special::end    )

inline

Special constructor: initializes at the end of the container.

Definition at line 1295 of file sparse_vector.h.

                                                                       :
                cont(&c), index(c.size()), currentRange(c.get_ranges().end())
                {}

Member Function Documentation

template<typename T>

range_const_iterator lar::sparse_vector< T >::const_iterator::get_current_range ( ) const

inline

Returns the current range internal value; use it at your own risk!!

Definition at line 1342 of file sparse_vector.h.

Referenced by lar::sparse_vector< T >::make_void().

{ return currentRange; }

template<typename T>

bool lar::sparse_vector< T >::const_iterator::operator!= ( const const_iterator &  as ) const

inline

Iterator comparisons.

Definition at line 1329 of file sparse_vector.h.

References lar::sparse_vector< T >::const_iterator::cont, and lar::sparse_vector< T >::const_iterator::index.

                { return (cont != as.cont) || (index != as.index); }

template<typename T >

lar::sparse_vector< T >::const_iterator::const_reference lar::sparse_vector< T >::const_iterator::operator*

(

)

const

Constant dereferenciation operator.

Definition at line 2132 of file sparse_vector.h.

                                                   {
        // no container, no idea what to do
        if (!cont) throw std::out_of_range("iterator to no sparse vector");
        
        // index beyond the end: can't return any reference
        if (index >= cont->size()) return value_zero;
        
        // are we in a valid range? if not, we are past the last range
        if (currentRange == cont->ranges.end()) return value_zero;
        
        // if the index is beyond the current range, we are in the void
        if (index < currentRange->begin_index()) return value_zero;
        
        return (*currentRange)[index];
} // lar::sparse_vector<T>::const_iterator::operator*()

template<typename T >

lar::sparse_vector< T >::const_iterator lar::sparse_vector< T >::const_iterator::operator+

(

difference_type

delta

)

const

Increment and decrement operators.

Definition at line 2170 of file sparse_vector.h.

References lar::sparse_vector< T >::const_iterator::index.

{
        if ((currentRange == cont->ranges.end())
                || !currentRange->includes(index + delta)
                )
                return const_iterator(*cont, index + delta);
        const_iterator iter(*this);
        iter.index += delta;
        return iter;
} // lar::sparse_vector<T>::const_iterator::operator+()

template<typename T >

lar::sparse_vector< T >::const_iterator & lar::sparse_vector< T >::const_iterator::operator++

(

)

Increment and decrement operators.

Definition at line 2112 of file sparse_vector.h.

                                              {
        // no container, not doing anything;
        // index beyond the end: stays there
        if (!cont || (index >= cont->size())) return *this;
        
        // increment the internal index
        ++index;
        
        // were we in a valid range?
        if (currentRange != cont->ranges.end()) {
                // if the new index is beyond the current range, pick the next
                if (currentRange->end_index() <= index) ++currentRange;
        }
        // if we have no valid range, we are forever in the void
        return *this;
} // lar::sparse_vector<T>::iterator::operator++()

template<typename T>

const_iterator lar::sparse_vector< T >::const_iterator::operator++ ( int  )

inline

Increment and decrement operators.

Definition at line 1309 of file sparse_vector.h.

References lar::sparse_vector< T >::const_iterator::cont, lar::sparse_vector< T >::const_iterator::index, lar::operator+(), shims::map< Key, T, Compare, Allocator >::iter< Category, TT, Distance, Pointer, Reference >::operator++(), lar::dump::operator+=(), operator-(), and geo::details::operator==().

                { const_iterator copy(*this); const_iterator::operator++(); return copy; }

template<typename T >

lar::sparse_vector< T >::const_iterator & lar::sparse_vector< T >::const_iterator::operator+=

(

difference_type

delta

)

Increment and decrement operators.

Definition at line 2151 of file sparse_vector.h.

{
        if (delta == 1) return this->operator++();
        index += delta;
        if ((currentRange == cont->ranges.end())
                || !currentRange->includes(index)
                )
                refresh_state();
        return *this;
} // lar::sparse_vector<T>::const_iterator::operator+=()

template<typename T >

lar::sparse_vector< T >::const_iterator lar::sparse_vector< T >::const_iterator::operator- ( difference_type  delta ) const

inline

Increment and decrement operators.

Definition at line 2183 of file sparse_vector.h.

References lar::operator+().

        { return this->operator+ (-delta); }

template<typename T >

lar::sparse_vector< T >::const_iterator::difference_type lar::sparse_vector< T >::const_iterator::operator- ( const const_iterator &  iter ) const

inline

Distance operator.

distance operator

Definition at line 2191 of file sparse_vector.h.

{
        if (cont != iter.cont) {
                throw std::runtime_error("lar::sparse_vector::const_iterator:"
                        " difference with alien iterator");
        }
        return index -iter.index;
} // lar::sparse_vector<T>::const_iterator::operator-(const_iterator)

template<typename T >

lar::sparse_vector< T >::const_iterator & lar::sparse_vector< T >::const_iterator::operator-= ( difference_type  delta )

inline

Increment and decrement operators.

Definition at line 2164 of file sparse_vector.h.

References lar::dump::operator+=().

        { return this->operator+= (-delta); }

template<typename T>

bool lar::sparse_vector< T >::const_iterator::operator< ( const const_iterator &  than ) const

inline

Iterator comparisons.

Definition at line 1331 of file sparse_vector.h.

References lar::sparse_vector< T >::const_iterator::cont, and lar::sparse_vector< T >::const_iterator::index.

                { return (cont == than.cont) && (index < than.index); }

template<typename T>

bool lar::sparse_vector< T >::const_iterator::operator<= ( const const_iterator &  than ) const

inline

Iterator comparisons.

Definition at line 1335 of file sparse_vector.h.

References lar::sparse_vector< T >::const_iterator::cont, and lar::sparse_vector< T >::const_iterator::index.

                { return (cont == than.cont) && (index <= than.index); }

template<typename T>

bool lar::sparse_vector< T >::const_iterator::operator== ( const const_iterator &  as ) const

inline

Iterator comparisons.

Definition at line 1327 of file sparse_vector.h.

                { return (cont == as.cont) && (index == as.index); }

template<typename T>

bool lar::sparse_vector< T >::const_iterator::operator> ( const const_iterator &  than ) const

inline

Iterator comparisons.

Definition at line 1333 of file sparse_vector.h.

References lar::sparse_vector< T >::const_iterator::cont, and lar::sparse_vector< T >::const_iterator::index.

                { return (cont == than.cont) && (index > than.index); }

template<typename T>

bool lar::sparse_vector< T >::const_iterator::operator>= ( const const_iterator &  than ) const

inline

Iterator comparisons.

Definition at line 1337 of file sparse_vector.h.

References lar::sparse_vector< T >::const_iterator::cont, and lar::sparse_vector< T >::const_iterator::index.

                { return (cont == than.cont) && (index >= than.index); }

template<typename T>

const_reference lar::sparse_vector< T >::const_iterator::operator[] ( size_type  offset ) const

inline

Random access.

Definition at line 1300 of file sparse_vector.h.

References operator*().

                { return (*cont)[index + offset]; }

template<typename T >

void lar::sparse_vector< T >::const_iterator::refresh_state ( )

protected

Reassigns the internal state according to the index.

Definition at line 2202 of file sparse_vector.h.

                                                      {
        // update the currentRange
        // currentRange is the range including the current item, or next to it
        if (cont) {
                // the following is actually the range after the index:
                currentRange = cont->find_next_range_iter(index);
                // if the index is inside the previous index, then we want to move there:
                if (currentRange != cont->ranges.begin()) {
                        if ((currentRange - 1)->end_index() > index) --currentRange;
                }
        }
        else {
                currentRange = {};
        }
} // lar::sparse_vector<T>::const_iterator::refresh_state()

Friends And Related Function Documentation

template<typename T>

friend class container_t

friend

Definition at line 1253 of file sparse_vector.h.

Member Data Documentation

template<typename T>

const container_t* lar::sparse_vector< T >::const_iterator::cont

protected

pointer to the container

Definition at line 1375 of file sparse_vector.h.

Referenced by lar::sparse_vector< T >::make_void(), lar::sparse_vector< T >::const_iterator::operator!=(), lar::sparse_vector< T >::const_iterator::operator++(), lar::sparse_vector< T >::const_iterator::operator<(), lar::sparse_vector< T >::const_iterator::operator<=(), lar::sparse_vector< T >::const_iterator::operator>(), and lar::sparse_vector< T >::const_iterator::operator>=().

template<typename T>

ranges_const_iterator lar::sparse_vector< T >::const_iterator::currentRange

protected

pointer to the current (or next) range

Definition at line 1377 of file sparse_vector.h.

template<typename T>

size_type lar::sparse_vector< T >::const_iterator::index

protected

pointer to the current value, as absolute index

Definition at line 1376 of file sparse_vector.h.

Referenced by lar::sparse_vector< T >::make_void(), lar::sparse_vector< T >::const_iterator::operator!=(), lar::sparse_vector< T >::const_iterator::operator+(), lar::sparse_vector< T >::const_iterator::operator++(), lar::sparse_vector< T >::const_iterator::operator<(), lar::sparse_vector< T >::const_iterator::operator<=(), lar::sparse_vector< T >::const_iterator::operator>(), and lar::sparse_vector< T >::const_iterator::operator>=().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lardataobj/v07_06_00/source/lardataobj/Utilities/sparse_vector.h