RangeIterator Class Reference

This iterator is able to generate all possible identifiers, from a
fully bounded Range. More...

#include <RangeIterator.h>

Collaboration diagram for RangeIterator:

Public Types
using	iterator_category = std::forward_iterator_tag
using	difference_type = std::ptrdiff_t
using	value_type = ExpandedIdentifier
using	pointer = ExpandedIdentifier *
using	reference = ExpandedIdentifier &

Public Member Functions
	RangeIterator ()=default
	RangeIterator (Range &range)
RangeIterator &	operator++ ()
RangeIterator	begin () const
RangeIterator	end () const
pointer	operator-> ()
ExpandedIdentifier &	operator* ()
bool	operator== (const RangeIterator &other) const

Private Attributes
std::vector< std::size_t >	m_indices
ExpandedIdentifier	m_id
ExpandedIdentifier	m_min
ExpandedIdentifier	m_max
const Range *	m_range {}

Detailed Description

This iterator is able to generate all possible identifiers, from a
fully bounded Range.

The precondition is that the Range used to parameterize the iterator
must have all its fields completely bounded.

Definition at line 19 of file RangeIterator.h.

Member Typedef Documentation

difference_type

using RangeIterator::difference_type = std::ptrdiff_t

Definition at line 22 of file RangeIterator.h.

iterator_category

using RangeIterator::iterator_category = std::forward_iterator_tag

Definition at line 21 of file RangeIterator.h.

pointer

using RangeIterator::pointer = ExpandedIdentifier*

Definition at line 24 of file RangeIterator.h.

reference

using RangeIterator::reference = ExpandedIdentifier&

Definition at line 25 of file RangeIterator.h.

value_type

using RangeIterator::value_type = ExpandedIdentifier

Definition at line 23 of file RangeIterator.h.

Constructor & Destructor Documentation

RangeIterator() [1/2]

RangeIterator::RangeIterator ( )

default

RangeIterator() [2/2]

RangeIterator::RangeIterator

(

Range &

range

)

Fill all running identifiers m_id : the current id m_min : the set of low bounds m_max : the set of high bounds

Definition at line 41 of file RangeIterator.cxx.

                                          : m_range (&range) { 
  for (Range::size_type i = 0; i < range.fields (); ++i) { 
    Range::element_type minimum; 
    Range::element_type maximum; 
    m_indices.push_back (0); 
    const Range::field& f = range[i]; 
    if (f.empty()){
      m_id << 0; 
      m_min << 0; 
      m_max << 0; 
    } else {
      minimum = f.get_minimum (); 
      maximum = f.get_maximum (); 
      m_id << minimum; 
      m_min << minimum; 
      m_max << maximum; 
    }
  } 
} 

Member Function Documentation

begin()

RangeIterator RangeIterator::begin

(

)

const

Definition at line 12 of file RangeIterator.cxx.

                          { 
  return (*this); 
} 

end()

RangeIterator RangeIterator::end

(

)

const

Definition at line 24 of file RangeIterator.cxx.

                          { 
  Range r; 
  RangeIterator factory(r); 
  return (factory); 
} 

operator*()

ExpandedIdentifier & RangeIterator::operator*

(

)

Definition at line 137 of file RangeIterator.cxx.

                          { 
  return (m_id); 
} 

operator++()

RangeIterator & RangeIterator::operator++

(

)

The local range is not exceeded. increase the value then reset the remaining fields.

The current range field was exhausted check the previous one.

Definition at line 71 of file RangeIterator.cxx.

                           { 
  if (m_id.fields () == 0) return *this; 
  Range::size_type fields = m_id.fields (); 
  Range::size_type i = fields - 1; 
 
    // 
    // Starting from the end, we try to increment the m_id fields 
    // If at a given position it's not possible (max reached) 
    // then we move back one pos and try again. 
    // 
    //  As soon as increment is possible, then the rest of the m_id 
    // is reset to min values. 
    // 
 
  for (;;) { 
      const Range::field& f = (*m_range)[i]; 
      bool done = false; 
      Range::element_type value = 0; 
 
      if (f.isEnumerated()) { 
          Range::size_type index = m_indices[i]; 
          index++; 
          if (index < f.get_indices ()) { 
              m_indices[i] = index; 
              value = f.get_value_at (index); 
              done = true; 
            } 
        } else { 
          value = m_id[i]; 
          if (value < m_max[i]) { 
              ++value; 
              done = true; 
          } 
      } 
      if (done) { 
          m_id[i] = value; 
          for (++i; i < fields; ++i) { 
              m_indices[i] = 0; 
              m_id[i] = m_min[i]; 
          } 
           
          break; 
        } 
 
      if (i == 0) { 
          m_id.clear (); 
          break; 
      } 
        
      --i; 
        
    } 
    return *this;
} 

operator->()

pointer RangeIterator::operator-> ( )

inline

Definition at line 34 of file RangeIterator.h.

{ return &m_id; }

operator==()

bool RangeIterator::operator==

(

const RangeIterator &

other

)

const

Definition at line 143 of file RangeIterator.cxx.

                                                            { 
  if (m_id == other.m_id) return (true); 
  return (false); 
} 

Member Data Documentation

m_id

ExpandedIdentifier RangeIterator::m_id

private

Definition at line 40 of file RangeIterator.h.

m_indices

std::vector<std::size_t> RangeIterator::m_indices

private

Definition at line 39 of file RangeIterator.h.

m_max

ExpandedIdentifier RangeIterator::m_max

private

Definition at line 42 of file RangeIterator.h.

m_min

ExpandedIdentifier RangeIterator::m_min

private

Definition at line 41 of file RangeIterator.h.

m_range

const Range* RangeIterator::m_range {}

private

Definition at line 43 of file RangeIterator.h.

---

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

• RangeIterator.h
• RangeIterator.cxx