InputIteratorWithRankOnSequence.h

#pragma once

#if defined(InputIteratorWithRankOnSequence_RECURSES)
#error Recursive header files inclusion detected in InputIteratorWithRankOnSequence.h
#else // defined(InputIteratorWithRankOnSequence_RECURSES)

#define InputIteratorWithRankOnSequence_RECURSES

#if !defined InputIteratorWithRankOnSequence_h

#define InputIteratorWithRankOnSequence_h

// Inclusions
#include <iostream>
#include <iterator>
#include "DGtal/base/Common.h"
#include "DGtal/base/CountedPtr.h"
#include "DGtal/kernel/CInteger.h"

namespace DGtal
{

  // template class InputIteratorWithRankOnSequence
  template <typename TSequence, typename TRank = typename TSequence::difference_type>
  class InputIteratorWithRankOnSequence
  {
    // ----------------------- public types ------------------------------
  public:
    BOOST_CONCEPT_ASSERT(( boost::Sequence<TSequence> ));
    BOOST_CONCEPT_ASSERT(( CInteger<TRank> ));

    typedef TSequence Sequence;
    typedef TRank Rank;
    typedef InputIteratorWithRankOnSequence<Sequence,Rank> Self;
    typedef typename Sequence::value_type SequenceValue;
    typedef std::pair<SequenceValue,Rank> Value;
    typedef typename Sequence::const_iterator ConstIterator;
    typedef const Value* Pointer;

    // ----------------------- std types ----------------------------------
    typedef Value value_type;
    typedef typename Sequence::size_type size_type;
    typedef typename Sequence::difference_type difference_type;
    typedef Pointer pointer;
    typedef const value_type& reference;
    typedef const reference const_reference;
    typedef std::input_iterator_tag iterator_category;

    // ----------------------- Standard services ------------------------------
  public:

    ~InputIteratorWithRankOnSequence();

    InputIteratorWithRankOnSequence( const Sequence & seq, ConstIterator it );

    InputIteratorWithRankOnSequence( Sequence* ptrSeq, ConstIterator it );

    InputIteratorWithRankOnSequence( const CountedPtr<Sequence> & ptrSeq, ConstIterator it );

    InputIteratorWithRankOnSequence ( const Self & other );

    Self & operator= ( const Self & other );

    Value operator*() const;

    Pointer operator->() const;

    Self& operator++();

    Self operator++( int );

    bool operator==( const Self & other ) const;

    bool operator!=( const Self & other ) const;

    // ----------------------- Interface --------------------------------------
  public:

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:

    CountedPtr<Sequence> mySequence;
    ConstIterator myIterator;
    Value myTmpValue;

    // ------------------------- Hidden services ------------------------------
  protected:
    InputIteratorWithRankOnSequence();

    // ------------------------- Internals ------------------------------------
  private:

  }; // end of class InputIteratorWithRankOnSequence


  template <typename TSequence, typename TRank>
  std::ostream&
  operator<< ( std::ostream & out, const InputIteratorWithRankOnSequence<TSequence, TRank> & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/base/InputIteratorWithRankOnSequence.ih"

//                                                                           //

#endif // !defined InputIteratorWithRankOnSequence_h

#undef InputIteratorWithRankOnSequence_RECURSES
#endif // else defined(InputIteratorWithRankOnSequence_RECURSES)