[Olena-patches] 2513: Add generic site iterators on complex windows.

* mln/core/image/complex_window_piter.hh: New. --- milena/ChangeLog | 6 + milena/mln/core/image/complex_window_piter.hh | 345 +++++++++++++++++++++++++ 2 files changed, 351 insertions(+), 0 deletions(-) create mode 100644 milena/mln/core/image/complex_window_piter.hh diff --git a/milena/ChangeLog b/milena/ChangeLog index c86e12a..60b6c1e 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,11 @@ 2008-10-04 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Add generic site iterators on complex windows. + + * mln/core/image/complex_window_piter.hh: New. + +2008-10-04 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Add a complex relative iterator adapter adding the center/ref. face. * mln/topo/centered_iter_adapter.hh: New. diff --git a/milena/mln/core/image/complex_window_piter.hh b/milena/mln/core/image/complex_window_piter.hh new file mode 100644 index 0000000..62c6f86 --- /dev/null +++ b/milena/mln/core/image/complex_window_piter.hh @@ -0,0 +1,345 @@ +// Copyright (C) 2008 EPITA Research and Development Laboratory (LRDE) +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library 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 this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library 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_IMAGE_COMPLEX_WINDOW_PITER_HH +# define MLN_CORE_IMAGE_COMPLEX_WINDOW_PITER_HH + +/// \file mln/core/image/complex_window_piter.hh +/// \brief Definition of a site iterator on a complex window. + +# include <mln/core/internal/site_relative_iterator_base.hh> + +// FIXME: These might be factor-able (notably with +// complex_neighborhood_piter.hh) + +/* FIXME: Do we really want to inherit from + internal::site_relative_iterator_base? I might duplicate things, + since most of the implementation of this iterator is delegated to + the underlying complex iter. Moreover, change_target_() is + useless, and center_at() ``hides'' an existing method in (one of) + the super class(es) which is not sound, IMHO. Think about + introducing base class replacement. */ + + +namespace mln +{ + + /*------------------------------------. + | complex_window_fwd_piter<I, P, W>. | + `------------------------------------*/ + + /// \brief Forward iterator on complex window. + template <typename I, typename P, typename W> + class complex_window_fwd_piter + : public internal::site_relative_iterator_base< W, + complex_window_fwd_piter<I, P, W> > + { + typedef complex_window_fwd_piter<I, P, W> self_; + typedef internal::site_relative_iterator_base< W, self_ > super_; + + public: + /// The Pseudo_Site type. + typedef mln_psite(W) psite; + + public: + /// Construction. + /// \{ + complex_window_fwd_piter(); + template <typename Pref> + complex_window_fwd_piter(const Window<W>& win, const Pref& p_ref); + /// \} + + /// Manipulation. + /// \{ + /// Test if the iterator is valid. + bool is_valid_() const; + /// Invalidate the iterator. + void invalidate_(); + + /// Start an iteration. + void do_start_(); + /// Go to the next site. + void do_next_(); + + /// Set the reference psite. + /* FIXME: Careful, this method overrides the (non virtual) method + internal::site_relative_iterator_base<S, E>::center_at. See + FIXME above. */ + template <typename Pref> + void center_at(const Pref& c); + /// Compute the current psite. + psite compute_p_() const; + /// \} + + private: + /// The type of the underlying complex iterator. + typedef typename W::complex_fwd_iter iter; + /// The underlying complex iterator. + iter iter_; + }; + + + /// Print an mln::complex_window_fwd_piter. + template <typename I, typename P, typename W> + std::ostream& + operator<<(std::ostream& ostr, + const complex_window_fwd_piter<I, P, W>& p); + + + /*------------------------------------. + | complex_window_bkd_piter<I, P, W>. | + `------------------------------------*/ + + /// \brief Backward iterator on complex window. + template <typename I, typename P, typename W> + class complex_window_bkd_piter + : public internal::site_relative_iterator_base< W, + complex_window_bkd_piter<I, P, W> > + { + typedef complex_window_bkd_piter<I, P, W> self_; + typedef internal::site_relative_iterator_base< W, self_ > super_; + + public: + /// The Pseudo_Site type. + typedef mln_psite(W) psite; + + public: + /// Construction. + /// \{ + complex_window_bkd_piter(); + template <typename Pref> + complex_window_bkd_piter(const Window<W>& win, const Pref& p_ref); + /// \} + + /// Manipulation. + /// \{ + /// Test if the iterator is valid. + bool is_valid_() const; + /// Invalidate the iterator. + void invalidate_(); + + /// Start an iteration. + void do_start_(); + /// Go to the next site. + void do_next_(); + + /// Set the reference psite. + /* FIXME: Careful, this method overrides the (non virtual) method + internal::site_relative_iterator_base<S, E>::center_at. See + FIXME above. */ + template <typename Pref> + void center_at(const Pref& c); + /// Compute the current psite. + psite compute_p_() const; + /// \} + + private: + /// The type of the underlying complex iterator. + typedef typename W::complex_bkd_iter iter; + /// The underlying complex iterator. + iter iter_; + }; + + + /// Print an mln::complex_window_bkd_piter. + template <typename I, typename P, typename W> + std::ostream& + operator<<(std::ostream& ostr, + const complex_window_bkd_piter<I, P, W>& p); + + + +# ifndef MLN_INCLUDE_ONLY + + /*------------------------------------. + | complex_window_fwd_piter<I, P, W>. | + `------------------------------------*/ + + template <typename I, typename P, typename W> + inline + complex_window_fwd_piter<I, P, W>::complex_window_fwd_piter() + { + } + + template <typename I, typename P, typename W> + template <typename Pref> + inline + complex_window_fwd_piter<I, P, W>::complex_window_fwd_piter(const Window<W>& win, + const Pref& p_ref) + { + this->change_target(exact(win)); + center_at(p_ref); + mln_postcondition(!this->is_valid()); + } + + template <typename I, typename P, typename W> + inline + bool + complex_window_fwd_piter<I, P, W>::is_valid_() const + { + return iter_.is_valid(); + } + + template <typename I, typename P, typename W> + inline + void + complex_window_fwd_piter<I, P, W>::invalidate_() + { + iter_.invalidate(); + } + + template <typename I, typename P, typename W> + inline + void + complex_window_fwd_piter<I, P, W>::do_start_() + { + iter_.start(); + } + + template <typename I, typename P, typename W> + inline + void + complex_window_fwd_piter<I, P, W>::do_next_() + { + iter_.next(); + } + + template <typename I, typename P, typename W> + template <typename Pref> + inline + void + complex_window_fwd_piter<I, P, W>::center_at(const Pref& c) + { + super_::center_at(c); + iter_.center_at(this->center().face()); + } + + template <typename I, typename P, typename W> + inline + mln_psite(W) + complex_window_fwd_piter<I, P, W>::compute_p_() const + { + return psite(this->center().site_set(), iter_); + } + + + template <typename I, typename P, typename W> + inline + std::ostream& + operator<<(std::ostream& ostr, + const complex_window_fwd_piter<I, P, W>& p) + { + return ostr << p.unproxy_(); + } + + + /*------------------------------------. + | complex_window_bkd_piter<I, P, W>. | + `------------------------------------*/ + + template <typename I, typename P, typename W> + inline + complex_window_bkd_piter<I, P, W>::complex_window_bkd_piter() + { + } + + template <typename I, typename P, typename W> + template <typename Pref> + inline + complex_window_bkd_piter<I, P, W>::complex_window_bkd_piter(const Window<W>& win, + const Pref& p_ref) + { + this->change_target(exact(win)); + center_at(p_ref); + mln_postcondition(!this->is_valid()); + } + + template <typename I, typename P, typename W> + inline + bool + complex_window_bkd_piter<I, P, W>::is_valid_() const + { + return iter_.is_valid(); + } + + template <typename I, typename P, typename W> + inline + void + complex_window_bkd_piter<I, P, W>::invalidate_() + { + iter_.invalidate(); + } + + template <typename I, typename P, typename W> + inline + void + complex_window_bkd_piter<I, P, W>::do_start_() + { + iter_.start(); + } + + template <typename I, typename P, typename W> + inline + void + complex_window_bkd_piter<I, P, W>::do_next_() + { + iter_.next(); + } + + template <typename I, typename P, typename W> + template <typename Pref> + inline + void + complex_window_bkd_piter<I, P, W>::center_at(const Pref& c) + { + super_::center_at(c); + iter_.center_at(this->center().face()); + } + + template <typename I, typename P, typename W> + inline + mln_psite(W) + complex_window_bkd_piter<I, P, W>::compute_p_() const + { + return psite(this->center().site_set(), iter_); + } + + + template <typename I, typename P, typename W> + inline + std::ostream& + operator<<(std::ostream& ostr, + const complex_window_bkd_piter<I, P, W>& p) + { + return ostr << p.unproxy_(); + } + +# endif // ! MLN_INCLUDE_ONLY + +} // end of namespace mln + +#endif // ! MLN_CORE_IMAGE_COMPLEX_WINDOW_PITER_HH -- 1.6.0.1