faces_iter.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_TOPO_ATTIC_FACES_ITER_HH
# define MLN_TOPO_ATTIC_FACES_ITER_HH


# include <mln/topo/internal/complex_set_iterator_base.hh>
# include <mln/topo/n_face.hh>

namespace mln
{

  namespace topo
  {

    /*------------------------------.
    | topo::faces_fwd_iter_<N, D>.  |
    `------------------------------*/

    template <unsigned N, unsigned D>
    class faces_fwd_iter_
      : public internal::complex_set_iterator_base< n_face<N, D>,
                                                    faces_fwd_iter_<N, D> >
    {
    public:
      typedef n_face<N, D> face;

    private:
      typedef faces_fwd_iter_<N, D> self_;
      typedef internal::complex_set_iterator_base< face, self_ > super_;

    public:
      using super_::is_valid;
      using super_::invalidate;

    public:
      faces_fwd_iter_();
      // FIXME: See comment in internal::complex_set_iterator_base's
      // default ctor.
      faces_fwd_iter_(complex<D>& c);

      void start();
      void next_();

    private:
      using super_::face_;
    };


    /*------------------------------.
    | topo::faces_bkd_iter_<N, D>.  |
    `------------------------------*/

    template <unsigned N, unsigned D>
    class faces_bkd_iter_
      : public internal::complex_set_iterator_base< n_face<N, D>,
                                                    faces_bkd_iter_<N, D> >
    {
    public:
      typedef n_face<N, D> face;

    private:
      typedef faces_bkd_iter_<N, D> self_;
      typedef internal::complex_set_iterator_base< face, self_ > super_;

    public:
      using super_::is_valid;
      using super_::invalidate;

    public:
      faces_bkd_iter_();
      // FIXME: See comment in internal::complex_set_iterator_base's
      // default ctor.
      faces_bkd_iter_(complex<D>& c);

      void start();
      void next_();

    private:
      using super_::face_;
    };



# ifndef MLN_INCLUDE_ONLY

    /*------------------------------.
    | topo::faces_fwd_iter_<N, D>.  |
    `------------------------------*/

    template <unsigned N, unsigned D>
    inline
    faces_fwd_iter_<N, D>::faces_fwd_iter_()
      : super_()
    {
      // Ensure N is compatible with D.
      metal::bool_< N <= D >::check();
      mln_postcondition(!is_valid());
    }

    template <unsigned N, unsigned D>
    inline
    faces_fwd_iter_<N, D>::faces_fwd_iter_(complex<D>& c)
      : super_(c)
    {
      // Ensure N is compatible with D.
      metal::bool_< N <= D >::check();
      mln_postcondition(!is_valid());
    }

    template <unsigned N, unsigned D>
    inline
    void
    faces_fwd_iter_<N, D>::start()
    {
      face_.set_face_id(0u);
    }

    template <unsigned N, unsigned D>
    inline
    void
    faces_fwd_iter_<N, D>::next_()
    {
      if (is_valid())
        {
          unsigned face_id = face_.face_id();
          if (face_id + 1 < face_.cplx().template nfaces_of_static_dim<N>())
            /* FIXME: Provide accessor n_face::n() returning
               a mutable reference?  This way, we could just write

               ++face_.face_id();

               instead of the following.  */
            face_.set_face_id(face_id + 1);
          else
            invalidate();
        }
    }


    /*------------------------------.
    | topo::faces_bkd_iter_<N, D>.  |
    `------------------------------*/

    template <unsigned N, unsigned D>
    inline
    faces_bkd_iter_<N, D>::faces_bkd_iter_()
      : super_()
    {
      // Ensure N is compatible with D.
      metal::bool_< N <= D >::check();
      mln_postcondition(!is_valid());
    }

    template <unsigned N, unsigned D>
    inline
    faces_bkd_iter_<N, D>::faces_bkd_iter_(complex<D>& c)
      : super_(c)
    {
      // Ensure N is compatible with D.
      metal::bool_< N <= D >::check();
      mln_postcondition(!is_valid());
    }

    template <unsigned N, unsigned D>
    inline
    void
    faces_bkd_iter_<N, D>::start()
    {
      face_.set_face_id(face_.cplx().template nfaces_of_static_dim<N>() - 1);
    }

    template <unsigned N, unsigned D>
    inline
    void
    faces_bkd_iter_<N, D>::next_()
    {
      if (is_valid())
        {
          unsigned face_id = face_.face_id();
          if (face_id > 0)
            /* FIXME: Provide accessor n_face::n() returning
               a mutable reference?  This way, we could just write

               ++face_.face_id();

               instead of the following.  */
            face_.set_face_id(face_id - 1);
          else
            invalidate();
        }
    }

# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::topo

} // end of namespace mln

#endif // ! MLN_TOPO_ATTIC_FACES_ITER_HH