NestedIterator.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_NestedIterator__H__
#define __stir_NestedIterator__H__

#include "stir/NestedIteratorHelpers.h"
#include "boost/iterator/iterator_traits.hpp"

START_NAMESPACE_STIR

template <typename topleveliterT, class GetRestRangeFunctionT = BeginEndFunction<topleveliterT>>
class NestedIterator
{
private:
  typedef typename GetRestRangeFunctionT::rest_iter_type rest_iter_type;

public:
  typedef std::forward_iterator_tag iterator_category;
  typedef typename boost::iterator_difference<rest_iter_type>::type difference_type;
  typedef typename boost::iterator_value<rest_iter_type>::type value_type;
  typedef typename boost::iterator_reference<rest_iter_type>::type reference;
  typedef typename boost::iterator_pointer<rest_iter_type>::type pointer;

public:
  inline NestedIterator();

  inline NestedIterator(const topleveliterT& top_level_iter, const topleveliterT& end_top_level_iter);


  template <typename othertopleveliterT, typename otherGetRestRangeFunctionT>
  inline NestedIterator(
      NestedIterator<othertopleveliterT, otherGetRestRangeFunctionT> other,
      typename boost::enable_if_convertible<othertopleveliterT, topleveliterT>::type* = 0,
      typename boost::enable_if_convertible<typename otherGetRestRangeFunctionT::rest_iter_type, rest_iter_type>::type* = 0)
      : _current_top_level_iter(other._current_top_level_iter),
        _end_top_level_iter(other._end_top_level_iter),
        _current_rest_iter(other._current_rest_iter),
        _end_rest_iter(other._end_rest_iter)
  {}

  // inline NestedIterator& operator=(const NestedIterator&);

  inline NestedIterator& operator++();

  inline NestedIterator operator++(int);

  inline bool operator==(const NestedIterator&) const;
  inline bool operator!=(const NestedIterator&) const;

  inline reference operator*() const;

  inline pointer operator->() const;

#ifdef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
public:
#else
private:
  // needed for conversion constructor
  template <class, class>
  friend class NestedIterator;
#endif

  topleveliterT _current_top_level_iter;

  topleveliterT _end_top_level_iter;

  rest_iter_type _current_rest_iter;

  rest_iter_type _end_rest_iter;

private:
  void _set_rest_iters_for_current_top_level_iter();
};

END_NAMESPACE_STIR

#include "stir/NestedIterator.inl"

#endif