index.hh

// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena is free software: you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation, version 2 of the License.
//
// Olena is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_UTIL_INDEX_HH
# define MLN_UTIL_INDEX_HH

# include <mln/core/concept/object.hh>


namespace mln
{

  namespace util
  {

    // Forward declaration.
    template <typename Tag> struct dindex_;


    template <typename Tag = void>
    struct index_ // : public Object< index_<Tag> >
    {
      typedef Object<void> category;

      typedef dindex_<Tag> dpsite;

      typedef int coord;
      enum { dim = 1 };

      int i_;

      index_() {}
      index_(int i) : i_(i) {}

      index_<Tag>& operator++()
      {
        ++i_; // Pre-inc.
        return *this;
      }

      index_<Tag> operator++(int)
      {
        index_<Tag> cpy(i_ + 1);
        ++i_; // Post-inc.
        return cpy;
      }

      index_<Tag>& operator--()
      {
        --i_; // Pre-dec.
        return *this;
      }

      index_<Tag> operator--(int)
      {
        index_<Tag> cpy(i_ + 1);
        --i_; // Post-dec.
        return cpy;
      }

      bool operator<(const index_& rhs) const
      {
        return i_ < rhs.i_;
      }

      bool operator<(int i) const
      {
        return i_ < i;
      }

      operator int() const { return i_; }
    };

    typedef index_<void> index;



# ifndef MLN_INCLUDE_ONLY

    // FIXME

# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::util

} // end of namespace mln


# include <mln/util/dindex.hh>


#endif // ! MLN_UTIL_INDEX_HH