[Olena-patches] olena: olena-2.0-613-gf0a568a Be more precise about relationship between sites and iterators.

* doc/mln/core/image/images.dox, * doc/mln/core/neighb.dox, * doc/mln/win/win.dox: Here. --- milena/ChangeLog | 8 ++++++++ milena/doc/mln/core/image/images.dox | 14 +++++++------- milena/doc/mln/core/neighb.dox | 3 ++- milena/doc/mln/win/win.dox | 3 ++- 4 files changed, 19 insertions(+), 9 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 8acf1b4..f14e23c 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-05-15 Guillaume Lazzara <z(a)lrde.epita.fr> + Be more precise about relationship between sites and iterators. + + * doc/mln/core/image/images.dox, + * doc/mln/core/neighb.dox, + * doc/mln/win/win.dox: Here. + +2013-05-15 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/mln/io/io.dox: Move package dependencies documentation into "note" environnement. diff --git a/milena/doc/mln/core/image/images.dox b/milena/doc/mln/core/image/images.dox index d559794..17685fd 100644 --- a/milena/doc/mln/core/image/images.dox +++ b/milena/doc/mln/core/image/images.dox @@ -35,7 +35,7 @@ \subsection docaccvalpiter Site-Based Iterators - A generic way of iterating over the values of an image is to use + A generic way of iterating over the domain of an image is to use mln_piter() macro to declare an iterator. \code @@ -48,12 +48,12 @@ \endcode Note that iterator \c p must be first declared over the domain of - the target image \c ima. Then iterator \c p is moved over the image - thanks to the for_all() macro. An iterator declared with - mln_piter() can be considered as having the same interface as a site - of the target image. Here, \c p can be considered as a mln::point2d - and thus can be passed to image2d::operator() to access the value of - the current point. + the target image \c ima. Then iterator \c p is moved over all the + image sites thanks to the for_all() macro. An iterator declared + with mln_piter() can be considered as having the same interface as a + site of the target image. Here, \c p can be considered as a + mln::point2d and thus can be passed to image2d::operator() to access + the value of the current point. The for_all() is in charge of initializing the iterator and move it forward. It is safe to have two for_all() loops successively with diff --git a/milena/doc/mln/core/neighb.dox b/milena/doc/mln/core/neighb.dox index 1748928..f8f545b 100644 --- a/milena/doc/mln/core/neighb.dox +++ b/milena/doc/mln/core/neighb.dox @@ -26,7 +26,8 @@ \c p is a site iterator over all the sites of the image \c ima. \c q, being a neighborhood iterator centered on that iterator, is automatically updated and centered to the current site pointed by \p - p. + p. The neighborhood iterator \c q points to a neighbor site of \c p + and can be considered as having the same interface than image sites. A full example is available in \link neighborhood_iterator.cc neighborhood_iterator.cc \endlink diff --git a/milena/doc/mln/win/win.dox b/milena/doc/mln/win/win.dox index 2ce3cb1..b9f38a5 100644 --- a/milena/doc/mln/win/win.dox +++ b/milena/doc/mln/win/win.dox @@ -24,7 +24,8 @@ \c p is a site iterator over all the sites of the image \c ima. \c q, being a window iterator centered on that iterator, is automatically updated and centered to the current site pointed by \p - p. + p. The window iterator \c q points to a neighbor site of \c p and + can be considered as having the same interface than image sites. A full example is available in \link window_iterator.cc window_iterator.cc \endlink -- 1.7.2.5