[Olena-patches] 2491: Overhaul neighborhoods of adjacent lower- and higher-dimension faces.

* mln/core/image/complex_lower_neighborhood.hh, * mln/core/image/complex_higher_neighborhood.hh: Update the documentation. --- milena/ChangeLog | 8 ++++++++ .../mln/core/image/complex_higher_neighborhood.hh | 10 ++++++---- .../mln/core/image/complex_lower_neighborhood.hh | 10 ++++++---- 3 files changed, 20 insertions(+), 8 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 1fe4229..e07f8bc 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2008-10-03 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Overhaul neighborhoods of adjacent lower- and higher-dimension faces. + + * mln/core/image/complex_lower_neighborhood.hh, + * mln/core/image/complex_higher_neighborhood.hh: + Update the documentation. + +2008-10-03 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Overhaul piters on complex neighborhood. * mln/core/image/complex_neighborhood_piter.hh diff --git a/milena/mln/core/image/complex_higher_neighborhood.hh b/milena/mln/core/image/complex_higher_neighborhood.hh index 2b52c5b..3b56d68 100644 --- a/milena/mln/core/image/complex_higher_neighborhood.hh +++ b/milena/mln/core/image/complex_higher_neighborhood.hh @@ -43,7 +43,7 @@ namespace mln { - // Fwd decls. + // Forward declarations. template <typename I, typename P, typename N> class complex_neighborhood_fwd_piter; template <typename I, typename P, typename N> @@ -58,10 +58,12 @@ namespace mln { typedef complex_higher_neighborhood<D, P> self_; - // FIXME: The associated complex iterators. public: + /// The associated complex iterators. + /// \{ typedef topo::adj_higher_face_fwd_iter<D> complex_fwd_iter; typedef topo::adj_higher_face_bkd_iter<D> complex_bkd_iter; + /// \} public: /// Associated types. @@ -71,12 +73,12 @@ namespace mln /// The type of site corresponding to the neighborhood. typedef mln_site(psite) site; - /// \brief Point_Iterator type to browse the psites of the neighborhood + /// \brief Site_Iterator type to browse the psites of the neighborhood /// w.r.t. the ordering of vertices. typedef complex_neighborhood_fwd_piter<complex_fwd_iter, P, self_> fwd_niter; - /// \brief Point_Iterator type to browse the psites of the neighborhood + /// \brief Site_Iterator type to browse the psites of the neighborhood /// w.r.t. the reverse ordering of vertices. typedef complex_neighborhood_bkd_piter<complex_bkd_iter, P, self_> bkd_niter; diff --git a/milena/mln/core/image/complex_lower_neighborhood.hh b/milena/mln/core/image/complex_lower_neighborhood.hh index 7eb8fc4..6c21acc 100644 --- a/milena/mln/core/image/complex_lower_neighborhood.hh +++ b/milena/mln/core/image/complex_lower_neighborhood.hh @@ -43,7 +43,7 @@ namespace mln { - // Fwd decls. + // Forward declarations. template <typename I, typename P, typename N> class complex_neighborhood_fwd_piter; template <typename I, typename P, typename N> @@ -58,10 +58,12 @@ namespace mln { typedef complex_lower_neighborhood<D, P> self_; - // FIXME: The associated complex iterators. public: + /// The associated complex iterators. + /// \{ typedef topo::adj_lower_face_fwd_iter<D> complex_fwd_iter; typedef topo::adj_lower_face_bkd_iter<D> complex_bkd_iter; + /// \} public: /// Associated types. @@ -71,12 +73,12 @@ namespace mln /// The type of site corresponding to the neighborhood. typedef mln_site(psite) site; - /// \brief Point_Iterator type to browse the psites of the neighborhood + /// \brief Site_Iterator type to browse the psites of the neighborhood /// w.r.t. the ordering of vertices. typedef complex_neighborhood_fwd_piter<complex_fwd_iter, P, self_> fwd_niter; - /// \brief Point_Iterator type to browse the psites of the neighborhood + /// \brief Site_Iterator type to browse the psites of the neighborhood /// w.r.t. the reverse ordering of vertices. typedef complex_neighborhood_bkd_piter<complex_bkd_iter, P, self_> bkd_niter; -- 1.6.0.1