[Olena-patches] 1899: Factor implementation of piters on line graph windows.

https://svn.lrde.epita.fr/svn/oln/trunk/milena Index: ChangeLog from Roland Levillain &lt;roland(a)lrde.epita.fr&gt; Factor implementation of piters on line graph windows. * mln/core/internal/line_graph_vicinity_piter.hh: New. Factored implementation for piters on line graph windows and neighborhoods. * mln/core/line_graph_window_piter.hh (mln::line_graph_window_fwd_piter<P, W>) (mln::line_graph_window_bkd_piter<P, W>): Inherit from mln::internal::line_graph_vicinity_piter_. (mln::line_graph_window_fwd_piter<P, W>::super_) (mln::line_graph_window_bkd_piter<P, W>::super_): Adjust typedef. (mln::line_graph_window_fwd_piter<P, W>::psite) (mln::line_graph_window_fwd_piter<P, W>::point) (mln::line_graph_window_fwd_piter<P, W>::coord) (mln::line_graph_window_fwd_piter<P, W>::dpoint) (mln::line_graph_window_fwd_piter<P, W>::mesh) (mln::line_graph_window_fwd_piter<P, W>::sites_t) (mln::line_graph_window_bkd_piter<P, W>::psite) (mln::line_graph_window_bkd_piter<P, W>::point) (mln::line_graph_window_bkd_piter<P, W>::coord) (mln::line_graph_window_bkd_piter<P, W>::dpoint) (mln::line_graph_window_bkd_piter<P, W>::mesh) (mln::line_graph_window_bkd_piter<P, W>::sites_t): Remove (now useless) typedefs. (mln::line_graph_window_fwd_piter<P, W>::to_point) (mln::line_graph_window_fwd_piter<P, W>::to_psite) (mln::line_graph_window_fwd_piter<P, W>::operator psite) (mln::line_graph_window_fwd_piter<P, W>::p_ref) (mln::line_graph_window_fwd_piter<P, W>::plg) (mln::line_graph_window_fwd_piter<P, W>::sites) (mln::line_graph_window_fwd_piter<P, W>::operator[]) (mln::line_graph_window_bkd_piter<P, W>::to_point) (mln::line_graph_window_bkd_piter<P, W>::to_psite) (mln::line_graph_window_bkd_piter<P, W>::operator psite) (mln::line_graph_window_bkd_piter<P, W>::p_ref) (mln::line_graph_window_bkd_piter<P, W>::plg) (mln::line_graph_window_bkd_piter<P, W>::sites) (mln::line_graph_window_bkd_piter<P, W>::operator[]): Remove methods. (mln::line_graph_window_fwd_piter<P, W>::p_ref_) (mln::line_graph_window_fwd_piter<P, W>::saved_p_ref_) (mln::line_graph_window_fwd_piter<P, W>::sites_) (mln::line_graph_window_fwd_piter<P, W>::psite_) (mln::line_graph_window_fwd_piter<P, W>::point_) (mln::line_graph_window_bkd_piter<P, W>::p_ref_) (mln::line_graph_window_bkd_piter<P, W>::saved_p_ref_) (mln::line_graph_window_bkd_piter<P, W>::sites_) (mln::line_graph_window_bkd_piter<P, W>::psite_) (mln::line_graph_window_bkd_piter<P, W>::point_): Remove attributes. (operator<<(std::ostream&, const line_graph_window_fwd_piter<P, W>&)) (operator<<(std::ostream&, const line_graph_window_bkd_piter<P, W>&)): Remove. internal/line_graph_vicinity_piter.hh | 218 ++++++++++++++++++++++ line_graph_window_piter.hh | 334 +++------------------------------- 2 files changed, 253 insertions(+), 299 deletions(-) Index: mln/core/internal/line_graph_vicinity_piter.hh --- mln/core/internal/line_graph_vicinity_piter.hh (revision 0) +++ mln/core/internal/line_graph_vicinity_piter.hh (revision 0) @@ -0,0 +1,218 @@ +// Copyright (C) 2007, 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_INTERNAL_LINE_GRAPH_VICINITY_PITER_HH +# define MLN_CORE_INTERNAL_LINE_GRAPH_VICINITY_PITER_HH + +/// \file mln/core/internal/line_graph_vicinity_piter.hh +/// \brief Factored implementation for point iterators on a line graph windows +/// and line graph neighborhoods, called "vicinities". + +/* FIXME: Factor those classes: + + - mln::internal::graph_vicinity_piter.hh + - mln::internal::line_graph_vicinity_piter.hh */ + +# include <mln/core/concept/point_iterator.hh> +# include <mln/core/p_line_graph.hh> +# include <mln/core/line_graph_psite.hh> + +namespace mln +{ + // Fwd decls. + template <typename P> class p_line_graph; + template <typename P> class line_graph_psite; + + + /*---------------------------------------------. + | internal::line_graph_vicinity_piter_<P, E>. | + `---------------------------------------------*/ + + namespace internal + { + + /// \brief Base for iterator on a line graph vicinity. + template <typename P, typename E> + class line_graph_vicinity_piter_ : public Point_Iterator< E > + { + typedef line_graph_vicinity_piter_<P, E> self_; + typedef Point_Iterator< self_ > super_; + + public: + enum { dim = P::dim }; + + typedef line_graph_psite<P> psite; + typedef P point; + typedef mln_coord(point) coord; + // FIXME: Dummy typedef. + typedef void dpoint; + // FIXME: Dummy typedef. + typedef void mesh; + + // The type of the set of vicinity sites (adjacent edge ids). + typedef std::set<util::edge_id> sites_t; + + public: + /// Conversion and accessors. + /// \{ + /// Reference to the corresponding point. + const point& to_point() const; + /// Reference to the corresponding point site. + const psite& to_psite() const; + /// Convert the iterator into a line graph psite. + operator psite() const; + + /// Return the reference psite. + const psite& p_ref() const; + /// Return the mln::p_line_graph corresponding to this piter. + const p_line_graph<P>& plg() const; + /// Return the set of sites (adjacent edge ids). + sites_t& sites(); + + /// Read-only access to the \a i-th coordinate. + coord operator[](unsigned i) const; + /// \} + + protected: + /// Construction. + /// \{ + template <typename Pref> + line_graph_vicinity_piter_(const Point_Site<Pref>& p_ref); + /// \} + + protected: + /// The ``central'' psite of the vicinity. + const psite& p_ref_; + + /// The last reference psite whose ajacent psites have been computed. + psite saved_p_ref_; + /// The set of edge ids adjacent to the reference psite. + sites_t sites_; + + /// The psite corresponding to this iterator. + psite psite_; + /// The point corresponding to this iterator. + /* FIXME: Dummy value. To be removed as soon as the conversion + from psite to point is no longer mandatory. */ + point p_; + }; + + /* FIXME: This hand-made delegation is painful. We should rely on + the general mechanism provided by Point_Site. But then again, we + need to refine/adjust the interface of Point_Site w.r.t. the + mandatory conversions to points. */ + template <typename P, typename E> + inline + std::ostream& + operator<<(std::ostream& ostr, const line_graph_vicinity_piter_<P, E>& p); + + + +# ifndef MLN_INCLUDE_ONLY + + template <typename P, typename E> + template <typename Pref> + inline + line_graph_vicinity_piter_<P, E>::line_graph_vicinity_piter_(const Point_Site<Pref>& p_ref) + : p_ref_(exact(p_ref).to_psite()), + // Initialize psite_ to a dummy value. + psite_() + { + } + + template <typename P, typename E> + inline + const P& + line_graph_vicinity_piter_<P, E>::to_point() const + { + return p_; + } + + template <typename P, typename E> + inline + const line_graph_psite<P>& + line_graph_vicinity_piter_<P, E>::to_psite() const + { + return psite_; + } + + template <typename P, typename E> + inline + line_graph_vicinity_piter_<P, E>::operator line_graph_psite<P> () const + { + mln_precondition(exact(*this).is_valid()); + return psite_; + } + + template <typename P, typename E> + inline + const line_graph_psite<P>& + line_graph_vicinity_piter_<P, E>::p_ref() const + { + return p_ref_; + } + + template <typename P, typename E> + inline + const p_line_graph<P>& + line_graph_vicinity_piter_<P, E>::plg() const + { + return p_ref_.plg(); + } + + template <typename P, typename E> + inline + std::set<util::edge_id>& + line_graph_vicinity_piter_<P, E>::sites() + { + return sites_; + } + + template <typename P, typename E> + inline + mln_coord(P) + line_graph_vicinity_piter_<P, E>::operator[](unsigned i) const + { + assert(i < dim); + return p_[i]; + } + + template <typename P, typename E> + inline + std::ostream& + operator<<(std::ostream& ostr, const line_graph_vicinity_piter_<P, E>& p) + { + return ostr << p.to_psite(); + } + +# endif // ! MLN_INCLUDE_ONLY + + } // end of namespace mln::internal + +} // end of namespace mln + +#endif // ! MLN_CORE_INTERNAL_LINE_GRAPH_VICINITY_PITER_HH Index: mln/core/line_graph_window_piter.hh --- mln/core/line_graph_window_piter.hh (revision 1898) +++ mln/core/line_graph_window_piter.hh (working copy) @@ -31,20 +31,7 @@ /// \file mln/core/line_graph_window_piter.hh /// \brief Definition of a point iterator on a line_graph window. -/* FIXME: Factor those classes: - - - mln::graph_window_fwd_piter - - mln::graph_neighborhood_fwd_piter - - mln::line_graph_window_fwd_piter - - mln::line_graph_neighborhood_fwd_piter. - - mln::graph_window_bkd_piter - - mln::graph_neighborhood_bkd_piter - - mln::line_graph_window_bkd_piter - - mln::line_graph_neighborhood_bkd_piter. */ - -# include <mln/core/concept/point_iterator.hh> -# include <mln/core/p_line_graph.hh> -# include <mln/core/line_graph_psite.hh> +# include <mln/core/internal/line_graph_vicinity_piter.hh> /* FIXME: Due to the poor interface of mln::p_line_graph and mln::util::graph, we show to much implementation details here. @@ -52,10 +39,6 @@ namespace mln { - // Fwd decls. - template <typename P> class p_line_graph; - template <typename P> class line_graph_psite; - /*------------------------------------. | line_graph_window_fwd_piter<P, W>. | @@ -63,25 +46,11 @@ /// \brief Forward iterator on line graph window. template <typename P, typename W> - class line_graph_window_fwd_piter : - public Point_Iterator< line_graph_window_fwd_piter<P, W> > + class line_graph_window_fwd_piter + : public internal::line_graph_vicinity_piter_<P, line_graph_window_fwd_piter<P, W> > { typedef line_graph_window_fwd_piter<P, W> self_; - typedef Point_Iterator< self_ > super_; - - public: - enum { dim = P::dim }; - - typedef line_graph_psite<P> psite; - typedef P point; - typedef mln_coord(point) coord; - // FIXME: Dummy typedef. - typedef void dpoint; - // FIXME: Dummy typedef. - typedef void mesh; - - // The type of the set of window sites (adjacent edge ids). - typedef std::set<util::edge_id> sites_t; + typedef internal::line_graph_vicinity_piter_<P, self_ > super_; public: /// Construction. @@ -106,56 +75,14 @@ void update_(); /// \} - /// Conversion and accessors. - /// \{ - /// Reference to the corresponding point. - const point& to_point() const; - /// Reference to the corresponding point site. - const psite& to_psite() const; - /// Convert the iterator into a line graph psite. - operator psite() const; - - /// Return the reference psite. - const psite& p_ref() const; - /// Return the mln::p_line_graph corresponding to this piter. - const p_line_graph<P>& plg() const; - /// Return the set of sites (adjacent edge ids). - sites_t& sites(); - - /// Read-only access to the \a i-th coordinate. - coord operator[](unsigned i) const; - /// \} - private: /// The window. const W& win_; - /// The ``central'' psite of the window. - const psite& p_ref_; - /// The last reference psite whose ajacent psites have been computed. - psite saved_p_ref_; - /// The set of edge ids adjacent to the reference psite. - sites_t sites_; /// An iterator on the set of adjacent edges. - sites_t::const_iterator i_; - - /// The psite corresponding to this iterator. - psite psite_; - /// The point corresponding to this iterator. - /* FIXME: Dummy value. To be removed as soon as the conversion - from psite to point is no longer mandatory. */ - point p_; + typename super_::sites_t::const_iterator i_; }; - /* FIXME: This hand-made delegation is painful. We should rely on - the general mechanism provided by Point_Site. But then again, we - need to refine/adjust the interface of Point_Site w.r.t. the - mandatory conversions to points. */ - template <typename P, typename W> - inline - std::ostream& - operator<<(std::ostream& ostr, const line_graph_window_fwd_piter<P, W>& p); - /*------------------------------------. | line_graph_window_bkd_piter<P, W>. | @@ -163,25 +90,11 @@ /// \brief Backward iterator on line graph window. template <typename P, typename W> - class line_graph_window_bkd_piter : - public Point_Iterator< line_graph_window_bkd_piter<P, W> > + class line_graph_window_bkd_piter + : public internal::line_graph_vicinity_piter_<P, line_graph_window_bkd_piter<P, W> > { typedef line_graph_window_bkd_piter<P, W> self_; - typedef Point_Iterator< self_ > super_; - - public: - enum { dim = P::dim }; - - typedef line_graph_psite<P> psite; - typedef P point; - typedef mln_coord(point) coord; - // FIXME: Dummy typedef. - typedef void dpoint; - // FIXME: Dummy typedef. - typedef void mesh; - - // The type of the set of window sites (adjacent edge ids). - typedef std::set<util::edge_id> sites_t; + typedef internal::line_graph_vicinity_piter_<P, self_ > super_; public: /// Construction. @@ -206,56 +119,14 @@ void update_(); /// \} - /// Conversion and accessors. - /// \{ - /// Reference to the corresponding point. - const point& to_point() const; - /// Reference to the corresponding point site. - const psite& to_psite() const; - /// Convert the iterator into a line graph psite. - operator psite() const; - - /// Return the reference psite. - const psite& p_ref() const; - /// Return the mln::p_line_graph corresponding to this piter. - const p_line_graph<P>& plg() const; - /// Return the set of sites (adjacent edge ids). - sites_t& sites(); - - /// Read-only access to the \a i-th coordinate. - coord operator[](unsigned i) const; - /// \} - private: /// The window. const W& win_; - /// The ``central'' psite of the window. - const psite& p_ref_; - /// The last reference psite whose ajacent psites have been computed. - psite saved_p_ref_; - /// The set of edge ids adjacent to the reference psite. - sites_t sites_; /// An iterator on the set of adjacent edges. - sites_t::const_reverse_iterator i_; - - /// The psite corresponding to this iterator. - psite psite_; - /// The point corresponding to this iterator. - /* FIXME: Dummy value. To be removed as soon as the conversion - from psite to point is no longer mandatory. */ - point p_; + typename super_::sites_t::const_reverse_iterator i_; }; - /* FIXME: This hand-made delegation is painful. We should rely on - the general mechanism provided by Point_Site. But then again, we - need to refine/adjust the interface of Point_Site w.r.t. the - mandatory conversions to points. */ - template <typename P, typename W> - inline - std::ostream& - operator<<(std::ostream& ostr, const line_graph_window_bkd_piter<P, W>& p); - # ifndef MLN_INCLUDE_ONLY @@ -269,12 +140,10 @@ inline line_graph_window_fwd_piter<P, W>::line_graph_window_fwd_piter(const Window<W>& win, const Point_Site<Pref>& p_ref) - : win_(exact(win)), - p_ref_(exact(p_ref).to_psite()), - // Initialize psite_ to a dummy value. - psite_() + : super_(p_ref), + win_(exact(win)) { - // Invalidate id_. + // Invalidate i_. invalidate(); } @@ -285,11 +154,11 @@ { return // The reference point must be valid... - p_ref_.is_valid() + this->p_ref_.is_valid() // ...and must not have changed since the window has been computed... - && p_ref_ == saved_p_ref_ + && this->p_ref_ == this->saved_p_ref_ // ...and the iterator i_ must point a valid value. - && i_ != sites_.end(); + && i_ != this->sites_.end(); } template <typename P, typename W> @@ -297,7 +166,7 @@ void line_graph_window_fwd_piter<P, W>::invalidate() { - i_ = sites_.end(); + i_ = this->sites_.end(); } template <typename P, typename W> @@ -305,14 +174,14 @@ void line_graph_window_fwd_piter<P, W>::start() { - mln_precondition(p_ref_.is_valid()); + mln_precondition(this->p_ref_.is_valid()); // Update the sites, if needed. - if (!saved_p_ref_.is_valid() || p_ref_ != saved_p_ref_) + if (!this->saved_p_ref_.is_valid() || this->p_ref_ != this->saved_p_ref_) { - saved_p_ref_ = p_ref_; + this->saved_p_ref_ = this->p_ref_; win_.compute_sites_(*this); } - i_ = sites_.begin(); + i_ = this->sites_.begin(); // FIXME: We might move the is_valid condition within update_. if (is_valid()) update_(); @@ -324,7 +193,7 @@ line_graph_window_fwd_piter<P, W>::next_() { // Ensure the p_ref_ has not changed. - mln_precondition(p_ref_ == saved_p_ref_); + mln_precondition(this->p_ref_ == this->saved_p_ref_); ++i_; // FIXME: We might move the is_valid condition within update_. if (is_valid()) @@ -337,72 +206,7 @@ line_graph_window_fwd_piter<P, W>::update_() { // Update psite_. - psite_ = line_graph_psite<P>(plg(), *i_); - } - - template <typename P, typename W> - inline - const P& - line_graph_window_fwd_piter<P, W>::to_point() const - { - return p_; - } - - template <typename P, typename W> - inline - const line_graph_psite<P>& - line_graph_window_fwd_piter<P, W>::to_psite() const - { - return psite_; - } - - template <typename P, typename W> - inline - line_graph_window_fwd_piter<P, W>::operator line_graph_psite<P> () const - { - mln_precondition(is_valid()); - return psite_; - } - - template <typename P, typename W> - inline - const line_graph_psite<P>& - line_graph_window_fwd_piter<P, W>::p_ref() const - { - return p_ref_; - } - - template <typename P, typename W> - inline - const p_line_graph<P>& - line_graph_window_fwd_piter<P, W>::plg() const - { - return p_ref_.plg(); - } - - template <typename P, typename W> - inline - std::set<util::edge_id>& - line_graph_window_fwd_piter<P, W>::sites() - { - return sites_; - } - - template <typename P, typename W> - inline - mln_coord(P) - line_graph_window_fwd_piter<P, W>::operator[](unsigned i) const - { - assert(i < dim); - return p_[i]; - } - - template <typename P, typename W> - inline - std::ostream& - operator<<(std::ostream& ostr, const line_graph_window_fwd_piter<P, W>& p) - { - return ostr << p.to_psite(); + this->psite_ = line_graph_psite<P>(this->plg(), *i_); } @@ -410,18 +214,15 @@ | line_graph_window_bkd_piter<P, W>. | `------------------------------------*/ - // FIXME: Currently, argument win is ignored. template <typename P, typename W> template <typename Pref> inline line_graph_window_bkd_piter<P, W>::line_graph_window_bkd_piter(const Window<W>& win, const Point_Site<Pref>& p_ref) - : win_(exact(win)), - p_ref_(exact(p_ref).to_psite()), - // Initialize psite_ to a dummy value. - psite_() + : super_(p_ref), + win_(exact(win)) { - // Invalidate id_. + // Invalidate i_. invalidate(); } @@ -432,11 +233,11 @@ { return // The reference point must be valid... - p_ref_.is_valid() + this->p_ref_.is_valid() // ...and must not have changed since the window has been computed... - && p_ref_ == saved_p_ref_ + && this->p_ref_ == this->saved_p_ref_ // ...and the iterator i_ must point a valid value. - && i_ != sites_.rend(); + && i_ != this->sites_.rend(); } template <typename P, typename W> @@ -444,7 +245,7 @@ void line_graph_window_bkd_piter<P, W>::invalidate() { - i_ = sites_.rend(); + i_ = this->sites_.rend(); } template <typename P, typename W> @@ -452,14 +253,14 @@ void line_graph_window_bkd_piter<P, W>::start() { - mln_precondition(p_ref_.is_valid()); + mln_precondition(this->p_ref_.is_valid()); // Update the sites, if needed. - if (!saved_p_ref_.is_valid() || p_ref_ != saved_p_ref_) + if (!this->saved_p_ref_.is_valid() || this->p_ref_ != this->saved_p_ref_) { - saved_p_ref_ = p_ref_; + this->saved_p_ref_ = this->p_ref_; win_.compute_sites_(*this); } - i_ = sites_.rbegin(); + i_ = this->sites_.rbegin(); // FIXME: We might move the is_valid condition within update_. if (is_valid()) update_(); @@ -471,7 +272,7 @@ line_graph_window_bkd_piter<P, W>::next_() { // Ensure the p_ref_ has not changed. - mln_precondition(p_ref_ == saved_p_ref_); + mln_precondition(this->p_ref_ == this->saved_p_ref_); ++i_; // FIXME: We might move the is_valid condition within update_. if (is_valid()) @@ -484,72 +285,7 @@ line_graph_window_bkd_piter<P, W>::update_() { // Update psite_. - psite_ = line_graph_psite<P>(plg(), *i_); - } - - template <typename P, typename W> - inline - const P& - line_graph_window_bkd_piter<P, W>::to_point() const - { - return p_; - } - - template <typename P, typename W> - inline - const line_graph_psite<P>& - line_graph_window_bkd_piter<P, W>::to_psite() const - { - return psite_; - } - - template <typename P, typename W> - inline - line_graph_window_bkd_piter<P, W>::operator line_graph_psite<P> () const - { - mln_precondition(is_valid()); - return psite_; - } - - template <typename P, typename W> - inline - const line_graph_psite<P>& - line_graph_window_bkd_piter<P, W>::p_ref() const - { - return p_ref_; - } - - template <typename P, typename W> - inline - const p_line_graph<P>& - line_graph_window_bkd_piter<P, W>::plg() const - { - return p_ref_.plg(); - } - - template <typename P, typename W> - inline - std::set<util::edge_id>& - line_graph_window_bkd_piter<P, W>::sites() - { - return sites_; - } - - template <typename P, typename W> - inline - mln_coord(P) - line_graph_window_bkd_piter<P, W>::operator[](unsigned i) const - { - assert(i < dim); - return p_[i]; - } - - template <typename P, typename W> - inline - std::ostream& - operator<<(std::ostream& ostr, const line_graph_window_bkd_piter<P, W>& p) - { - return ostr << p.to_psite(); + this->psite_ = line_graph_psite<P>(this->plg(), *i_); } # endif // ! MLN_INCLUDE_ONLY