neighb.hh

// Copyright (C) 2007, 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_CORE_NEIGHB_HH
# define MLN_CORE_NEIGHB_HH


# include <mln/core/internal/neighb_base.hh>
# include <mln/core/internal/neighb_niter_base.hh>
# include <mln/core/internal/site_relative_iterator_base.hh>
# include <mln/core/internal/neighb_niter_impl.hh>


namespace mln
{

  // Forward declarations.
  template <typename W> class neighb_fwd_niter;
  template <typename W> class neighb_bkd_niter;
  template <typename W> class neighb;


  namespace convert
  {

    namespace over_load
    {

      template <typename W>
      void
      from_to_(const mln::neighb<W>& from, W& to);

      template <typename W>
      void
      from_to_(const W& from, mln::neighb<W>& to);

    } // end of namespace mln::convert::over_load

  } // end of namespace mln::convert




  template <typename W>
  class neighb
    : public internal::neighb_base<W,neighb<W> >
  {
    typedef internal::neighb_base<W,neighb<W> > super_;

  public:

    typedef neighb_fwd_niter<W> fwd_niter;

    typedef neighb_bkd_niter<W> bkd_niter;

    typedef fwd_niter niter;


    neighb();

    neighb(const W& win);

  };


  // neighb_fwd_niter<W>

  template <typename W>
  class neighb_fwd_niter
    : public internal::neighb_niter_base<W,neighb<W>,
                                         mln_fwd_qiter(W),neighb_fwd_niter<W> >
  {
    typedef
      internal::neighb_niter_base<W,neighb<W>,
                                  mln_fwd_qiter(W),neighb_fwd_niter<W> > super_;

  public:
    neighb_fwd_niter();

    template <typename P>
    neighb_fwd_niter(const neighb<W>& nbh, const P& c);

  };



  // neighb_bkd_niter<W,E>

  template <typename W>
  class neighb_bkd_niter
    : public internal::neighb_niter_base<W,neighb<W>,
                                         mln_bkd_qiter(W),neighb_bkd_niter<W> >
  {
    typedef
      internal::neighb_niter_base<W,neighb<W>,
                                  mln_bkd_qiter(W),neighb_bkd_niter<W> > super_;

  public:
    neighb_bkd_niter();

    template <typename P>
    neighb_bkd_niter(const neighb<W>& nbh, const P& c);

  };



# ifndef MLN_INCLUDE_ONLY

  // neighb<W>

  template <typename W>
  inline
  neighb<W>::neighb()
  {
  }

  template <typename W>
  inline
  neighb<W>::neighb(const W& win)
    : super_(win)
  {
  }


  // mln::convert::from_to

  namespace convert
  {

    namespace over_load
    {

      template <typename W>
      void
      from_to_(const mln::neighb<W>& from, W& to)
      {
        to = from.win();
      }

      template <typename W>
      void
      from_to_(const W& from, mln::neighb<W>& to)
      {
        to.change_window(from);
      }

    } // end of namespace mln::convert::over_load

  } // end of namespace mln::convert




  // neighb_fwd_niter<W>

  template <typename W>
  inline
  neighb_fwd_niter<W>::neighb_fwd_niter()
  {
  }

  template <typename W>
  template <typename P>
  inline
  neighb_fwd_niter<W>::neighb_fwd_niter(const neighb<W>& nbh, const P& c)
    : super_(nbh, c)
  {
    this->i_.init_(nbh.win(), c);
  }



  // neighb_bkd_niter<W>

  template <typename W>
  inline
  neighb_bkd_niter<W>::neighb_bkd_niter()
  {
  }

  template <typename W>
  template <typename P>
  inline
  neighb_bkd_niter<W>::neighb_bkd_niter(const neighb<W>& nbh, const P& c)
    : super_(nbh, c)
  {
    this->i_.init_(nbh.win(), c);
  }


# endif // ! MLN_INCLUDE_ONLY

} // end of namespace mln


#endif // ! MLN_CORE_NEIGHB_HH