Enumerate.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include <iterator>
#include <iostream>

namespace Moose
{
// Forward Declarations of helper objects
template <class Iterator>
struct _enumerate_struct;

template <class Iterator>
struct _enumerate_iterator;

template <class Iterator>
struct _enumerate_range;

template <class Iterator>
_enumerate_range<Iterator>
enumerate(Iterator first,
          Iterator last,
          typename std::iterator_traits<Iterator>::difference_type initial)
{
  return _enumerate_range<Iterator>(first, last, initial);
}

template <class Container>
_enumerate_range<typename Container::iterator>
enumerate(Container & content)
{
  return _enumerate_range<typename Container::iterator>(std::begin(content), std::end(content), 0);
}

template <class Container>
_enumerate_range<typename Container::const_iterator>
enumerate(const Container & content)
{
  return _enumerate_range<typename Container::const_iterator>(
      std::begin(content), std::end(content), 0);
}

// Helper object
template <class Iterator>
struct _enumerate_struct
{
  using iterator = Iterator;
  using index_type = typename std::iterator_traits<iterator>::difference_type;
  using reference = typename std::iterator_traits<iterator>::reference;

  _enumerate_struct(index_type index, iterator iterator) : l_index(index), l_iter(iterator) {}

  index_type index() { return l_index; }

  reference value() { return *l_iter; }

private:
  index_type l_index;
  iterator l_iter;
};

// Helper object
template <class Iterator>
struct _enumerate_iterator
{
  using iterator = Iterator;
  using index_type = typename std::iterator_traits<iterator>::difference_type;
  using reference = typename std::iterator_traits<iterator>::reference;

  _enumerate_iterator(index_type index, iterator iterator) : index(index), iter(iterator) {}

  _enumerate_iterator & operator++()
  {
    ++index;
    ++iter;
    return *this;
  }

  bool operator!=(const _enumerate_iterator & other) const { return iter != other.iter; }

  _enumerate_struct<iterator> operator*() { return _enumerate_struct<iterator>(index, iter); }

private:
  index_type index;
  iterator iter;
};

template <class Iterator>
struct _enumerate_range
{
  using index_type = typename std::iterator_traits<Iterator>::difference_type;
  using iterator = _enumerate_iterator<Iterator>;

  _enumerate_range(Iterator first, Iterator last, index_type initial)
    : first(first), last(last), initial(initial)
  {
  }

  iterator begin() const { return iterator(initial, first); }

  iterator end() const { return iterator(0, last); }

private:
  Iterator first;
  Iterator last;
  index_type initial;
};
}