May 2013 - Olena-patches

olena: olena-2.0-600-g38c4678 Improve documentation of several macros.
by Guillaume Lazzara 03 May '13

03 May '13

* mln/core/concept/iterator.hh: Document arguments. * mln/core/macros.hh: Add more documentation details for iterator related macros. * mln/core/var.hh: Fix typos. * mln/debug/trace.hh: Add documentation to mln_trace and mln_trace_warning. * mln/trait/value_.hh: Add documentation to several common macros. --- milena/ChangeLog | 16 ++ milena/mln/core/concept/iterator.hh | 17 ++- milena/mln/core/macros.hh | 363 ++++++++++++++++++++++------------- milena/mln/core/var.hh | 6 +- milena/mln/debug/trace.hh | 18 ++ milena/mln/trait/value_.hh | 87 ++++++++- 6 files changed, 359 insertions(+), 148 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 1d6a146..62b5772 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,21 @@ 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Improve documentation of several macros. + + * mln/core/concept/iterator.hh: Document arguments. + + * mln/core/macros.hh: Add more documentation details for iterator + related macros. + + * mln/core/var.hh: Fix typos. + + * mln/debug/trace.hh: Add documentation to mln_trace and + mln_trace_warning. + + * mln/trait/value_.hh: Add documentation to several common macros. + +2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Fix missing parts of mln::box interface in documentation. * doc/mln/core/alias/box1d.dox, diff --git a/milena/mln/core/concept/iterator.hh b/milena/mln/core/concept/iterator.hh index a8f74ec..2a82402 100644 --- a/milena/mln/core/concept/iterator.hh +++ b/milena/mln/core/concept/iterator.hh @@ -37,15 +37,23 @@ \def for_all(x) \brief Loop to browse all the elements targetted by the iterator \p x. + + \param x An iterator. + \ingroup mlnmacros */ -# define for_all(x) for(x.start(); x.is_valid(); x.next()) +# define for_all(x) \ + for(x.start(); x.is_valid(); x.next()) /*! \def for_all_2(x1, x2) \brief Loop to browse all the elements targetted by the couples of iterators \p x1 and \p x2. + + \param x1 An iterator. + \param x2 An iterator. + \ingroup mlnmacros */ # define for_all_2(x1, x2) \ @@ -58,6 +66,11 @@ \def for_all_3(x1, x2, x3) \brief Loop to browse all the elements targetted by the triplet of iterators \p x1, \p x2, and \p x3. + + \param x1 An iterator. + \param x2 An iterator. + \param x3 An iterator. + \ingroup mlnmacros */ # define for_all_3(x1, x2, x3) \ @@ -72,6 +85,8 @@ \brief Loop to browse all the remaining elements targetted by the iterator \p x. + \param x An iterator. + \ingroup mlnmacros */ # define for_all_remaining(x) \ diff --git a/milena/mln/core/macros.hh b/milena/mln/core/macros.hh index 681abfe..668d582 100644 --- a/milena/mln/core/macros.hh +++ b/milena/mln/core/macros.hh @@ -34,14 +34,14 @@ /*! \def mln_deduce(T, A1, A2) - \brief Shortcuts to access the type T::A1::A2. + \brief Shortcut to access the type T::A1::A2. To be used in templated functions only. \ingroup mlnmacros */ /*! \def mln_deduce_(T, A1, A2) - \brief Shortcuts to access the type T::A1::A2. + \brief Shortcut to access the type T::A1::A2. To be used in non-templated functions only. \ingroup mlnmacros @@ -56,7 +56,7 @@ /*! \def mln_argument(T) - \brief Shortcuts to access the argument type associated to T. + \brief Shortcut to access the argument type associated to T. To be used in templated functions only. \ingroup macrosfun @@ -64,7 +64,7 @@ */ /*! \def mln_argument_(T) - \brief Shortcuts to access the argument type associated to T. + \brief Shortcut to access the argument type associated to T. To be used in non-templated functions only. \ingroup macrosfun @@ -81,7 +81,7 @@ /*! \def mln_bkd_eiter(T) - \brief Shortcuts to access the element-backward-iterator type associated + \brief Shortcut to access the element-backward-iterator type associated to T. To be used in templated functions only. @@ -89,7 +89,7 @@ */ /*! \def mln_bkd_eiter_(T) - \brief Shortcuts to access the element-backward-iterator type associated + \brief Shortcut to access the element-backward-iterator type associated to T. To be used in non-templated functions only. @@ -104,7 +104,11 @@ /*! \def mln_bkd_niter(T) - \brief Shortcuts to access the bkd_niter type associated to T. + + \brief Shortcut to access the backward neighbor iterator type + associated to a neighborhood of type T. + + \param T A type of a class inheriting from mln::Neighborhood. To be used in templated functions only. \ingroup macrositernbh @@ -112,13 +116,18 @@ */ /*! \def mln_bkd_niter_(T) - \brief Shortcuts to access the bkd_niter type associated to T. + + \brief Shortcut to access the backward neighbor iterator type + associated to a neighborhood of type T. + + \param T A type of a class inheriting from mln::Neighborhood. To be used in non-templated functions only. \ingroup macrositernbh \relates mln::Neighborhood */ -/// Shortcuts to access the bkd_niter type associated to T. +/// Shortcuts to access the backward neighbor iterator type associated +/// to a neighborhood of type T. /// \{ # define mln_bkd_niter(T) typename T::bkd_niter # define mln_bkd_niter_(T) T::bkd_niter @@ -126,7 +135,11 @@ /*! \def mln_bkd_piter(T) - \brief Shortcuts to access the bkd_piter type associated to T. + \brief Shortcut to access the backward site iterator type + associated to T. + + \param T A type of a class inheriting from mln::Image or + mln::Site_set. To be used in templated functions only. \ingroup macrositerima @@ -134,13 +147,18 @@ */ /*! \def mln_bkd_piter_(T) - \brief Shortcuts to access the bkd_piter type associated to T. + \brief Shortcut to access the backward site iterator type + associated to T. + + \param T A type of a class inheriting from mln::Image or + mln::Site_set. To be used in non-templated functions only. \ingroup macrositerima \relates mln::Image */ -/// Shortcuts to access the bkd_piter type associated to T. +/// Shortcuts to access the backward site iterator type associated to +/// T. /// \{ # define mln_bkd_piter(T) typename T::bkd_piter # define mln_bkd_piter_(T) T::bkd_piter @@ -148,7 +166,11 @@ /*! \def mln_bkd_qiter(T) - \brief Shortcuts to access the bkd_qiter type associated to T. + + \brief Shortcut to access the backward neighbor iterator type + associated to a window of type T. + + \param T A type of a class inheriting from mln::Window. To be used in templated functions only. \ingroup macrositerwin @@ -156,13 +178,18 @@ */ /*! \def mln_bkd_qiter_(T) - \brief Shortcuts to access the bkd_qiter type associated to T. + + \brief Shortcut to access the backward neighbor iterator type + associated to a window of type T. + + \param T A type of a class inheriting from mln::Window. To be used in non-templated functions only. \ingroup macrositerwin \relates mln::Window mln::Weighted_Window */ -/// Shortcuts to access the bkd_qiter type associated to T. +/// Shortcuts to access the backward neighbor iterator type associated +/// to a window of type T. /// \{ # define mln_bkd_qiter(T) typename T::bkd_qiter # define mln_bkd_qiter_(T) T::bkd_qiter @@ -170,7 +197,7 @@ /*! \def mln_bkd_viter(T) - \brief Shortcuts to access the bkd_viter type associated to T. + \brief Shortcut to access the bkd_viter type associated to T. To be used in templated functions only. \ingroup macrositerval @@ -178,7 +205,7 @@ */ /*! \def mln_bkd_viter_(T) - \brief Shortcuts to access the bkd_viter type associated to T. + \brief Shortcut to access the bkd_viter type associated to T. To be used in non-templated functions only. \ingroup macrositerval @@ -192,7 +219,7 @@ /*! \def mln_box(T) - \brief Shortcuts to access the box type associated to T. + \brief Shortcut to access the box type associated to T. To be used in templated functions only. \ingroup macrosima @@ -200,7 +227,7 @@ */ /*! \def mln_box_(T) - \brief Shortcuts to access the box type associated to T. + \brief Shortcut to access the box type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -217,7 +244,7 @@ /*! \def mln_coord(T) - \brief Shortcuts to access the coord type associated to T. + \brief Shortcut to access the coord type associated to T. To be used in templated functions only. \ingroup macrossite @@ -225,7 +252,7 @@ */ /*! \def mln_coord_(T) - \brief Shortcuts to access the coord type associated to T. + \brief Shortcut to access the coord type associated to T. To be used in non-templated functions only. \ingroup macrossite @@ -242,7 +269,7 @@ /*! \def mln_delta(T) - \brief Shortcuts to access the delta type associated to T. + \brief Shortcut to access the delta type associated to T. To be used in templated functions only. \ingroup macrossite @@ -250,7 +277,7 @@ */ /*! \def mln_delta_(T) - \brief Shortcuts to access the delta type associated to T. + \brief Shortcut to access the delta type associated to T. To be used in non-templated functions only. \ingroup macrossite @@ -264,7 +291,7 @@ /*! \def mln_dpoint(T) - \brief Shortcuts to access the dpoint type associated to T. + \brief Shortcut to access the dpoint type associated to T. To be used in templated functions only. \ingroup macrosima @@ -272,7 +299,7 @@ */ /*! \def mln_dpoint_(T) - \brief Shortcuts to access the dpoint type associated to T. + \brief Shortcut to access the dpoint type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -286,7 +313,7 @@ /*! \def mln_dpsite(T) - \brief Shortcuts to access the dpsite type associated to T. + \brief Shortcut to access the dpsite type associated to T. To be used in templated functions only. \ingroup macrosima @@ -294,7 +321,7 @@ */ /*! \def mln_dpsite_(T) - \brief Shortcuts to access the dpsite type associated to T. + \brief Shortcut to access the dpsite type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -311,14 +338,14 @@ /*! \def mln_eiter(T) - \brief Shortcuts to access the element-iterator type associated to T. + \brief Shortcut to access the element-iterator type associated to T. To be used in templated functions only. \ingroup macrositerval */ /*! \def mln_eiter_(T) - \brief Shortcuts to access the element-iterator type associated to T. + \brief Shortcut to access the element-iterator type associated to T. To be used in non-templated functions only. \ingroup macrositerval @@ -331,14 +358,14 @@ /*! \def mln_graph(T) - \brief Shortcuts to access the graph type associated to T. + \brief Shortcut to access the graph type associated to T. To be used in templated functions only. \ingroup mlnmacros */ /*! \def mln_graph_(T) - \brief Shortcuts to access the graph type associated to T. + \brief Shortcut to access the graph type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -351,7 +378,7 @@ /*! \def mln_element(T) - \brief Shortcuts to access the element type associated to T. + \brief Shortcut to access the element type associated to T. To be used in templated functions only. \ingroup mlnmacros @@ -359,7 +386,7 @@ */ /*! \def mln_element_(T) - \brief Shortcuts to access the element type associated to T. + \brief Shortcut to access the element type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -373,14 +400,14 @@ /*! \def mln_graph_element(T) - \brief Shortcuts to access the graph_element type associated to T. + \brief Shortcut to access the graph_element type associated to T. To be used in templated functions only. \ingroup mlnmacros */ /*! \def mln_graph_element_(T) - \brief Shortcuts to access the graph_element type associated to T. + \brief Shortcut to access the graph_element type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -393,7 +420,7 @@ /*! \def mln_enc(T) - \brief Shortcuts to access the encoding type associated to T. + \brief Shortcut to access the encoding type associated to T. To be used in templated functions only. \ingroup macrosval @@ -401,7 +428,7 @@ */ /*! \def mln_enc_(T) - \brief Shortcuts to access the encoding type associated to T. + \brief Shortcut to access the encoding type associated to T. To be used in non-templated functions only. \ingroup macrosval @@ -415,7 +442,7 @@ /*! \def mln_equiv(T) - \brief Shortcuts to access the equivalent type associated to T. + \brief Shortcut to access the equivalent type associated to T. To be used in templated functions only. \ingroup macrosval @@ -423,7 +450,7 @@ */ /*! \def mln_equiv_(T) - \brief Shortcuts to access the equivalent type associated to T. + \brief Shortcut to access the equivalent type associated to T. To be used in non-templated functions only. \ingroup macrosval @@ -440,7 +467,7 @@ /*! \def mln_fwd_eiter(T) - \brief Shortcuts to access the element-forward-iterator type + \brief Shortcut to access the element-forward-iterator type associated to T. To be used in templated functions only. @@ -448,7 +475,7 @@ */ /*! \def mln_fwd_eiter_(T) - \brief Shortcuts to access the element-forward-iterator type + \brief Shortcut to access the element-forward-iterator type associated to T. To be used in non-templated functions only. @@ -463,7 +490,11 @@ /*! \def mln_fwd_niter(T) - \brief Shortcuts to access the fwd_niter type associated to T. + + \brief Shortcut to access the forward neighbor iterator type + associated to a neighborhood of type T. + + \param T A type of a class inheriting from mln::Neighborhood. To be used in templated functions only. \ingroup macrositernbh @@ -471,13 +502,18 @@ */ /*! \def mln_fwd_niter_(T) - \brief Shortcuts to access the fwd_niter type associated to T. + + \brief Shortcut to access the forward neighbor iterator type + associated to a neighborhood of type T. + + \param T A type of a class inheriting from mln::Neighborhood. To be used in non-templated functions only. \ingroup macrositernbh \relates mln::Neighborhood */ -/// Shortcuts to access the fwd_niter type associated to T. +/// Shortcuts to access the forward neighbor iterator type associated +/// to a neighborhood of type T. /// \{ # define mln_fwd_niter(T) typename T::fwd_niter # define mln_fwd_niter_(T) T::fwd_niter @@ -485,7 +521,12 @@ /*! \def mln_fwd_piter(T) - \brief Shortcuts to access the fwd_piter type associated to T. + + \brief Shortcut to access the forward site iterator type associated + to T. + + \param T A type of a class inheriting from mln::Image or + mln::Site_set. To be used in templated functions only. \ingroup macrositerima @@ -493,13 +534,19 @@ */ /*! \def mln_fwd_piter_(T) - \brief Shortcuts to access the fwd_piter type associated to T. + + \brief Shortcut to access the forward site iterator type associated + to T. + + \param T A type of a class inheriting from mln::Image or + mln::Site_set. To be used in non-templated functions only. \ingroup macrositerima \relates mln::Image */ -/// Shortcuts to access the fwd_piter type associated to T. +/// Shortcuts to access the forward site iterator type associated to +/// T. /// \{ # define mln_fwd_piter(T) typename T::fwd_piter # define mln_fwd_piter_(T) T::fwd_piter @@ -507,7 +554,11 @@ /*! \def mln_fwd_qiter(T) - \brief Shortcuts to access the fwd_qiter type associated to T. + + \brief Shortcut to access the forward neighbor iterator type + associated to a window of type T. + + \param T A type of a class inheriting from mln::Window. To be used in templated functions only. \ingroup macrositerwin @@ -515,13 +566,18 @@ */ /*! \def mln_fwd_qiter_(T) - \brief Shortcuts to access the fwd_qiter type associated to T. + + \brief Shortcut to access the forward neighbor iterator type + associated to a window of site T. + + \param T A type of a class inheriting from mln::Window. To be used in non-templated functions only. \ingroup macrositerwin \relates mln::Window mln::Weighted_Window */ -/// Shortcuts to access the fwd_qiter type associated to T. +/// Shortcuts to access the forward neighbor iterator type associated +/// to a window of site T. /// \{ # define mln_fwd_qiter(T) typename T::fwd_qiter # define mln_fwd_qiter_(T) T::fwd_qiter @@ -529,7 +585,7 @@ /*! \def mln_fwd_viter(T) - \brief Shortcuts to access the fwd_viter type associated to T. + \brief Shortcut to access the fwd_viter type associated to T. To be used in templated functions only. \ingroup macrositerval @@ -537,7 +593,7 @@ */ /*! \def mln_fwd_viter_(T) - \brief Shortcuts to access the fwd_viter type associated to T. + \brief Shortcut to access the fwd_viter type associated to T. To be used in non-templated functions only. \ingroup macrositerval @@ -554,7 +610,7 @@ /*! \def mln_geom(T) - \brief Shortcuts to access the geometry type associated to T. + \brief Shortcut to access the geometry type associated to T. To be used in templated functions only. \ingroup mlnmacros @@ -562,7 +618,7 @@ */ /*! \def mln_geom_(T) - \brief Shortcuts to access the geometry type associated to T. + \brief Shortcut to access the geometry type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -576,7 +632,7 @@ /*! \def mln_grid(T) - \brief Shortcuts to access the grid type associated to T. + \brief Shortcut to access the grid type associated to T. To be used in templated functions only. \ingroup mlnmacros @@ -584,7 +640,7 @@ */ /*! \def mln_grid_(T) - \brief Shortcuts to access the grid type associated to T. + \brief Shortcut to access the grid type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -601,7 +657,7 @@ /*! \def mln_i_element(T) - \brief Shortcuts to access the insertion-element type associated to + \brief Shortcut to access the insertion-element type associated to T. To be used in templated functions only. @@ -609,7 +665,7 @@ */ /*! \def mln_i_element_(T) - \brief Shortcuts to access the insertion-element type associated to + \brief Shortcut to access the insertion-element type associated to T. To be used in non-templated functions only. @@ -623,7 +679,7 @@ /*! \def mln_image(T) - \brief Shortcuts to access the image type associated to + \brief Shortcut to access the image type associated to T. To be used in templated functions only. @@ -631,7 +687,7 @@ */ /*! \def mln_image_(T) - \brief Shortcuts to access the image type associated to + \brief Shortcut to access the image type associated to T. To be used in non-templated functions only. @@ -645,7 +701,7 @@ /*! \def mln_invert(T) - \brief Shortcuts to access the invert type associated to + \brief Shortcut to access the invert type associated to T. To be used in templated functions only. @@ -654,7 +710,7 @@ */ /*! \def mln_invert_(T) - \brief Shortcuts to access the invert type associated to + \brief Shortcut to access the invert type associated to T. To be used in non-templated functions only. @@ -672,7 +728,7 @@ /*! \def mln_lvalue(T) - \brief Shortcuts to access the lvalue type associated to + \brief Shortcut to access the lvalue type associated to T. To be used in templated functions only. @@ -681,7 +737,7 @@ */ /*! \def mln_lvalue_(T) - \brief Shortcuts to access the lvalue type associated to + \brief Shortcut to access the lvalue type associated to T. To be used in non-templated functions only. @@ -699,7 +755,7 @@ /*! \def mln_mesh(T) - \brief Shortcuts to access the mesh type associated to + \brief Shortcut to access the mesh type associated to T. To be used in templated functions only. @@ -707,7 +763,7 @@ */ /*! \def mln_mesh_(T) - \brief Shortcuts to access the mesh type associated to + \brief Shortcut to access the mesh type associated to T. To be used in non-templated functions only. @@ -724,8 +780,12 @@ /*! \def mln_piter(T) - \brief Shortcuts to access the type of point iterator (piter) - associated to T. + + \brief Shortcut to access the default site iterator type associated + to T. + + \param T A type of a class inheriting from mln::Image or + mln::Site_set. To be used in templated functions only. \ingroup macrositerima @@ -733,14 +793,19 @@ */ /*! \def mln_piter_(T) - \brief Shortcuts to access the type of point iterator (piter) - associated to T. + + \brief Shortcut to access the default site iterator type associated + to T. + + \param T A type of a class inheriting from mln::Image or + mln::Site_set. To be used in non-templated functions only. \ingroup macrositerima \relates mln::Image */ -/// Shortcuts to access the type of point iterator (piter) associated to T. +/// Shortcuts to access the default site iterator type associated to +/// T. /// \{ # define mln_piter(T) typename T::piter # define mln_piter_(T) T::piter @@ -748,18 +813,24 @@ /*! \def mln_line_piter(T) - \brief Shortcuts to access the type of point by line iterator + \brief Shortcut to access the type of point by line iterator (line_piter) associated to T. + \param T A type of a class inheriting from mln::Image or + mln::Site_set. + To be used in templated functions only. \ingroup macrositerima \relates mln::Image */ /*! \def mln_line_piter_(T) - \brief Shortcuts to access the type of point by line iterator + \brief Shortcut to access the type of point by line iterator (line_piter) associated to T. + \param T A type of a class inheriting from mln::Image or + mln::Site_set. + To be used in non-templated functions only. \ingroup macrositerima \relates mln::Image @@ -773,7 +844,7 @@ /*! \def mln_domain(T) - \brief Shortcuts to access the domain type associated to T. + \brief Shortcut to access the domain type associated to T. To be used in templated functions only. \ingroup macrosima @@ -781,7 +852,7 @@ */ /*! \def mln_domain_(T) - \brief Shortcuts to access the domain type associated to T. + \brief Shortcut to access the domain type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -795,7 +866,7 @@ /*! \def mln_pset(T) - \brief Shortcuts to access the type of point set (pset) associated + \brief Shortcut to access the type of point set (pset) associated to T. To be used in templated functions only. @@ -804,7 +875,7 @@ */ /*! \def mln_pset_(T) - \brief Shortcuts to access the type of point set (pset) associated + \brief Shortcut to access the type of point set (pset) associated to T. To be used in non-templated functions only. @@ -819,7 +890,7 @@ /*! \def mln_psite(T) - \brief Shortcuts to access the type of point site (psite) associated + \brief Shortcut to access the type of point site (psite) associated to T. To be used in templated functions only. @@ -828,7 +899,7 @@ */ /*! \def mln_psite_(T) - \brief Shortcuts to access the type of point site (psite) associated + \brief Shortcut to access the type of point site (psite) associated to T. To be used in non-templated functions only. @@ -843,7 +914,7 @@ /*! \def mln_point(T) - \brief Shortcuts to access the point type associated to T. + \brief Shortcut to access the point type associated to T. To be used in templated functions only. \ingroup macrosima @@ -851,7 +922,7 @@ */ /*! \def mln_point_(T) - \brief Shortcuts to access the point type associated to T. + \brief Shortcut to access the point type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -868,7 +939,7 @@ /*! \def mln_qlf_value(T) - \brief Shortcuts to access the qualified (const or mutable) value + \brief Shortcut to access the qualified (const or mutable) value type associated to T. To be used in templated functions only. @@ -877,7 +948,7 @@ */ /*! \def mln_qlf_value_(T) - \brief Shortcuts to access the qualified (const or mutable) value + \brief Shortcut to access the qualified (const or mutable) value type associated to T. To be used in non-templated functions only. @@ -893,7 +964,11 @@ /*! \def mln_qiter(T) - \brief Shortcuts to access the qiter type associated to T. + + \brief Shortcut to access the default neighbor iterator type + associated to the window of type T. + + \param T A type of a class inheriting from mln::Window. To be used in templated functions only. \ingroup macrositerwin @@ -901,13 +976,18 @@ */ /*! \def mln_qiter_(T) - \brief Shortcuts to access the qiter type associated to T. + + \brief Shortcut to access the default neighbor iterator type + associated to the window of type T. + + \param T A type of a class inheriting from mln::Window. To be used in non-templated functions only. \ingroup macrositerwin \relates mln::Window mln::Weighted_Window */ -/// Shortcuts to access the qiter type associated to T. +/// Shortcuts to access the default neighbor iterator type associated +/// to the window of type T. /// \{ # define mln_qiter(T) typename T::fwd_qiter # define mln_qiter_(T) T::fwd_qiter @@ -915,7 +995,7 @@ /*! \def mln_q_result(T) - \brief Shortcuts to access the qualified-result type associated to + \brief Shortcut to access the qualified-result type associated to T. To be used in templated functions only. @@ -924,7 +1004,7 @@ */ /*! \def mln_q_result_(T) - \brief Shortcuts to access the qualified-result type associated to + \brief Shortcut to access the qualified-result type associated to T. To be used in non-templated functions only. @@ -939,7 +1019,7 @@ /*! \def mln_q_subject(T) - \brief Shortcuts to access the qualified-subject type associated to + \brief Shortcut to access the qualified-subject type associated to T. To be used in templated functions only. @@ -947,7 +1027,7 @@ */ /*! \def mln_q_subject_(T) - \brief Shortcuts to access the qualified-subject type associated to + \brief Shortcut to access the qualified-subject type associated to T. To be used in non-templated functions only. @@ -964,7 +1044,11 @@ /*! \def mln_niter(T) - \brief Shortcuts to access the niter type associated to T. + + \brief Shortcut to access the default neighbor iterator type + associated to a neighborhood of type T. + + \param T A type of a class inheriting from mln::Neighborhood. To be used in templated functions only. \ingroup macrositernbh @@ -972,13 +1056,18 @@ */ /*! \def mln_niter_(T) - \brief Shortcuts to access the niter type associated to T. + + \brief Shortcut to access the default neighbor iterator type + associated to a neighborhood of type T. + + \param T A type of a class inheriting from mln::Neighborhood. To be used in non-templated functions only. \ingroup macrositernbh \relates mln::Neighborhood */ -/// Shortcuts to access the niter type associated to T. +/// Shortcuts to access the default neighbor iterator type associated +/// to a neighborhood of type T. /// \{ # define mln_niter(T) typename T::fwd_niter # define mln_niter_(T) T::fwd_niter @@ -989,14 +1078,14 @@ /*! \def mln_r_element(T) - \brief Shortcuts to access the removal-element type associated to T. + \brief Shortcut to access the removal-element type associated to T. To be used in templated functions only. \ingroup mlnmacros */ /*! \def mln_r_element_(T) - \brief Shortcuts to access the removal-element type associated to T. + \brief Shortcut to access the removal-element type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -1009,14 +1098,14 @@ /*! \def mln_regular(T) - \brief Shortcuts to access the regular type associated to T. + \brief Shortcut to access the regular type associated to T. To be used in templated functions only. \ingroup mlnmacros */ /*! \def mln_regular_(T) - \brief Shortcuts to access the regular type associated to T. + \brief Shortcut to access the regular type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -1029,7 +1118,7 @@ /*! \def mln_result(T) - \brief Shortcuts to access the result type associated to T. + \brief Shortcut to access the result type associated to T. To be used in templated functions only. \ingroup macrosfun @@ -1037,7 +1126,7 @@ */ /*! \def mln_result_(T) - \brief Shortcuts to access the result type associated to T. + \brief Shortcut to access the result type associated to T. To be used in non-templated functions only. \ingroup macrosfun @@ -1051,7 +1140,7 @@ /*! \def mln_rvalue(T) - \brief Shortcuts to access the value type associated to T. + \brief Shortcut to access the value type associated to T. To be used in templated functions only. \ingroup macrosfun @@ -1059,7 +1148,7 @@ */ /*! \def mln_rvalue_(T) - \brief Shortcuts to access the value type associated to T. + \brief Shortcut to access the value type associated to T. To be used in non-templated functions only. \ingroup macrosfun @@ -1076,7 +1165,7 @@ /*! \def mln_site(T) - \brief Shortcuts to access the site type associated to T. + \brief Shortcut to access the site type associated to T. To be used in templated functions only. \ingroup macrosima @@ -1084,7 +1173,7 @@ */ /*! \def mln_site_(T) - \brief Shortcuts to access the site type associated to T. + \brief Shortcut to access the site type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -1107,14 +1196,14 @@ /*! \def mln_target(T) - \brief Shortcuts to access the target type associated to T. + \brief Shortcut to access the target type associated to T. To be used in templated functions only. \ingroup mlnmacros */ /*! \def mln_target_(T) - \brief Shortcuts to access the target type associated to T. + \brief Shortcut to access the target type associated to T. To be used in non-templated functions only. \ingroup mlnmacros @@ -1131,7 +1220,7 @@ /*! \def mln_unmorph(T) - \brief Shortcuts to access the unmorph type associated to T. + \brief Shortcut to access the unmorph type associated to T. To be used in templated functions only. \ingroup macrosima @@ -1139,7 +1228,7 @@ */ /*! \def mln_unmorph_(T) - \brief Shortcuts to access the unmorph type associated to T. + \brief Shortcut to access the unmorph type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -1157,7 +1246,7 @@ /*! \def mln_value(T) - \brief Shortcuts to access the value type associated to T. + \brief Shortcut to access the value type associated to T. To be used in templated functions only. \ingroup macrosima @@ -1165,7 +1254,7 @@ */ /*! \def mln_value_(T) - \brief Shortcuts to access the value type associated to T. + \brief Shortcut to access the value type associated to T. To be used in non-templated functions only. \ingroup macrosima @@ -1179,7 +1268,7 @@ /*! \def mln_vec(T) - \brief Shortcuts to access the algebra::vector (vec) type associated + \brief Shortcut to access the algebra::vector (vec) type associated to T. To be used in templated functions only. @@ -1187,7 +1276,7 @@ */ /*! \def mln_vec_(T) - \brief Shortcuts to access the algebra::vector (vec) type associated + \brief Shortcut to access the algebra::vector (vec) type associated to T. To be used in non-templated functions only. @@ -1201,7 +1290,7 @@ /*! \def mln_vset(T) - \brief Shortcuts to access the type of value set (vset) associated + \brief Shortcut to access the type of value set (vset) associated to T. To be used in templated functions only. @@ -1210,7 +1299,7 @@ */ /*! \def mln_vset_(T) - \brief Shortcuts to access the type of value set (vset) associated + \brief Shortcut to access the type of value set (vset) associated to T. To be used in non-templated functions only. @@ -1225,7 +1314,7 @@ /*! \def mln_viter(T) - \brief Shortcuts to access the viter type associated to T. + \brief Shortcut to access the viter type associated to T. To be used in templated functions only. \ingroup macrositerval @@ -1233,7 +1322,7 @@ */ /*! \def mln_viter_(T) - \brief Shortcuts to access the viter type associated to T. + \brief Shortcut to access the viter type associated to T. To be used in non-templated functions only. \ingroup macrositerval @@ -1250,7 +1339,7 @@ /*! \def mln_weight(T) - \brief Shortcuts to access the weight type associated to T. + \brief Shortcut to access the weight type associated to T. To be used in templated functions only. \ingroup macroswin @@ -1258,7 +1347,7 @@ */ /*! \def mln_weight_(T) - \brief Shortcuts to access the weight type associated to T. + \brief Shortcut to access the weight type associated to T. To be used in non-templated functions only. \ingroup macroswin @@ -1272,7 +1361,7 @@ /*! \def mln_window(T) - \brief Shortcuts to access the window type associated to T. + \brief Shortcut to access the window type associated to T. To be used in templated functions only. \ingroup macrosnbh @@ -1280,7 +1369,7 @@ */ /*! \def mln_window_(T) - \brief Shortcuts to access the window type associated to T. + \brief Shortcut to access the window type associated to T. To be used in non-templated functions only. \ingroup macrosnbh @@ -1299,7 +1388,7 @@ /*! \def mln_fwd_pixter(T) - \brief Shortcuts to access the fwd_pixter type associated to T. + \brief Shortcut to access the fwd_pixter type associated to T. Iterator on image sites, to be used with concrete images only. @@ -1309,7 +1398,7 @@ */ /*! \def mln_fwd_pixter_(T) - \brief Shortcuts to access the fwd_pixter type associated to T. + \brief Shortcut to access the fwd_pixter type associated to T. Iterator on image sites, to be used with concrete images only. @@ -1322,7 +1411,7 @@ /*! \def mln_bkd_pixter(T) - \brief Shortcuts to access the bkd_pixter type associated to T. + \brief Shortcut to access the bkd_pixter type associated to T. Iterator on image sites, to be used with concrete images only. @@ -1332,7 +1421,7 @@ */ /*! \def mln_bkd_pixter_(T) - \brief Shortcuts to access the bkd_pixter type associated to T. + \brief Shortcut to access the bkd_pixter type associated to T. Iterator on image sites, to be used with concrete images only. @@ -1345,7 +1434,7 @@ /*! \def mln_pixter(T) - \brief Shortcuts to access the pixter type associated to T. + \brief Shortcut to access the pixter type associated to T. Iterator on image sites, to be used with concrete images only. @@ -1355,7 +1444,7 @@ */ /*! \def mln_pixter_(T) - \brief Shortcuts to access the pixter type associated to T. + \brief Shortcut to access the pixter type associated to T. Iterator on image sites, to be used with concrete images only. @@ -1368,7 +1457,7 @@ /*! \def mln_fwd_qixter(T) - \brief Shortcuts to access the fwd_qixter type associated to T. + \brief Shortcut to access the fwd_qixter type associated to T. Iterator on window elements, to be used with concrete images only. @@ -1378,7 +1467,7 @@ */ /*! \def mln_fwd_qixter_(T) - \brief Shortcuts to access the fwd_qixter type associated to T. + \brief Shortcut to access the fwd_qixter type associated to T. Iterator on window elements, to be used with concrete images only. @@ -1391,7 +1480,7 @@ /*! \def mln_bkd_qixter(T) - \brief Shortcuts to access the bkd_qixter type associated to T. + \brief Shortcut to access the bkd_qixter type associated to T. Iterator on window elements, to be used with concrete images only. @@ -1401,7 +1490,7 @@ */ /*! \def mln_bkd_qixter_(T) - \brief Shortcuts to access the bkd_qixter type associated to T. + \brief Shortcut to access the bkd_qixter type associated to T. Iterator on window elements, to be used with concrete images only. @@ -1415,7 +1504,7 @@ /*! \def mln_qixter(T) - \brief Shortcuts to access the qixter type associated to T. + \brief Shortcut to access the qixter type associated to T. Iterator on window elements, to be used with concrete images only. @@ -1425,7 +1514,7 @@ */ /*! \def mln_qixter_(T) - \brief Shortcuts to access the qixter type associated to T. + \brief Shortcut to access the qixter type associated to T. Iterator on window elements, to be used with concrete images only. @@ -1438,7 +1527,7 @@ /*! \def mln_fwd_nixter(T) - \brief Shortcuts to access the fwd_nixter type associated to T. + \brief Shortcut to access the fwd_nixter type associated to T. Iterator on neighborhood elements, to be used with concrete images only. @@ -1449,7 +1538,7 @@ */ /*! \def mln_fwd_nixter_(T) - \brief Shortcuts to access the fwd_nixter type associated to T. + \brief Shortcut to access the fwd_nixter type associated to T. Iterator on neighborhood elements, to be used with concrete images only. @@ -1463,7 +1552,7 @@ /*! \def mln_bkd_nixter(T) - \brief Shortcuts to access the bkd_nixter type associated to T. + \brief Shortcut to access the bkd_nixter type associated to T. Iterator on neighborhood elements, to be used with concrete images only. @@ -1474,7 +1563,7 @@ */ /*! \def mln_bkd_nixter_(T) - \brief Shortcuts to access the bkd_nixter type associated to T. + \brief Shortcut to access the bkd_nixter type associated to T. Iterator on neighborhood elements, to be used with concrete images only. @@ -1488,7 +1577,7 @@ /*! \def mln_nixter(T) - \brief Shortcuts to access the nixter type associated to T. + \brief Shortcut to access the nixter type associated to T. Iterator on neighborhood elements, to be used with concrete images only. @@ -1499,7 +1588,7 @@ */ /*! \def mln_nixter_(T) - \brief Shortcuts to access the nixter type associated to T. + \brief Shortcut to access the nixter type associated to T. Iterator on neighborhood elements, to be used with concrete images only. diff --git a/milena/mln/core/var.hh b/milena/mln/core/var.hh index 41e6fcd..b8d5b07 100644 --- a/milena/mln/core/var.hh +++ b/milena/mln/core/var.hh @@ -41,7 +41,7 @@ \brief Deduce the type of Expr, create a variable of that type and assign the result to it. - \warning Theses macro rely on an extension of g++ (\c typeof) so it + \warning This macro rely on an extension of g++ (\c typeof) so it is NOT standard C++. \ingroup mlnmacros @@ -52,11 +52,11 @@ typedef typeof(Expr) Var##_t /*! - \def mln_const VAR(Var, Expr) + \def mln_const_VAR(Var, Expr) \brief Deduce the type of Expr, create a const variable of that type and assign the result to it. - \warning Theses macro rely on an extension of g++ (\c typeof) so it + \warning This macro rely on an extension of g++ (\c typeof) so it is NOT standard C++. \ingroup mlnmacros diff --git a/milena/mln/debug/trace.hh b/milena/mln/debug/trace.hh index bddd8a1..9352d7b 100644 --- a/milena/mln/debug/trace.hh +++ b/milena/mln/debug/trace.hh @@ -36,10 +36,26 @@ # include <ctime> # include <mln/core/contract.hh> +/*! + \def mln_trace(S) + \brief Create a trace entry with S as name. + + This macro must be called once at the beginning of a function. + + \sa mln::debug::trace +*/ # define mln_trace(S) \ mln::debug::trace mln_trace_(S); \ (void) mln_trace_; +/*! + \def mln_trace_warning(S) + \brief Create a warning entry with S as message. + + This macro can be called anytime and anywhere. + + \sa mln::debug::trace +*/ # define mln_trace_warning(S) \ mln::debug::trace::warning(S); @@ -73,6 +89,8 @@ namespace mln \warning mln_trace() declares a named local variable, so do not use mln_trace twice in the same scope in order to avoid duplicate declarations. + + \sa mln_trace mln_trace_warning */ class trace { diff --git a/milena/mln/trait/value_.hh b/milena/mln/trait/value_.hh index 404b204..16f4cd9 100644 --- a/milena/mln/trait/value_.hh +++ b/milena/mln/trait/value_.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -50,18 +51,79 @@ # define mln_trait_value_quant_(V) mln::trait::value_< V >::quant +/*! \def mln_card(V) + \brief Returns the cardinality (number of possible values) of type + V. + + \ingroup macrosval +*/ # define mln_card(V) mln::trait::value_< V >::card + +/*! + \def mln_dim(V) + \brief Returns the dimension of the values of type V. + + \ingroup macrosval +*/ # define mln_dim(V) mln::trait::value_< V >::dim + +/*! + \def mln_epsilon(V) + \brief Returns the closest value to 0 of the type V. + + \ingroup macrosval +*/ # define mln_epsilon(V) mln::trait::value_< V >::epsilon() + +/*! + \def mln_max(V) + \brief Returns the maximum value the type V. + + \ingroup macrosval +*/ # define mln_max(V) mln::trait::value_< V >::max() + +/*! + \def mln_min(V) + \brief Returns the minimum value the type V. + + \ingroup macrosval +*/ # define mln_min(V) mln::trait::value_< V >::min() + +/*! + \def mln_min(V) + \brief Returns the number of bits used to encode values of type V. + + \ingroup macrosval +*/ # define mln_nbits(V) mln::trait::value_< V >::nbits /// Give the summation type for values of type \c T. # define mln_trait_value_sum(V) typename mln::trait::value_< V >::sum # define mln_trait_value_sum_(V) mln::trait::value_< V >::sum + +/*! + \def mln_sum(V) + \brief Returns the smallest type which can encode the sum of two + values of type V. + + This macro must be used in templated functions only. + + \ingroup macrosval +*/ # define mln_sum(V) mln_trait_value_sum(V) + +/*! + \def mln_sum_(V) + \brief Returns the smallest type which can encode the sum of two + values of type V. + + This macro must be used in non-templated functions only. + + \ingroup macrosval +*/ # define mln_sum_(V) mln_trait_value_sum_(V) /// Give the value type name @@ -76,12 +138,23 @@ mln::trait::value::quant::low) -/// Give the cardinality of the set of values having N bits. -// -// Technical note: -// This macro might seem weird, yet it is NOT. We have to change the value -// of N, even when N is less than the low quant threshold, because otherwise -// the call to mlc_pow_int would lead to compilation errors. +/*! + \def mln_value_card_from_(N) + \brief Give the cardinality of the set of values having N bits. + + \param[in] N An unsigned corresponding to a number of bits. + + \ingroup macrosval + + \internal + + Technical note: + This macro might seem weird, yet it is NOT. We have to change the value + of N, even when N is less than the low quant threshold, because otherwise + the call to mlc_pow_int would lead to compilation errors. + + \endinternal +*/ # define mln_value_card_from_(N) \ (int(N) <= int(mln::def::low_quant_nbits) \ ? mlc_pow_int((N <= 16 ? 2 : 1), \ -- 1.7.2.5

1 0

olena: olena-2.0-599-g6850b80 Fix missing parts of mln::box interface in documentation.
by Guillaume Lazzara 03 May '13

03 May '13

* doc/mln/core/alias/box1d.dox, * doc/mln/core/alias/box2d.dox, * doc/mln/core/alias/box2d_h.dox, * doc/mln/core/alias/box3d.dox: Make class inherit from box_impl. Conflicts: milena/ChangeLog --- milena/ChangeLog | 9 +++++++++ milena/doc/mln/core/alias/box1d.dox | 4 +++- milena/doc/mln/core/alias/box2d.dox | 4 +++- milena/doc/mln/core/alias/box2d_h.dox | 4 +++- milena/doc/mln/core/alias/box3d.dox | 4 +++- 5 files changed, 21 insertions(+), 4 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 802263d..1d6a146 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,14 @@ 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Fix missing parts of mln::box interface in documentation. + + * doc/mln/core/alias/box1d.dox, + * doc/mln/core/alias/box2d.dox, + * doc/mln/core/alias/box2d_h.dox, + * doc/mln/core/alias/box3d.dox: Make class inherit from box_impl. + +2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/core/var.hh: Document mln_VAR(). 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/milena/doc/mln/core/alias/box1d.dox b/milena/doc/mln/core/alias/box1d.dox index d2f3827..f1460bd 100644 --- a/milena/doc/mln/core/alias/box1d.dox +++ b/milena/doc/mln/core/alias/box1d.dox @@ -3,7 +3,9 @@ namespace mln { - class box1d : public mln::box<mln::point1d> + class box1d + : public mln::box<mln::point1d>, + public internal::box_impl_<1,C,E> { public: /// \brief Constructor without argument. diff --git a/milena/doc/mln/core/alias/box2d.dox b/milena/doc/mln/core/alias/box2d.dox index f599a79..68a826e 100644 --- a/milena/doc/mln/core/alias/box2d.dox +++ b/milena/doc/mln/core/alias/box2d.dox @@ -3,7 +3,9 @@ namespace mln { - class box2d : public mln::box<mln::point2d> + class box2d + : public mln::box<mln::point2d>, + public internal::box_impl_<2,C,E> { public: /// \brief Constructor without argument. diff --git a/milena/doc/mln/core/alias/box2d_h.dox b/milena/doc/mln/core/alias/box2d_h.dox index 5cc21c6..a456ca4 100644 --- a/milena/doc/mln/core/alias/box2d_h.dox +++ b/milena/doc/mln/core/alias/box2d_h.dox @@ -3,7 +3,9 @@ namespace mln { - class box2d_h : public mln::box<mln::point2d_h> + class box2d_h + : public mln::box<mln::point2d_h>, + public internal::box_impl_<2,C,E> { public: /// \brief Constructor without argument. diff --git a/milena/doc/mln/core/alias/box3d.dox b/milena/doc/mln/core/alias/box3d.dox index f5fc020..ba02547 100644 --- a/milena/doc/mln/core/alias/box3d.dox +++ b/milena/doc/mln/core/alias/box3d.dox @@ -3,7 +3,9 @@ namespace mln { - class box3d : public mln::box<mln::point3d> + class box3d + : public mln::box<mln::point3d>, + public internal::box_impl_<3,C,E> { public: /// \brief Constructor without argument. -- 1.7.2.5

1 0

olena: branch exp/newdoc updated: olena-2.0-599-gc55a823
by git＠lrde.epita.fr 03 May '13

03 May '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch exp/newdoc has been updated via c55a823794f4f0cfaebd3e53911be7e8216e98fb (commit) from 83bbddc126e6e94226cf51f60361baef1cfcdf0b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- c55a823 mln/core/var.hh: Document mln_VAR(). ----------------------------------------------------------------------- Summary of changes: milena/ChangeLog | 4 ++++ milena/mln/core/var.hh | 26 ++++++++++++++++++++++---- 2 files changed, 26 insertions(+), 4 deletions(-) hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena: olena-2.0-598-g75a0e90 mln/core/var.hh: Document mln_VAR().
by Guillaume Lazzara 03 May '13

03 May '13

--- milena/ChangeLog | 4 ++++ milena/mln/core/var.hh | 26 ++++++++++++++++++++++---- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 57e00ff..802263d 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/core/var.hh: Document mln_VAR(). + +2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Cross reference algebra::vec and make::vec in their respective documentation. diff --git a/milena/mln/core/var.hh b/milena/mln/core/var.hh index 9892815..41e6fcd 100644 --- a/milena/mln/core/var.hh +++ b/milena/mln/core/var.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -35,14 +36,31 @@ # include <mln/core/macros.hh> -/// Definition of the macro mln_VAR. -/// Deduce the type of Expr, create a variable of that type and assign the -/// result to it. +/*! + \def mln_VAR(Var, Expr) + \brief Deduce the type of Expr, create a variable of that type and + assign the result to it. + + \warning Theses macro rely on an extension of g++ (\c typeof) so it + is NOT standard C++. + + \ingroup mlnmacros +*/ #define mln_VAR(Var, Expr) \ \ typeof(Expr) Var = Expr; \ typedef typeof(Expr) Var##_t +/*! + \def mln_const VAR(Var, Expr) + \brief Deduce the type of Expr, create a const variable of that type + and assign the result to it. + + \warning Theses macro rely on an extension of g++ (\c typeof) so it + is NOT standard C++. + + \ingroup mlnmacros +*/ #define mln_const_VAR(Var, Expr) \ \ const typeof(Expr) Var = Expr; \ -- 1.7.2.5

1 0

olena: olena-2.0-599-gc55a823 mln/core/var.hh: Document mln_VAR().
by Guillaume Lazzara 03 May '13

03 May '13

--- milena/ChangeLog | 4 ++++ milena/mln/core/var.hh | 26 ++++++++++++++++++++++---- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index b868951..20eef46 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/core/var.hh: Document mln_VAR(). + +2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Fix missing parts of mln::box interface in documentation. * doc/mln/core/alias/box1d.dox, diff --git a/milena/mln/core/var.hh b/milena/mln/core/var.hh index 9892815..41e6fcd 100644 --- a/milena/mln/core/var.hh +++ b/milena/mln/core/var.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -35,14 +36,31 @@ # include <mln/core/macros.hh> -/// Definition of the macro mln_VAR. -/// Deduce the type of Expr, create a variable of that type and assign the -/// result to it. +/*! + \def mln_VAR(Var, Expr) + \brief Deduce the type of Expr, create a variable of that type and + assign the result to it. + + \warning Theses macro rely on an extension of g++ (\c typeof) so it + is NOT standard C++. + + \ingroup mlnmacros +*/ #define mln_VAR(Var, Expr) \ \ typeof(Expr) Var = Expr; \ typedef typeof(Expr) Var##_t +/*! + \def mln_const VAR(Var, Expr) + \brief Deduce the type of Expr, create a const variable of that type + and assign the result to it. + + \warning Theses macro rely on an extension of g++ (\c typeof) so it + is NOT standard C++. + + \ingroup mlnmacros +*/ #define mln_const_VAR(Var, Expr) \ \ const typeof(Expr) Var = Expr; \ -- 1.7.2.5

1 0

olena: branch exp/newdoc updated: olena-2.0-598-g83bbddc
by git＠lrde.epita.fr 03 May '13

03 May '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch exp/newdoc has been updated via 83bbddc126e6e94226cf51f60361baef1cfcdf0b (commit) from 9e1435d37beb2b0b9cd3d7c5cac4d82fe71a4011 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- 83bbddc Fix missing parts of mln::box interface in documentation. ----------------------------------------------------------------------- Summary of changes: milena/ChangeLog | 8 ++++++++ milena/doc/mln/core/alias/box1d.dox | 4 +++- milena/doc/mln/core/alias/box2d.dox | 4 +++- milena/doc/mln/core/alias/box3d.dox | 4 +++- 4 files changed, 17 insertions(+), 3 deletions(-) hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena: olena-2.0-598-g83bbddc Fix missing parts of mln::box interface in documentation.
by Guillaume Lazzara 03 May '13

03 May '13

* doc/mln/core/alias/box1d.dox, * doc/mln/core/alias/box2d.dox, * doc/mln/core/alias/box3d.dox: Make class inherit from box_impl. --- milena/ChangeLog | 8 ++++++++ milena/doc/mln/core/alias/box1d.dox | 4 +++- milena/doc/mln/core/alias/box2d.dox | 4 +++- milena/doc/mln/core/alias/box3d.dox | 4 +++- 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 57e00ff..b868951 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Fix missing parts of mln::box interface in documentation. + + * doc/mln/core/alias/box1d.dox, + * doc/mln/core/alias/box2d.dox, + * doc/mln/core/alias/box3d.dox: Make class inherit from box_impl. + +2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Cross reference algebra::vec and make::vec in their respective documentation. diff --git a/milena/doc/mln/core/alias/box1d.dox b/milena/doc/mln/core/alias/box1d.dox index d2f3827..c092edc 100644 --- a/milena/doc/mln/core/alias/box1d.dox +++ b/milena/doc/mln/core/alias/box1d.dox @@ -3,7 +3,9 @@ namespace mln { - class box1d : public mln::box<mln::point1d> + class box1d + : public mln::box<mln::point1d> + public internal::box_impl_<1,def::coord,box<mln::point1d> > { public: /// \brief Constructor without argument. diff --git a/milena/doc/mln/core/alias/box2d.dox b/milena/doc/mln/core/alias/box2d.dox index f599a79..3e5ebf5 100644 --- a/milena/doc/mln/core/alias/box2d.dox +++ b/milena/doc/mln/core/alias/box2d.dox @@ -3,7 +3,9 @@ namespace mln { - class box2d : public mln::box<mln::point2d> + class box2d + : public mln::box<mln::point2d>, + public internal::box_impl_<2,def::coord,box<mln::point2d> > { public: /// \brief Constructor without argument. diff --git a/milena/doc/mln/core/alias/box3d.dox b/milena/doc/mln/core/alias/box3d.dox index f5fc020..3c14d55 100644 --- a/milena/doc/mln/core/alias/box3d.dox +++ b/milena/doc/mln/core/alias/box3d.dox @@ -3,7 +3,9 @@ namespace mln { - class box3d : public mln::box<mln::point3d> + class box3d + : public mln::box<mln::point3d> + public internal::box_impl_<3,def::coord,box<mln::point3d> > { public: /// \brief Constructor without argument. -- 1.7.2.5

1 0

olena: branch exp/newdoc updated: olena-2.0-597-g9e1435d
by git＠lrde.epita.fr 03 May '13

03 May '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch exp/newdoc has been updated via 9e1435d37beb2b0b9cd3d7c5cac4d82fe71a4011 (commit) via 34062afdd8cfdb76e2afc29e884540fb085e0b42 (commit) via daec0fb172ffa4fe95569ea34d4bb5898acdfdf7 (commit) from 84a382e74cae76fd681bde2d6473a1975b62ec98 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- 9e1435d Cross reference algebra::vec and make::vec in their respective documentation. 34062af Document extended and transformed_image morphers. daec0fb mln/core/site_set/box.hh: Add shrink() and to_smaller() members. ----------------------------------------------------------------------- Summary of changes: milena/ChangeLog | 38 +++++++++++++++ milena/doc/examples-outputs.mk | 36 ++++++++++++++ milena/doc/examples.dox | 5 ++ milena/doc/examples.mk | 2 + milena/doc/examples/extended_image.cc | 51 ++++++++++++++++++++ milena/doc/examples/transformed_image.cc | 31 ++++++++++++ milena/doc/outputs.mk | 2 + ...-right-instantiation.txt => extended_image.txt} | 0 ...ght-instantiation.txt => transformed_image.txt} | 0 milena/doc/programs-examples.mk | 7 ++- milena/mln/algebra/vec.hh | 15 ++++++ milena/mln/core/image/dmorph/extended.hh | 41 ++++++++++++++-- milena/mln/core/image/dmorph/transformed_image.hh | 33 +++++++++++-- milena/mln/core/site_set/box.hh | 51 ++++++++++++++++++++ milena/mln/fun/p2p/fold.hh | 2 +- milena/mln/fun/p2p/mirror.hh | 2 +- milena/mln/fun/p2p/translation.hh | 8 +++- milena/mln/make/vec.hh | 7 ++- 18 files changed, 318 insertions(+), 13 deletions(-) create mode 100644 milena/doc/examples/extended_image.cc create mode 100644 milena/doc/examples/transformed_image.cc copy milena/doc/outputs/{accu-right-instantiation.txt => extended_image.txt} (100%) copy milena/doc/outputs/{accu-right-instantiation.txt => transformed_image.txt} (100%) hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena: olena-2.0-597-g9e1435d Cross reference algebra::vec and make::vec in their respective documentation.
by Guillaume Lazzara 03 May '13

03 May '13

* mln/algebra/vec.hh, * mln/make/vec.hh: Here. --- milena/ChangeLog | 8 ++++++++ milena/mln/algebra/vec.hh | 15 +++++++++++++++ milena/mln/make/vec.hh | 7 ++++++- 3 files changed, 29 insertions(+), 1 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 90c97df..57e00ff 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Cross reference algebra::vec and make::vec in their respective + documentation. + + * mln/algebra/vec.hh, + * mln/make/vec.hh: Here. + +2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Document extended and transformed_image morphers. * doc/examples-outputs.mk, diff --git a/milena/mln/algebra/vec.hh b/milena/mln/algebra/vec.hh index d988cf4..1f7079c 100644 --- a/milena/mln/algebra/vec.hh +++ b/milena/mln/algebra/vec.hh @@ -33,6 +33,7 @@ # include <iostream> # include <cmath> +# include <vector> # include <mln/core/concept/object.hh> @@ -179,6 +180,8 @@ namespace mln /*! \brief N-dimensional vector. + + \sa mln::make::vec \ingroup mlnalgebratypes */ template <unsigned n, typename T> @@ -214,6 +217,8 @@ namespace mln template <typename U> vec(const vec<n, U>& rhs); + vec(const std::vector<T>& rhs); + template <typename U> vec& operator=(const vec<n, U>& rhs); @@ -596,6 +601,16 @@ namespace mln } template <unsigned n, typename T> + inline + vec<n,T>::vec(const std::vector<T>& rhs) + : super_() + { + mln_assertion(rhs.size() == n); + for (unsigned i = 0; i < n; ++i) + data_[i] = rhs[i]; + } + + template <unsigned n, typename T> template <typename U> inline vec<n,T>& vec<n,T>::operator=(const vec<n, U>& rhs) diff --git a/milena/mln/make/vec.hh b/milena/mln/make/vec.hh index dc4fe28..a253cf6 100644 --- a/milena/mln/make/vec.hh +++ b/milena/mln/make/vec.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2006, 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2006, 2007, 2008, 2009, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -46,6 +47,7 @@ namespace mln * \param[in] v_0 First coordinate. * * \return A 1D vector. + * \sa mln::algebra::vec */ template <typename T> algebra::vec<1, T> vec(const T& v_0); @@ -56,6 +58,7 @@ namespace mln * \param[in] v_1 Second coordinate. * * \return A 2D vector. + * \sa mln::algebra::vec */ template <typename T> algebra::vec<2, T> vec(const T& v_0, const T& v_1); @@ -67,6 +70,7 @@ namespace mln * \param[in] v_2 Third coordinate. * * \return A 3D vector. + * \sa mln::algebra::vec */ template <typename T> algebra::vec<3, T> vec(const T& v_0, const T& v_1, const T& v_2); @@ -79,6 +83,7 @@ namespace mln * \param[in] v_3 Fourth coordinate. * * \return A 4D vector. + * \sa mln::algebra::vec */ template <typename T> algebra::vec<4, T> vec(const T& v_0, const T& v_1, const T& v_2, const T& v_3); -- 1.7.2.5

1 0

olena: olena-2.0-596-g34062af Document extended and transformed_image morphers.
by Guillaume Lazzara 03 May '13

03 May '13

* doc/examples-outputs.mk, * doc/examples.mk, * doc/outputs.mk: Regen. * doc/examples.dox: Add link to new examples. * doc/outputs/extended_image.txt, * doc/outputs/transformed_image.txt, * doc/examples/extended_image.cc, * doc/examples/transformed_image.cc: New. * doc/programs-examples.mk: Add new example programs. * mln/core/image/dmorph/extended.hh, * mln/core/image/dmorph/transformed_image.hh: Write documentation and insert example code. * mln/fun/p2p/fold.hh, * mln/fun/p2p/mirror.hh, * mln/fun/p2p/translation.hh: Make references to transformed_image. --- milena/ChangeLog | 26 ++++++++++ milena/doc/examples-outputs.mk | 36 ++++++++++++++ milena/doc/examples.dox | 5 ++ milena/doc/examples.mk | 2 + milena/doc/examples/extended_image.cc | 51 ++++++++++++++++++++ milena/doc/examples/transformed_image.cc | 31 ++++++++++++ milena/doc/outputs.mk | 2 + ...-right-instantiation.txt => extended_image.txt} | 0 ...ght-instantiation.txt => transformed_image.txt} | 0 milena/doc/programs-examples.mk | 7 ++- milena/mln/core/image/dmorph/extended.hh | 41 ++++++++++++++-- milena/mln/core/image/dmorph/transformed_image.hh | 33 +++++++++++-- milena/mln/fun/p2p/fold.hh | 2 +- milena/mln/fun/p2p/mirror.hh | 2 +- milena/mln/fun/p2p/translation.hh | 8 +++- 15 files changed, 234 insertions(+), 12 deletions(-) create mode 100644 milena/doc/examples/extended_image.cc create mode 100644 milena/doc/examples/transformed_image.cc copy milena/doc/outputs/{accu-right-instantiation.txt => extended_image.txt} (100%) copy milena/doc/outputs/{accu-right-instantiation.txt => transformed_image.txt} (100%) diff --git a/milena/ChangeLog b/milena/ChangeLog index 9cca6a5..90c97df 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,31 @@ 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + Document extended and transformed_image morphers. + + * doc/examples-outputs.mk, + * doc/examples.mk, + * doc/outputs.mk: Regen. + + * doc/examples.dox: Add link to new examples. + + * doc/outputs/extended_image.txt, + * doc/outputs/transformed_image.txt, + * doc/examples/extended_image.cc, + * doc/examples/transformed_image.cc: New. + + * doc/programs-examples.mk: Add new example programs. + + * mln/core/image/dmorph/extended.hh, + * mln/core/image/dmorph/transformed_image.hh: Write documentation + and insert example code. + + * mln/fun/p2p/fold.hh, + * mln/fun/p2p/mirror.hh, + * mln/fun/p2p/translation.hh: Make references to + transformed_image. + +2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/core/site_set/box.hh: Add shrink() and to_smaller() members. 2013-04-30 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/milena/doc/examples-outputs.mk b/milena/doc/examples-outputs.mk index 51bba63..1136c55 100644 --- a/milena/doc/examples-outputs.mk +++ b/milena/doc/examples-outputs.mk @@ -127,6 +127,24 @@ $(srcdir)/outputs/extend.txt: $(srcdir)/examples/extend.stamp fi +$(srcdir)/examples/extended_image.stamp: examples/extended_image.cc + @rm -f $@.tmp + @touch $@.tmp + $(MAKE) $(AM_MAKEFLAGS) extended_image$(EXEEXT) + ./extended_image$(EXEEXT) >$(srcdir)/outputs/extended_image.txt.tmp + mv $(srcdir)/outputs/extended_image.txt.tmp $(srcdir)/outputs/extended_image.txt + @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/examples/extended_image.stamp +MAINTAINERCLEANFILES += $(srcdir)/examples/extended_image.stamp + +$(srcdir)/outputs/extended_image.txt: $(srcdir)/examples/extended_image.stamp +## Recover from the removal of $@ + @if test -f $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + + $(srcdir)/examples/extension-ignore.stamp: examples/extension-ignore.cc @rm -f $@.tmp @touch $@.tmp @@ -703,6 +721,24 @@ $(srcdir)/outputs/predicate-1.txt: $(srcdir)/examples/predicate-1.stamp fi +$(srcdir)/examples/transformed_image.stamp: examples/transformed_image.cc + @rm -f $@.tmp + @touch $@.tmp + $(MAKE) $(AM_MAKEFLAGS) transformed_image$(EXEEXT) + ./transformed_image$(EXEEXT) >$(srcdir)/outputs/transformed_image.txt.tmp + mv $(srcdir)/outputs/transformed_image.txt.tmp $(srcdir)/outputs/transformed_image.txt + @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/examples/transformed_image.stamp +MAINTAINERCLEANFILES += $(srcdir)/examples/transformed_image.stamp + +$(srcdir)/outputs/transformed_image.txt: $(srcdir)/examples/transformed_image.stamp +## Recover from the removal of $@ + @if test -f $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + + $(srcdir)/examples/tuto2_first_image.stamp: examples/tuto2_first_image.cc @rm -f $@.tmp @touch $@.tmp diff --git a/milena/doc/examples.dox b/milena/doc/examples.dox index ab18c38..1acb132 100644 --- a/milena/doc/examples.dox +++ b/milena/doc/examples.dox @@ -8,7 +8,12 @@ \li \link demos/inter_pixel/inter_pixel.cc Inter-pixel processings \endlink +\section examplesmorpher Image Morphers +\li \link doc/examples/transformed_image.cc Image domain translation. \endlink +\li \link doc/examples/extended_image.cc Image domain extension/shrinking. \endlink + \section examplesgraph Graphs \li \link demos/graph/region_adjacency_graph.cc Region Adjacency Graph \endlink + */ diff --git a/milena/doc/examples.mk b/milena/doc/examples.mk index c6542e4..12b9419 100644 --- a/milena/doc/examples.mk +++ b/milena/doc/examples.mk @@ -8,6 +8,7 @@ EXAMPLES = \ $(srcdir)/examples/dpoint-1.cc \ $(srcdir)/examples/estim-sites.cc \ $(srcdir)/examples/extend.cc \ + $(srcdir)/examples/extended_image.cc \ $(srcdir)/examples/extension-ignore.cc \ $(srcdir)/examples/fill-call-1.cc \ $(srcdir)/examples/fill-imageif-cfun.cc \ @@ -40,6 +41,7 @@ EXAMPLES = \ $(srcdir)/examples/paste.cc \ $(srcdir)/examples/point-1.cc \ $(srcdir)/examples/predicate-1.cc \ + $(srcdir)/examples/transformed_image.cc \ $(srcdir)/examples/trash/accu.cc \ $(srcdir)/examples/trash/box.cc \ $(srcdir)/examples/trash/cpp_issue.cc \ diff --git a/milena/doc/examples/extended_image.cc b/milena/doc/examples/extended_image.cc new file mode 100644 index 0000000..ed089f9 --- /dev/null +++ b/milena/doc/examples/extended_image.cc @@ -0,0 +1,51 @@ +#include <mln/core/image/image2d.hh> +#include <mln/core/image/dmorph/extended.hh> +#include <mln/fun/p2p/translation.hh> + +int main() +{ + using namespace mln; + +//! [Input initialization] + /* + (-3,-3)--------. + | | + |(0,0)----. | + | | |---------> Effective domain + | .-----(3,3) + | |----> Image border (3 pixels, by default) + .----------(6,6) + */ + typedef mln::image2d<bool> I; + I ima(4, 4); +//! [Input initialization] + +//! [Shrink image domain] + mln::box2d b_shrink = ima.domain().to_smaller(1); + /* + (-3,-3)--------. + | | + |(1,1)----. | + | | |---------> Effective domain + | .-----(2,2) + | |----> Image border (4 pixels) + .----------(6,6) + */ + mln::extended ima_shrink = mln::extended_to(ima, b_shrink); +//! [Shrink image domain] + +//! [Extend image domain] + mln::box2d b_extend = ima.domain().to_larger(1); + /* + (-3,-3)--------. + | | + (-1,-1)---. | + | | |---------> Effective domain + | .-----(4,4) + | |----> Image border (2 pixels) + .----------(6,6) + */ + mln::extended ima_extend = mln::extended_to(ima, b_extend); +//! [Extend image domain] + +} diff --git a/milena/doc/examples/transformed_image.cc b/milena/doc/examples/transformed_image.cc new file mode 100644 index 0000000..f4302d3 --- /dev/null +++ b/milena/doc/examples/transformed_image.cc @@ -0,0 +1,31 @@ +#include <mln/core/image/image2d.hh> +#include <mln/core/image/dmorph/transformed_image.hh> +#include <mln/fun/p2p/translation.hh> + +int main() +{ + using namespace mln; + +//! [Translate image domain] + /* + (0,0)----. + | | + .-----(2,2) + */ + typedef mln::image2d<bool> I; + I ima(3, 3); + + // Translation delta-point of row+2 and col-1. + mln::dpoint2d translate_dp(+2, -1); + typedef mln::fun::p2p::translation_t<point2d> F; + F translate_fun(translate_dp); + + /* + (2,-1)---. + | | + .-----(4,1) + */ + mln::transformed_image<I,F> + ext_ima = mln::transform_domain(ima, translate_fun); +//! [Translate image domain] +} diff --git a/milena/doc/outputs.mk b/milena/doc/outputs.mk index 383f95a..40fa6c3 100644 --- a/milena/doc/outputs.mk +++ b/milena/doc/outputs.mk @@ -8,6 +8,7 @@ OUTPUTS = \ $(srcdir)/outputs/dpoint-1.txt \ $(srcdir)/outputs/estim-sites.txt \ $(srcdir)/outputs/extend.txt \ + $(srcdir)/outputs/extended_image.txt \ $(srcdir)/outputs/extension-ignore.txt \ $(srcdir)/outputs/fill-call-1.txt \ $(srcdir)/outputs/fill-imageif-cfun.txt \ @@ -40,6 +41,7 @@ OUTPUTS = \ $(srcdir)/outputs/paste.txt \ $(srcdir)/outputs/point-1.txt \ $(srcdir)/outputs/predicate-1.txt \ + $(srcdir)/outputs/transformed_image.txt \ $(srcdir)/outputs/tuto2_first_image.txt \ $(srcdir)/outputs/tuto3_colorize.txt \ $(srcdir)/outputs/tuto3_first_routine.txt \ diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/milena/doc/outputs/extended_image.txt similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to milena/doc/outputs/extended_image.txt diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/milena/doc/outputs/transformed_image.txt similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to milena/doc/outputs/transformed_image.txt diff --git a/milena/doc/programs-examples.mk b/milena/doc/programs-examples.mk index 6a81b02..42610c4 100644 --- a/milena/doc/programs-examples.mk +++ b/milena/doc/programs-examples.mk @@ -1,6 +1,7 @@ ## Program as examples, generating images & outputs. -*- Makefile-Automake -*- -## Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE). +## Copyright (C) 2010, 2013 EPITA Research and Development Laboratory +## (LRDE). ## ## This file is part of Olena. ## @@ -32,6 +33,7 @@ PROGRAMS_examples = \ dpoint-1 \ estim-sites \ extend \ + extended_image \ extension-ignore \ fill \ fill-call-1 \ @@ -64,6 +66,7 @@ PROGRAMS_examples = \ paste-call-1 \ point-1 \ predicate-1 \ + transformed_image \ win-create-1 \ win-create-2 @@ -96,6 +99,7 @@ domain_display_SOURCES = examples/domain-display.cc dpoint_1_SOURCES = examples/dpoint-1.cc estim_sites_SOURCES = examples/estim-sites.cc extend_SOURCES = examples/extend.cc +extended_image_SOURCES = examples/extended_image.cc extension_ignore_SOURCES = examples/extension-ignore.cc fill_SOURCES = examples/fill.cc fill_call_1_SOURCES = examples/fill-call-1.cc @@ -128,6 +132,7 @@ paste_SOURCES = examples/paste.cc paste_call_1_SOURCES = examples/paste-call-1.cc point_1_SOURCES = examples/point-1.cc predicate_1_SOURCES = examples/predicate-1.cc +transformed_image_SOURCES = examples/transformed_image.cc win_create_1_SOURCES = examples/win-create-1.cc win_create_2_SOURCES = examples/win-create-2.cc diff --git a/milena/mln/core/image/dmorph/extended.hh b/milena/mln/core/image/dmorph/extended.hh index 0864b10..00d7823 100644 --- a/milena/mln/core/image/dmorph/extended.hh +++ b/milena/mln/core/image/dmorph/extended.hh @@ -86,11 +86,28 @@ namespace mln } // end of namespace mln::trait + /*! \brief An image of which domain is extended/shrunk. - /// Makes an image become restricted by a point set. - /// - /// \ingroup modimagedomainmorpher - // + This morpher can be used to alter the current domain of an image + by extending or shrinking the existing domain. + + \warning Altering the domain may require that values are available + for every sites. While extending outside the original domain, this + routine relies on the image border. Therefore, be sure it is large + enough to handle the new domain. + + Input used in the following example: + \snippet extended_image.cc Input initialization + + Example on how to extend the domain: + \snippet extended_image.cc Extend image domain + + Example on how to shrink the domain: + \snippet extended_image.cc Extend image domain + + \sa extended_to mln::extend mln::extension_ima mln::extension_fun mln::extension_val + \ingroup modimagedomainmorpher + */ template <typename I> struct extended : public internal::image_domain_morpher< I, box<mln_site(I)>, @@ -126,10 +143,26 @@ namespace mln /// \endcond + /*! + \brief Creates an extended image. + + This routine is provided for convenience and can be considered as + a "factory" of mln::extended image. + + \relates mln::extended + */ template <typename I, typename B> extended<const I> extended_to(const Image& ima, const Box& b); + /*! + \brief Creates an extended image. + + This routine is provided for convenience and can be considered as + a "factory" of mln::extended images. + + \relates mln::extended + */ template <typename I, typename B> extended extended_to(Image& ima, const Box& b); diff --git a/milena/mln/core/image/dmorph/transformed_image.hh b/milena/mln/core/image/dmorph/transformed_image.hh index d2bee12..95ec6bc 100644 --- a/milena/mln/core/image/dmorph/transformed_image.hh +++ b/milena/mln/core/image/dmorph/transformed_image.hh @@ -89,11 +89,20 @@ namespace mln } // end of namespace mln::trait + /*! \brief An image of which domain is transformed by a function. - /// Image having its domain restricted by a site set. - /// - /// \ingroup modimagedomainmorpher - // + This morpher can be used to modify the image domain through a + function. + + This morpher expects the actual transformation for construction + but uses internally the inverted transformation. + + Example (\link transformed_image.cc \endlink): + \snippet transformed_image.cc Translate image domain + + \sa mln::transform_domain fun::p2p::translation_t fun::p2p::mirror fun::p2p::fold + \ingroup modimagedomainmorpher + */ template <typename I, typename F> struct transformed_image : public internal::image_domain_morpher< I, p_transformed< mln_domain(I), F>, @@ -134,10 +143,26 @@ namespace mln // Morpher creation. + /*! + \brief Creates a transformed image. + + This routine is provided for convenience and can be considered as + a "factory" of mln::transformed_image images. + + \relates transformed_image + */ template <typename I, typename F> transformed_image<const I, F> transform_domain(const Image& ima, const Function_v2v<F>& f); + /*! + \brief Creates a transformed image. + + This routine is provided for convenience and can be considered as + a "factory" of mln::transformed_image images. + + \relates transformed_image + */ template <typename I, typename F> transformed_image<I, F> transform_domain(Image& ima, const Function_v2v<F>& f); diff --git a/milena/mln/fun/p2p/fold.hh b/milena/mln/fun/p2p/fold.hh index 5f0e4f4..814c4d2 100644 --- a/milena/mln/fun/p2p/fold.hh +++ b/milena/mln/fun/p2p/fold.hh @@ -47,7 +47,7 @@ namespace mln /*! \brief Fold a domain into one direction. - \sa data::transform + \sa data::transform mln::transformed_image \ingroup funv2v */ template < typename P, diff --git a/milena/mln/fun/p2p/mirror.hh b/milena/mln/fun/p2p/mirror.hh index 7f307dc..2c6bfe9 100644 --- a/milena/mln/fun/p2p/mirror.hh +++ b/milena/mln/fun/p2p/mirror.hh @@ -63,7 +63,7 @@ namespace mln // p == (0, 1); \endcode - \sa data::transform + \sa data::transform mln::transformed_image \ingroup funv2v */ template <typename B> diff --git a/milena/mln/fun/p2p/translation.hh b/milena/mln/fun/p2p/translation.hh index c122cfd..69ef48b 100644 --- a/milena/mln/fun/p2p/translation.hh +++ b/milena/mln/fun/p2p/translation.hh @@ -49,7 +49,7 @@ namespace mln \brief Computes the translation of a given point w.r.t a translation vector. - \sa data::transform + \sa data::transform mln::transformed_image \ingroup funv2v */ template <typename P> @@ -68,6 +68,12 @@ namespace mln }; + /*! + \brief Creates a translation function. + + \relates mln::fun::p2p::translation_t + \ingroup funv2v + */ template <typename D> translation_t<mln_site(D)> translation(const Gdpoint<D>& dp); -- 1.7.2.5

1 0