FullArrayIterator.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_FullArrayIterator__H__
#define __stir_FullArrayIterator__H__

#include "stir/common.h"
#include <iterator>
#include "boost/iterator/iterator_adaptor.hpp"

START_NAMESPACE_STIR

template <typename topleveliterT, typename restiterT, typename elemT, typename _Ref, typename _Ptr>
class FullArrayIterator
{
public:
  typedef std::forward_iterator_tag iterator_category;
  typedef std::ptrdiff_t difference_type;

  typedef elemT value_type;
  typedef _Ref reference;
  typedef _Ptr pointer;

public:
  inline FullArrayIterator();

  inline FullArrayIterator(const FullArrayIterator&);

  inline FullArrayIterator(const topleveliterT& top_level_iter,
                           const topleveliterT& last_top_level_iter,
                           const restiterT& rest_iter,
                           const restiterT& last_rest_iter);


  template <typename othertopleveliterT, typename otherrestiterT, typename _otherRef, typename _otherPtr>
  FullArrayIterator(FullArrayIterator<othertopleveliterT, otherrestiterT, elemT, _otherRef, _otherPtr> const& other,
                    typename boost::enable_if_convertible<othertopleveliterT, topleveliterT>::type* = 0,
                    typename boost::enable_if_convertible<otherrestiterT, restiterT>::type* = 0)
      : current_top_level_iter(other.current_top_level_iter),
        last_top_level_iter(other.last_top_level_iter),
        current_rest_iter(other.current_rest_iter),
        last_rest_iter(other.last_rest_iter)
  {}


  inline FullArrayIterator(unsigned);

  // assignment is generated by compiler
  // inline FullArrayIterator& operator=(const FullArrayIterator&);

  inline FullArrayIterator& operator++();

  inline FullArrayIterator operator++(int);

  inline bool operator==(const FullArrayIterator&) const;
  inline bool operator!=(const FullArrayIterator&) 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, class, class, class>
  friend class FullArrayIterator;
#endif

  topleveliterT current_top_level_iter;

  topleveliterT last_top_level_iter;

  restiterT current_rest_iter;

  restiterT last_rest_iter;
};

END_NAMESPACE_STIR

#include "stir/FullArrayIterator.inl"

#endif