LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
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:
lar::sparse_vector< T >::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_iteratoroperator++ ()
 Increment and decrement operators. More...
 
const_iterator operator++ (int)
 Increment and decrement operators. More...
 
const_iteratoroperator+= (difference_type delta)
 Increment and decrement operators. More...
 
const_iteratoroperator-= (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_tcont
 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 1459 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 1489 of file sparse_vector.h.

template<typename T>
typedef sparse_vector<T> lar::sparse_vector< T >::const_iterator::container_t
protected

Definition at line 1467 of file sparse_vector.h.

Definition at line 1484 of file sparse_vector.h.

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

Definition at line 1474 of file sparse_vector.h.

Definition at line 1485 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 1469 of file sparse_vector.h.

Definition at line 1486 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 1468 of file sparse_vector.h.

Definition at line 1483 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 1492 of file sparse_vector.h.

1492 : cont(nullptr), index(0), currentRange() {}
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
size_type index
pointer to the current value, as absolute index
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 1495 of file sparse_vector.h.

1496  : cont(&c), index(std::min(offset, c.size())), currentRange()
1497  {
1498  refresh_state();
1499  }
void refresh_state()
Reassigns the internal state according to the index.
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
size_type index
pointer to the current value, as absolute index
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 1502 of file sparse_vector.h.

1503  : cont(&c), index(0), currentRange(c.get_ranges().begin())
1504  {}
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
size_type index
pointer to the current value, as absolute index
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 1507 of file sparse_vector.h.

1508  : cont(&c), index(c.size()), currentRange(c.get_ranges().end())
1509  {}
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
size_type index
pointer to the current value, as absolute index

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 1568 of file sparse_vector.h.

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

1568 { return currentRange; }
ranges_const_iterator currentRange
pointer to the current (or next) range
template<typename T>
bool lar::sparse_vector< T >::const_iterator::operator!= ( const const_iterator as) const
inline

Iterator comparisons.

Definition at line 1545 of file sparse_vector.h.

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

1546  {
1547  return (cont != as.cont) || (index != as.index);
1548  }
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute 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 2423 of file sparse_vector.h.

2424 {
2425  // no container, no idea what to do
2426  if (!cont) throw std::out_of_range("iterator to no sparse vector");
2427 
2428  // index beyond the end: can't return any reference
2429  if (index >= cont->size()) return value_zero;
2430 
2431  // are we in a valid range? if not, we are past the last range
2432  if (currentRange == cont->ranges.end()) return value_zero;
2433 
2434  // if the index is beyond the current range, we are in the void
2435  if (index < currentRange->begin_index()) return value_zero;
2436 
2437  return (*currentRange)[index];
2438 } // lar::sparse_vector<T>::const_iterator::operator*()
size_type size() const
Returns the size of the vector.
static constexpr value_type value_zero
a representation of 0
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
range_list_t ranges
list of ranges
size_type index
pointer to the current value, as absolute index
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 2458 of file sparse_vector.h.

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

2460 {
2461  if ((currentRange == cont->ranges.end()) || !currentRange->includes(index + delta))
2462  return const_iterator(*cont, index + delta);
2463  const_iterator iter(*this);
2464  iter.index += delta;
2465  return iter;
2466 } // lar::sparse_vector<T>::const_iterator::operator+()
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
range_list_t ranges
list of ranges
size_type index
pointer to the current value, as absolute index
const_iterator()
Default constructor, does not iterate anywhere.
template<typename T >
lar::sparse_vector< T >::const_iterator & lar::sparse_vector< T >::const_iterator::operator++ ( )

Increment and decrement operators.

Definition at line 2403 of file sparse_vector.h.

2404 {
2405  // no container, not doing anything;
2406  // index beyond the end: stays there
2407  if (!cont || (index >= cont->size())) return *this;
2408 
2409  // increment the internal index
2410  ++index;
2411 
2412  // were we in a valid range?
2413  if (currentRange != cont->ranges.end()) {
2414  // if the new index is beyond the current range, pick the next
2415  if (currentRange->end_index() <= index) ++currentRange;
2416  }
2417  // if we have no valid range, we are forever in the void
2418  return *this;
2419 } // lar::sparse_vector<T>::iterator::operator++()
size_type size() const
Returns the size of the vector.
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
range_list_t ranges
list of ranges
size_type index
pointer to the current value, as absolute index
template<typename T>
const_iterator lar::sparse_vector< T >::const_iterator::operator++ ( int  )
inline
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 2441 of file sparse_vector.h.

2443 {
2444  if (delta == 1) return this->operator++();
2445  index += delta;
2446  if ((currentRange == cont->ranges.end()) || !currentRange->includes(index)) refresh_state();
2447  return *this;
2448 } // lar::sparse_vector<T>::const_iterator::operator+=()
void refresh_state()
Reassigns the internal state according to the index.
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
range_list_t ranges
list of ranges
const_iterator & operator++()
Increment and decrement operators.
size_type index
pointer to the current value, as absolute index
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 2470 of file sparse_vector.h.

References lar::operator+().

2471 {
2472  return this->operator+(-delta);
2473 }
const_iterator operator+(difference_type delta) const
Increment and decrement operators.
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 2478 of file sparse_vector.h.

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

2479 {
2480  if (cont != iter.cont) {
2481  throw std::runtime_error("lar::sparse_vector::const_iterator:"
2482  " difference with alien iterator");
2483  }
2484  return index - iter.index;
2485 } // lar::sparse_vector<T>::const_iterator::operator-(const_iterator)
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute index
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 2452 of file sparse_vector.h.

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

2453 {
2454  return this->operator+=(-delta);
2455 }
const_iterator & operator+=(difference_type delta)
Increment and decrement operators.
template<typename T>
bool lar::sparse_vector< T >::const_iterator::operator< ( const const_iterator than) const
inline

Iterator comparisons.

Definition at line 1549 of file sparse_vector.h.

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

1550  {
1551  return (cont == than.cont) && (index < than.index);
1552  }
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute index
template<typename T>
bool lar::sparse_vector< T >::const_iterator::operator<= ( const const_iterator than) const
inline

Iterator comparisons.

Definition at line 1557 of file sparse_vector.h.

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

1558  {
1559  return (cont == than.cont) && (index <= than.index);
1560  }
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute index
template<typename T>
bool lar::sparse_vector< T >::const_iterator::operator== ( const const_iterator as) const
inline

Iterator comparisons.

Definition at line 1541 of file sparse_vector.h.

1542  {
1543  return (cont == as.cont) && (index == as.index);
1544  }
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute index
template<typename T>
bool lar::sparse_vector< T >::const_iterator::operator> ( const const_iterator than) const
inline

Iterator comparisons.

Definition at line 1553 of file sparse_vector.h.

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

1554  {
1555  return (cont == than.cont) && (index > than.index);
1556  }
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute index
template<typename T>
bool lar::sparse_vector< T >::const_iterator::operator>= ( const const_iterator than) const
inline

Iterator comparisons.

Definition at line 1561 of file sparse_vector.h.

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

1562  {
1563  return (cont == than.cont) && (index >= than.index);
1564  }
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute index
template<typename T>
const_reference lar::sparse_vector< T >::const_iterator::operator[] ( size_type  offset) const
inline

Random access.

Definition at line 1512 of file sparse_vector.h.

References operator*().

1512 { return (*cont)[index + offset]; }
const container_t * cont
pointer to the container
size_type index
pointer to the current value, as absolute index
template<typename T >
void lar::sparse_vector< T >::const_iterator::refresh_state ( )
protected

Reassigns the internal state according to the index.

Definition at line 2488 of file sparse_vector.h.

2489 {
2490  // update the currentRange
2491  // currentRange is the range including the current item, or next to it
2492  if (cont) {
2493  // the following is actually the range after the index:
2495  // if the index is inside the previous index, then we want to move there:
2496  if (currentRange != cont->ranges.begin()) {
2497  if ((currentRange - 1)->end_index() > index) --currentRange;
2498  }
2499  }
2500  else {
2501  currentRange = {};
2502  }
2503 } // lar::sparse_vector<T>::const_iterator::refresh_state()
const container_t * cont
pointer to the container
ranges_const_iterator currentRange
pointer to the current (or next) range
range_list_t ranges
list of ranges
range_iterator find_next_range_iter(size_type index)
Returns an iterator to the range after index.
size_type index
pointer to the current value, as absolute index

Friends And Related Function Documentation

template<typename T>
friend class container_t
friend

Definition at line 1465 of file sparse_vector.h.

Member Data Documentation

template<typename T>
ranges_const_iterator lar::sparse_vector< T >::const_iterator::currentRange
protected

pointer to the current (or next) range

Definition at line 1603 of file sparse_vector.h.


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