- Olena-patches

olena: olena-2.0-558-g17edd9c mln/convert/impl/from_value_to_value.hh: Improve from_value_to_value dispatch for types with identical equiv type.
by Guillaume Lazzara 26 Apr '13

26 Apr '13

--- milena/ChangeLog | 5 ++ milena/mln/convert/impl/from_value_to_value.hh | 62 ++++++++++++++---------- 2 files changed, 41 insertions(+), 26 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 4b4c4a9..41ca209 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,8 @@ +2013-04-26 Guillaume Lazzara <z(a)lrde.epita.fr> + + * mln/convert/impl/from_value_to_value.hh: Improve + from_value_to_value dispatch for types with identical equiv type. + 2013-04-24 Guillaume Lazzara <z(a)lrde.epita.fr> Handle 16 bits value types with io::magick. diff --git a/milena/mln/convert/impl/from_value_to_value.hh b/milena/mln/convert/impl/from_value_to_value.hh index 9c93e5a..8d1afc9 100644 --- a/milena/mln/convert/impl/from_value_to_value.hh +++ b/milena/mln/convert/impl/from_value_to_value.hh @@ -65,38 +65,48 @@ namespace mln # ifndef MLN_INCLUDE_ONLY - // We want to disable this code since it prevents types of - // different quantification to rely on from_to_ overload and - // handle specific conversions. (ex: rgb16 towards rgb8) - - // // Case 1: - - // template <typename V, typename W> - // void - // from_value_to_value_(const mln::value::Vectorial<V>& from, - // mln::value::Vectorial<W>& to) - // { - // exact(to) = exact(from).to_equiv(); - // } - - // // Case 2: - - // template <typename V, typename W> - // void - // from_value_to_value_(const mln::value::Scalar<V>& from, - // mln::value::Scalar<W>& to) - // { - // exact(to) = exact(from).to_equiv(); - // } + // Case 1: Same equiv type. + + template <typename V, typename W, typename EV> + void + from_value_to_value_(const mln::value::Vectorial<V>& from, + mln::value::Vectorial<W>& to, + const EV&, const EV&) + { + exact(to) = exact(from).to_equiv(); + } + + template <typename V, typename W, typename EV> + void + from_value_to_value_(const mln::value::Scalar<V>& from, + mln::value::Scalar<W>& to, + const EV&, const EV&) + { + exact(to) = exact(from).to_equiv(); + } + + // Case 2: Different equiv type. No concept based + // conversions. Trying to find more specific conversions with + // other from_to_ overloads. + template <typename V, typename W, typename EV1, typename EV2> + inline + void + from_value_to_value_(const Value<V>& from, Value<W>& to, + const EV1&, const EV2&) + { + from_to_(exact(from), exact(to)); + } + template <typename V, typename W> inline void from_value_to_value_(const Value<V>& from, Value<W>& to) { - // No concept based conversion. Trying to find more specific - // conversion with other from_to overloads. - from_to_(exact(from), exact(to)); + /// Checking if V and W have the same equivalent type. + typedef mln_equiv(V) V_equiv; + typedef mln_equiv(W) W_equiv; + from_value_to_value_(exact(from), exact(to), V_equiv(), W_equiv()); } -- 1.7.2.5

1 0

olena: olena-2.0-555-gb60f594 mln/convert/impl/from_value_to_value.hh: Improve from_value_to_value dispatch for types with identical equiv type.
by Guillaume Lazzara 26 Apr '13

26 Apr '13

--- milena/ChangeLog | 5 ++ milena/mln/convert/impl/from_value_to_value.hh | 62 ++++++++++++++---------- 2 files changed, 41 insertions(+), 26 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 4b4c4a9..41ca209 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,8 @@ +2013-04-26 Guillaume Lazzara <z(a)lrde.epita.fr> + + * mln/convert/impl/from_value_to_value.hh: Improve + from_value_to_value dispatch for types with identical equiv type. + 2013-04-24 Guillaume Lazzara <z(a)lrde.epita.fr> Handle 16 bits value types with io::magick. diff --git a/milena/mln/convert/impl/from_value_to_value.hh b/milena/mln/convert/impl/from_value_to_value.hh index 9c93e5a..8d1afc9 100644 --- a/milena/mln/convert/impl/from_value_to_value.hh +++ b/milena/mln/convert/impl/from_value_to_value.hh @@ -65,38 +65,48 @@ namespace mln # ifndef MLN_INCLUDE_ONLY - // We want to disable this code since it prevents types of - // different quantification to rely on from_to_ overload and - // handle specific conversions. (ex: rgb16 towards rgb8) - - // // Case 1: - - // template <typename V, typename W> - // void - // from_value_to_value_(const mln::value::Vectorial<V>& from, - // mln::value::Vectorial<W>& to) - // { - // exact(to) = exact(from).to_equiv(); - // } - - // // Case 2: - - // template <typename V, typename W> - // void - // from_value_to_value_(const mln::value::Scalar<V>& from, - // mln::value::Scalar<W>& to) - // { - // exact(to) = exact(from).to_equiv(); - // } + // Case 1: Same equiv type. + + template <typename V, typename W, typename EV> + void + from_value_to_value_(const mln::value::Vectorial<V>& from, + mln::value::Vectorial<W>& to, + const EV&, const EV&) + { + exact(to) = exact(from).to_equiv(); + } + + template <typename V, typename W, typename EV> + void + from_value_to_value_(const mln::value::Scalar<V>& from, + mln::value::Scalar<W>& to, + const EV&, const EV&) + { + exact(to) = exact(from).to_equiv(); + } + + // Case 2: Different equiv type. No concept based + // conversions. Trying to find more specific conversions with + // other from_to_ overloads. + template <typename V, typename W, typename EV1, typename EV2> + inline + void + from_value_to_value_(const Value<V>& from, Value<W>& to, + const EV1&, const EV2&) + { + from_to_(exact(from), exact(to)); + } + template <typename V, typename W> inline void from_value_to_value_(const Value<V>& from, Value<W>& to) { - // No concept based conversion. Trying to find more specific - // conversion with other from_to overloads. - from_to_(exact(from), exact(to)); + /// Checking if V and W have the same equivalent type. + typedef mln_equiv(V) V_equiv; + typedef mln_equiv(W) W_equiv; + from_value_to_value_(exact(from), exact(to), V_equiv(), W_equiv()); } -- 1.7.2.5

1 0

olena: branch exp/newdoc updated: olena-2.0-577-g237e7b8
by git＠lrde.epita.fr 26 Apr '13

26 Apr '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 237e7b8998aae98e107f9cd47d70ccb6f00d2326 (commit) from 5cb37e9a4f3ba10c7345fbffe835a2dbaa5c65ca (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 ----------------------------------------------------------------- 237e7b8 doc/Doxyfile.in: Disable QHP generation. ----------------------------------------------------------------------- Summary of changes: scribo/ChangeLog | 4 ++++ scribo/doc/Doxyfile.in | 2 +- 2 files changed, 5 insertions(+), 1 deletions(-) hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena: olena-2.0-577-g237e7b8 doc/Doxyfile.in: Disable QHP generation.
by Guillaume Lazzara 26 Apr '13

26 Apr '13

--- scribo/ChangeLog | 4 ++++ scribo/doc/Doxyfile.in | 2 +- 2 files changed, 5 insertions(+), 1 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index a3d6325..86b7802 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,3 +1,7 @@ +2013-04-26 Guillaume Lazzara <z(a)lrde.epita.fr> + + * doc/Doxyfile.in: Disable QHP generation. + 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> * src/text_in_picture.cc: Add more descriptions in usage. diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index 904121c..2214874 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -373,7 +373,7 @@ DOT_CLEANUP = YES #--------------------------------------------------------------------------- SEARCHENGINE = YES -GENERATE_QHP = yes +GENERATE_QHP = no QHP_NAMESPACE = "fr.epita.lrde.olena.scribo" QHP_VIRTUAL_FOLDER = "scribo-2.0" QCH_FILE = "@builddir@/scribo.qch" -- 1.7.2.5

1 0

olena: branch exp/newdoc updated: olena-2.0-576-g5cb37e9
by git＠lrde.epita.fr 25 Apr '13

25 Apr '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 5cb37e9a4f3ba10c7345fbffe835a2dbaa5c65ca (commit) from 8113851467f0e6512b9c17f11f0c30d409a63c3f (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 ----------------------------------------------------------------- 5cb37e9 doc/mln/topo/topo.dox: New. Introduce mathematical topology module. ----------------------------------------------------------------------- Summary of changes: milena/ChangeLog | 5 +++++ milena/doc/mln/topo/topo.dox | 6 ++++++ 2 files changed, 11 insertions(+), 0 deletions(-) create mode 100644 milena/doc/mln/topo/topo.dox hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena: olena-2.0-576-g5cb37e9 doc/mln/topo/topo.dox: New. Introduce mathematical topology module.
by Guillaume Lazzara 25 Apr '13

25 Apr '13

--- milena/ChangeLog | 5 +++++ milena/doc/mln/topo/topo.dox | 6 ++++++ 2 files changed, 11 insertions(+), 0 deletions(-) create mode 100644 milena/doc/mln/topo/topo.dox diff --git a/milena/ChangeLog b/milena/ChangeLog index 989e483..49afff7 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,10 @@ 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/mln/topo/topo.dox: New. Introduce mathematical topology + module. + +2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + Add more "See also" statement in function documentation. * mln/fun/v2b/always_false.hh, diff --git a/milena/doc/mln/topo/topo.dox b/milena/doc/mln/topo/topo.dox new file mode 100644 index 0000000..85179cb --- /dev/null +++ b/milena/doc/mln/topo/topo.dox @@ -0,0 +1,6 @@ +/*! \defgroup mlntopo Mathematical Topology + * + * \brief Algorithms dedicated to Mathematical Topology. + * + * \ingroup modroutines + */ -- 1.7.2.5

1 0

olena: branch exp/newdoc updated: olena-2.0-575-g8113851
by git＠lrde.epita.fr 25 Apr '13

25 Apr '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 8113851467f0e6512b9c17f11f0c30d409a63c3f (commit) via feca97c579cabd8c220b49e9ad76db4abdfee5d5 (commit) via 8a63cd516c9d9cce4a7e2ce5a2ee0e7da4227312 (commit) via 61b6d4e0189709d6bce5eb2f4b9de63364a3af45 (commit) from 1712786ce30c5b090ec7791afa60895afd55d3cf (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 ----------------------------------------------------------------- 8113851 Cite papers in documentation. feca97c doc/doc.bib: Add more references. 8a63cd5 Add more "See also" statement in function documentation. 61b6d4e mln/make/relabelfun.hh: Fix bad variable replacement. ----------------------------------------------------------------------- Summary of changes: ChangeLog | 11 ++++ doc/doc.bib | 30 +++++++++-- milena/ChangeLog | 55 +++++++++++++++++++ milena/mln/fun/v2b/always_false.hh | 7 ++- milena/mln/fun/v2b/always_true.hh | 7 ++- milena/mln/fun/v2b/lnot.hh | 10 +++- milena/mln/fun/v2b/threshold_ge.hh | 14 ++++- milena/mln/fun/v2b/threshold_le.hh | 14 ++++- milena/mln/fun/v2v/abs.hh | 1 + milena/mln/fun/v2v/all_to.hh | 1 + milena/mln/fun/v2v/array.hh | 1 + milena/mln/fun/v2v/cast.hh | 1 + milena/mln/fun/v2v/ch_function_value.hh | 1 + milena/mln/fun/v2v/component.hh | 1 + milena/mln/fun/v2v/convert.hh | 4 +- milena/mln/fun/v2v/dec.hh | 2 + milena/mln/fun/v2v/enc.hh | 1 + milena/mln/fun/v2v/hsl_to_rgb.hh | 12 +++- milena/mln/fun/v2v/id.hh | 1 + milena/mln/fun/v2v/inc.hh | 2 + milena/mln/fun/v2v/index_of_value.hh | 1 + milena/mln/fun/v2v/linear.hh | 1 + milena/mln/fun/v2v/mahalanobis.hh | 7 ++- milena/mln/fun/v2v/norm.hh | 6 +- milena/mln/fun/v2v/projection.hh | 1 + milena/mln/fun/v2v/qt_rgb_to_int_u.hh | 3 + milena/mln/fun/v2v/rgb8_to_rgbn.hh | 6 ++- milena/mln/fun/v2v/rgb_to_hsl.hh | 3 + milena/mln/fun/v2v/rgb_to_int_u.hh | 3 + milena/mln/fun/v2v/rgb_to_luma.hh | 3 + milena/mln/fun/v2v/round.hh | 2 + milena/mln/fun/v2v/round_sat.hh | 1 + milena/mln/fun/v2v/saturate.hh | 1 + milena/mln/fun/v2v/value_at_index.hh | 1 + milena/mln/fun/v2v/wrap.hh | 1 + milena/mln/fun/vv2b/eq.hh | 2 + milena/mln/fun/vv2b/ge.hh | 1 + milena/mln/fun/vv2b/gt.hh | 2 + milena/mln/fun/vv2b/implies.hh | 2 + milena/mln/fun/vv2b/le.hh | 1 + milena/mln/fun/vv2b/lt.hh | 1 + milena/mln/fun/vv2v/diff_abs.hh | 10 +++- milena/mln/fun/vv2v/land.hh | 10 +++- milena/mln/fun/vv2v/land_not.hh | 10 +++- milena/mln/fun/vv2v/lor.hh | 10 +++- milena/mln/fun/vv2v/lxor.hh | 10 +++- milena/mln/fun/vv2v/max.hh | 10 +++- milena/mln/fun/vv2v/min.hh | 10 +++- milena/mln/fun/vv2v/vec.hh | 10 +++- milena/mln/linear/log.hh | 4 +- milena/mln/make/relabelfun.hh | 2 +- milena/mln/topo/skeleton/crest.hh | 91 ++++++++++++++++--------------- 52 files changed, 312 insertions(+), 90 deletions(-) hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena: olena-2.0-575-g8113851 Cite papers in documentation.
by Guillaume Lazzara 25 Apr '13

25 Apr '13

* mln/linear/log.hh, * mln/topo/skeleton/crest.hh: Here. --- ChangeLog | 7 +++ milena/mln/linear/log.hh | 4 +- milena/mln/topo/skeleton/crest.hh | 91 +++++++++++++++++++------------------ 3 files changed, 56 insertions(+), 46 deletions(-) diff --git a/ChangeLog b/ChangeLog index 5d8e4c0..15e019f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,12 @@ 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + Cite papers in documentation. + + * mln/linear/log.hh, + * mln/topo/skeleton/crest.hh: Here. + +2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/doc.bib: Add more references. 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/milena/mln/linear/log.hh b/milena/mln/linear/log.hh index 865f571..824cf94 100644 --- a/milena/mln/linear/log.hh +++ b/milena/mln/linear/log.hh @@ -46,7 +46,7 @@ namespace mln /*! \brief Laplacian of Gaussian. - LoG_5x5 (Cf. Sonka et al., pages 85-86). + LoG_5x5 (Cf. Sonka et al., pages 85-86, \cite sonka1999image). This is also a "mexican hat". \ingroup mlnlinear @@ -77,7 +77,7 @@ namespace mln /*! \brief Laplacian of Gaussian. - LoG 17x17 (Cf. Sonka et al., pages 85-86). + LoG 17x17 (Cf. Sonka et al., pages 85-86, \cite sonka1999image). \ingroup mlnlinear */ diff --git a/milena/mln/topo/skeleton/crest.hh b/milena/mln/topo/skeleton/crest.hh index 351ec66..863bc77 100644 --- a/milena/mln/topo/skeleton/crest.hh +++ b/milena/mln/topo/skeleton/crest.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2009, 2010, 2011 EPITA Research and Development +// Copyright (C) 2009, 2010, 2011, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -48,54 +48,57 @@ namespace mln { - /// Compute skeletization constraints. - /// - /// \param[in] input A binary image. - /// \param[in] dist_map A distance map of \p input. Contains the - /// inner object distance map. - /// \param[in] nbh A neighborhood. - /// \param[in] psi_threshold Keep sites having a Point - /// Superiority Index greated or equal - /// to \p psi_threshold. - /// - /// \result A binary image. - // - /*! - * - * This implementation is based on the following article: - * K. W. Kang, J. W. Suh, and J. H. Kim. Skeletonization of grayscale - * character images using pixel superiority index. In Proc. 3rd IAPR - * Workshop on Document Analysis Systems, pages 326-335, Nagano, - * Japan, 1998. - * - * Abstract: - * "In this paper, we present pixel superiority index as a tool for - * designing a skeletonization algorithm which utilizes topographic - * features efficiently. We clarify a relationship between pixel - * superiority index and topographic features. Then, using the - * relationship, we transform a problem of skeletonization into a - * problem of skeleton growing. [...]" - * - * - * In Milena, the Pixel Superiority index is defined as follow: - * Let v = p.val(), the Pixel superiority index of p is the number of - * neighbor pixels having their value/level inferior or equal to - * p.val(). - * - * This algorithm keeps sites having their pixel superiority index - * greater than \p psi_threshold (6 by default). - * - * For good results with 2D images, we advice you to use c8() as - * neighborhood. - * - */ + /*! \brief Compute skeletization constraints. + + \param[in] input A binary image. + \param[in] dist_map A distance map of \p input. Contains the + inner object distance map. + \param[in] nbh A neighborhood. + \param[in] psi_threshold Keep sites having a Point + Superiority Index greated or equal + to \p psi_threshold. + + \result A binary image. + + + This implementation is based on the following paper: + K. W. Kang, J. W. Suh, and J. H. Kim. Skeletonization of grayscale + character images using pixel superiority index. In Proc. 3rd IAPR + Workshop on Document Analysis Systems, pages 326-335, Nagano, + Japan, 1998. (\cite kang1998iapr) + + Abstract: + "In this paper, we present pixel superiority index as a tool for + designing a skeletonization algorithm which utilizes topographic + features efficiently. We clarify a relationship between pixel + superiority index and topographic features. Then, using the + relationship, we transform a problem of skeletonization into a + problem of skeleton growing. [...]" + + + In Milena, the Pixel Superiority index is defined as follow: + Let v = p.val(), the Pixel superiority index of p is the number of + neighbor pixels having their value/level inferior or equal to + p.val(). + + This algorithm keeps sites having their pixel superiority index + greater than \p psi_threshold (6 by default). + + For good results with 2D images, we advice you to use c8() as + neighborhood. + + \ingroup modtopo + */ template <typename I, typename D, typename N> mln_concrete(I) crest(const Image<I>& input, const Image<D>& dist_map, const Neighborhood<N>& nbh, unsigned psi_threshold); - /// \overload - /// psi_threshold is set to 6. + /*! \overload + psi_threshold is set to 6. + + \ingroup modtopo + */ template <typename I, typename D, typename N> mln_concrete(I) crest(const Image<I>& input, const Image<D>& dist_map, -- 1.7.2.5

1 0

olena: olena-2.0-574-gfeca97c doc/doc.bib: Add more references.
by Guillaume Lazzara 25 Apr '13

25 Apr '13

--- ChangeLog | 4 ++++ doc/doc.bib | 30 ++++++++++++++++++++++++++---- 2 files changed, 30 insertions(+), 4 deletions(-) diff --git a/ChangeLog b/ChangeLog index fe46772..5d8e4c0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/doc.bib: Add more references. + +2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + * configure.ac: Do not configure milena/tests/fun/i2v and milena/tests/fun/stat. diff --git a/doc/doc.bib b/doc/doc.bib index 2c04307..705a1aa 100644 --- a/doc/doc.bib +++ b/doc/doc.bib @@ -29,7 +29,7 @@ } @article{shafait2008drr, - author = {Faisal Shafait and Daniel Keysers and Thomas M. Breuel}, + author = {F. Shafait and D. Keysers and T. M. Breuel}, title = {Efficient Implementation of Local Adaptive Thresholding Techniques Using Integral Images}, journal = {Document Recognition and Retrieval XV}, year = {2008}, @@ -48,7 +48,7 @@ @article{nagy1992computer, title={A prototype document image analysis system for technical journals}, - author={George Nagy and Sharad Seth and Mahesh Viswanathan}, + author={G. Nagy and S. Seth and M. Viswanathan}, journal={Computer}, volume={25}, number={7}, @@ -59,7 +59,7 @@ @inproceedings{kruatrachue2005waset, title={Fast Document Segmentation Using Contour and {XY-Cut} Technique}, - author={Boontee Kruatrachue and Narongchai Moongfangklang and Kritawan Siriboon}, + author={B. Kruatrachue and N. Moongfangklang and K. Siriboon}, booktitle={Proceedings of World Academy of Science, Engineering and Technology}, volume={5}, pages={27--29}, @@ -68,9 +68,31 @@ @inproceedings{fabrizio2009icip, title={Text segmentation in natural scenes using toggle-mapping}, - author={Jonathan Fabrizio and Beatriz Marcotegui and Matthieu Cord}, + author={J. Fabrizio and B. Marcotegui and M. Cord}, booktitle={IEEE International Conference on Image Processing}, pages={2373--2376}, year={2009}, organization={IEEE} +} + +@book{agoston2005cggmm, + title={Computer graphics and geometric modeling: mathematics}, + author={M. K. Agoston}, + volume={2}, + year={2005}, + publisher={Springer} +} + +@inproceedings{kang1998iapr, + title={Skeletonization of grayscale character images using pixel superiority index}, + author={K.-W. Kang and J. W. Suh and J. H. Kim}, + booktitle={IAPR Workshop on Document Analysis Systems}, + year={1998} +} + +@book{sonka1999image, + title={Image processing, analysis, and machine vision}, + author={M. Sonka and V. Hlavac and R. Boyle and others}, + year={1999}, + publisher={PWS Pub. Pacific Grove} } \ No newline at end of file -- 1.7.2.5

1 0

olena: olena-2.0-573-g8a63cd5 Add more "See also" statement in function documentation.
by Guillaume Lazzara 25 Apr '13

25 Apr '13

* mln/fun/v2b/always_false.hh, * mln/fun/v2b/always_true.hh, * mln/fun/v2b/lnot.hh, * mln/fun/v2b/threshold_ge.hh, * mln/fun/v2b/threshold_le.hh, * mln/fun/v2v/abs.hh, * mln/fun/v2v/all_to.hh, * mln/fun/v2v/array.hh, * mln/fun/v2v/cast.hh, * mln/fun/v2v/ch_function_value.hh, * mln/fun/v2v/component.hh, * mln/fun/v2v/convert.hh, * mln/fun/v2v/dec.hh, * mln/fun/v2v/enc.hh, * mln/fun/v2v/hsl_to_rgb.hh, * mln/fun/v2v/id.hh, * mln/fun/v2v/inc.hh, * mln/fun/v2v/index_of_value.hh, * mln/fun/v2v/linear.hh, * mln/fun/v2v/mahalanobis.hh, * mln/fun/v2v/norm.hh, * mln/fun/v2v/projection.hh, * mln/fun/v2v/qt_rgb_to_int_u.hh, * mln/fun/v2v/rgb8_to_rgbn.hh, * mln/fun/v2v/rgb_to_hsl.hh, * mln/fun/v2v/rgb_to_int_u.hh, * mln/fun/v2v/rgb_to_luma.hh, * mln/fun/v2v/round.hh, * mln/fun/v2v/round_sat.hh, * mln/fun/v2v/saturate.hh, * mln/fun/v2v/value_at_index.hh, * mln/fun/v2v/wrap.hh, * mln/fun/vv2b/eq.hh, * mln/fun/vv2b/ge.hh, * mln/fun/vv2b/gt.hh, * mln/fun/vv2b/implies.hh, * mln/fun/vv2b/le.hh, * mln/fun/vv2b/lt.hh, * mln/fun/vv2v/diff_abs.hh, * mln/fun/vv2v/land.hh, * mln/fun/vv2v/land_not.hh, * mln/fun/vv2v/lor.hh, * mln/fun/vv2v/lxor.hh, * mln/fun/vv2v/max.hh, * mln/fun/vv2v/min.hh, * mln/fun/vv2v/vec.hh: Here. --- milena/ChangeLog | 51 +++++++++++++++++++++++++++++++ milena/mln/fun/v2b/always_false.hh | 7 ++++- milena/mln/fun/v2b/always_true.hh | 7 ++++- milena/mln/fun/v2b/lnot.hh | 10 +++++- milena/mln/fun/v2b/threshold_ge.hh | 14 +++++++-- milena/mln/fun/v2b/threshold_le.hh | 14 +++++++-- milena/mln/fun/v2v/abs.hh | 1 + milena/mln/fun/v2v/all_to.hh | 1 + milena/mln/fun/v2v/array.hh | 1 + milena/mln/fun/v2v/cast.hh | 1 + milena/mln/fun/v2v/ch_function_value.hh | 1 + milena/mln/fun/v2v/component.hh | 1 + milena/mln/fun/v2v/convert.hh | 4 ++- milena/mln/fun/v2v/dec.hh | 2 + milena/mln/fun/v2v/enc.hh | 1 + milena/mln/fun/v2v/hsl_to_rgb.hh | 12 +++++-- milena/mln/fun/v2v/id.hh | 1 + milena/mln/fun/v2v/inc.hh | 2 + milena/mln/fun/v2v/index_of_value.hh | 1 + milena/mln/fun/v2v/linear.hh | 1 + milena/mln/fun/v2v/mahalanobis.hh | 7 ++++- milena/mln/fun/v2v/norm.hh | 6 ++-- milena/mln/fun/v2v/projection.hh | 1 + milena/mln/fun/v2v/qt_rgb_to_int_u.hh | 3 ++ milena/mln/fun/v2v/rgb8_to_rgbn.hh | 6 +++- milena/mln/fun/v2v/rgb_to_hsl.hh | 3 ++ milena/mln/fun/v2v/rgb_to_int_u.hh | 3 ++ milena/mln/fun/v2v/rgb_to_luma.hh | 3 ++ milena/mln/fun/v2v/round.hh | 2 + milena/mln/fun/v2v/round_sat.hh | 1 + milena/mln/fun/v2v/saturate.hh | 1 + milena/mln/fun/v2v/value_at_index.hh | 1 + milena/mln/fun/v2v/wrap.hh | 1 + milena/mln/fun/vv2b/eq.hh | 2 + milena/mln/fun/vv2b/ge.hh | 1 + milena/mln/fun/vv2b/gt.hh | 2 + milena/mln/fun/vv2b/implies.hh | 2 + milena/mln/fun/vv2b/le.hh | 1 + milena/mln/fun/vv2b/lt.hh | 1 + milena/mln/fun/vv2v/diff_abs.hh | 10 ++++-- milena/mln/fun/vv2v/land.hh | 10 +++++- milena/mln/fun/vv2v/land_not.hh | 10 +++++- milena/mln/fun/vv2v/lor.hh | 10 +++++- milena/mln/fun/vv2v/lxor.hh | 10 +++++- milena/mln/fun/vv2v/max.hh | 10 ++++-- milena/mln/fun/vv2v/min.hh | 10 ++++-- milena/mln/fun/vv2v/vec.hh | 10 ++++-- 47 files changed, 221 insertions(+), 39 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 5310fbd..989e483 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,56 @@ 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + Add more "See also" statement in function documentation. + + * mln/fun/v2b/always_false.hh, + * mln/fun/v2b/always_true.hh, + * mln/fun/v2b/lnot.hh, + * mln/fun/v2b/threshold_ge.hh, + * mln/fun/v2b/threshold_le.hh, + * mln/fun/v2v/abs.hh, + * mln/fun/v2v/all_to.hh, + * mln/fun/v2v/array.hh, + * mln/fun/v2v/cast.hh, + * mln/fun/v2v/ch_function_value.hh, + * mln/fun/v2v/component.hh, + * mln/fun/v2v/convert.hh, + * mln/fun/v2v/dec.hh, + * mln/fun/v2v/enc.hh, + * mln/fun/v2v/hsl_to_rgb.hh, + * mln/fun/v2v/id.hh, + * mln/fun/v2v/inc.hh, + * mln/fun/v2v/index_of_value.hh, + * mln/fun/v2v/linear.hh, + * mln/fun/v2v/mahalanobis.hh, + * mln/fun/v2v/norm.hh, + * mln/fun/v2v/projection.hh, + * mln/fun/v2v/qt_rgb_to_int_u.hh, + * mln/fun/v2v/rgb8_to_rgbn.hh, + * mln/fun/v2v/rgb_to_hsl.hh, + * mln/fun/v2v/rgb_to_int_u.hh, + * mln/fun/v2v/rgb_to_luma.hh, + * mln/fun/v2v/round.hh, + * mln/fun/v2v/round_sat.hh, + * mln/fun/v2v/saturate.hh, + * mln/fun/v2v/value_at_index.hh, + * mln/fun/v2v/wrap.hh, + * mln/fun/vv2b/eq.hh, + * mln/fun/vv2b/ge.hh, + * mln/fun/vv2b/gt.hh, + * mln/fun/vv2b/implies.hh, + * mln/fun/vv2b/le.hh, + * mln/fun/vv2b/lt.hh, + * mln/fun/vv2v/diff_abs.hh, + * mln/fun/vv2v/land.hh, + * mln/fun/vv2v/land_not.hh, + * mln/fun/vv2v/lor.hh, + * mln/fun/vv2v/lxor.hh, + * mln/fun/vv2v/max.hh, + * mln/fun/vv2v/min.hh, + * mln/fun/vv2v/vec.hh: Here. + +2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/make/relabelfun.hh: Fix bad variable replacement. 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/milena/mln/fun/v2b/always_false.hh b/milena/mln/fun/v2b/always_false.hh index 96f843c..514d2c8 100755 --- a/milena/mln/fun/v2b/always_false.hh +++ b/milena/mln/fun/v2b/always_false.hh @@ -42,7 +42,12 @@ namespace mln namespace v2b { - /// Functor computing logical-not on a value. + /*! + \brief Functor computing logical-not on a value. + + \sa data::transform + \ingroup funv2b + */ template <typename V> struct always_false : public Function_v2b< always_false<V> > { diff --git a/milena/mln/fun/v2b/always_true.hh b/milena/mln/fun/v2b/always_true.hh index 4226422..6abd057 100755 --- a/milena/mln/fun/v2b/always_true.hh +++ b/milena/mln/fun/v2b/always_true.hh @@ -42,7 +42,12 @@ namespace mln namespace v2b { - /// Functor computing logical-not on a value. + /*! + \brief Functor computing logical-not on a value. + + \sa data::transform + \ingroup funv2b + */ template <typename V> struct always_true : public Function_v2b< always_true<V> > { diff --git a/milena/mln/fun/v2b/lnot.hh b/milena/mln/fun/v2b/lnot.hh index 73d9ecf..8c4bf0f 100644 --- a/milena/mln/fun/v2b/lnot.hh +++ b/milena/mln/fun/v2b/lnot.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. // @@ -42,7 +43,12 @@ namespace mln namespace v2b { - /// Functor computing logical-not on a value. + /*! + \brief Functor computing logical-not on a value. + + \sa data::transform + \ingroup funv2b + */ template <typename V> struct lnot : public Function_v2b< lnot<V> > { diff --git a/milena/mln/fun/v2b/threshold_ge.hh b/milena/mln/fun/v2b/threshold_ge.hh index c5fef9e..b8e11de 100644 --- a/milena/mln/fun/v2b/threshold_ge.hh +++ b/milena/mln/fun/v2b/threshold_ge.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -43,8 +43,16 @@ namespace mln namespace v2b { - /// Threshold function. - /// f(v) = (v >= threshold). + /*! + \brief Threshold function. + + \code + f(v) = (v >= threshold). + \endcode + + \sa data::transform + \ingroup funv2b + */ template <typename V> struct threshold_ge : public Function_v2b< threshold_ge<V> > { diff --git a/milena/mln/fun/v2b/threshold_le.hh b/milena/mln/fun/v2b/threshold_le.hh index 21964c8..c6b5061 100644 --- a/milena/mln/fun/v2b/threshold_le.hh +++ b/milena/mln/fun/v2b/threshold_le.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -43,8 +43,16 @@ namespace mln namespace v2b { - /// Threshold function. - /// f(v) = (v <= threshold). + /*! + \brief Threshold function. + + \code + f(v) = (v <= threshold). + \endcode + + \sa data::transform + \ingroup funv2b + */ template <typename V> struct threshold_le : public Function_v2b< threshold_le<V> > { diff --git a/milena/mln/fun/v2v/abs.hh b/milena/mln/fun/v2v/abs.hh index c0d3e84..2745b57 100644 --- a/milena/mln/fun/v2v/abs.hh +++ b/milena/mln/fun/v2v/abs.hh @@ -48,6 +48,7 @@ namespace mln /*! \brief Function returning absolute value. + \sa data::transform \ingroup funv2v */ template <typename V> diff --git a/milena/mln/fun/v2v/all_to.hh b/milena/mln/fun/v2v/all_to.hh index d9e7569..93bb737 100644 --- a/milena/mln/fun/v2v/all_to.hh +++ b/milena/mln/fun/v2v/all_to.hh @@ -45,6 +45,7 @@ namespace mln /*! \brief Function always returning the same value. + \sa data::transform \ingroup funv2v */ template <typename T> diff --git a/milena/mln/fun/v2v/array.hh b/milena/mln/fun/v2v/array.hh index 1707f4e..743afe4 100644 --- a/milena/mln/fun/v2v/array.hh +++ b/milena/mln/fun/v2v/array.hh @@ -64,6 +64,7 @@ namespace mln /*! \brief Function mapping an id to a value. + \sa data::transform \ingroup funv2v */ template <typename T> diff --git a/milena/mln/fun/v2v/cast.hh b/milena/mln/fun/v2v/cast.hh index 68c2856..564f6c4 100644 --- a/milena/mln/fun/v2v/cast.hh +++ b/milena/mln/fun/v2v/cast.hh @@ -55,6 +55,7 @@ namespace mln The type cast is performed only if needed. + \sa data::transform \ingroup funv2v */ template <typename V> diff --git a/milena/mln/fun/v2v/ch_function_value.hh b/milena/mln/fun/v2v/ch_function_value.hh index 7eb18f3..a4dd508 100644 --- a/milena/mln/fun/v2v/ch_function_value.hh +++ b/milena/mln/fun/v2v/ch_function_value.hh @@ -52,6 +52,7 @@ namespace mln \brief Wrap a function v2v and convert its result to another type. + \sa data::transform \ingroup funv2v */ template <typename F, typename V> diff --git a/milena/mln/fun/v2v/component.hh b/milena/mln/fun/v2v/component.hh index d3b7580..596cbe9 100644 --- a/milena/mln/fun/v2v/component.hh +++ b/milena/mln/fun/v2v/component.hh @@ -49,6 +49,7 @@ namespace mln /*! \brief Functor that accesses the i-th component of a value. + \sa data::transform \ingroup funv2v */ template <typename T, unsigned i> diff --git a/milena/mln/fun/v2v/convert.hh b/milena/mln/fun/v2v/convert.hh index 0c645d3..4cce002 100644 --- a/milena/mln/fun/v2v/convert.hh +++ b/milena/mln/fun/v2v/convert.hh @@ -54,7 +54,9 @@ namespace mln This function relies on convert::from_to(). - \sa data::convert. + How to use this function is detailed in section \ref convert. + + \sa data::convert data::transform \ingroup funv2v convert */ template <typename V> diff --git a/milena/mln/fun/v2v/dec.hh b/milena/mln/fun/v2v/dec.hh index 6e34826..c78292c 100644 --- a/milena/mln/fun/v2v/dec.hh +++ b/milena/mln/fun/v2v/dec.hh @@ -45,6 +45,8 @@ namespace mln /*! \brief Incrementation function. + + \sa data::transform \ingroup funv2v */ template <typename T> diff --git a/milena/mln/fun/v2v/enc.hh b/milena/mln/fun/v2v/enc.hh index 272d1eb..8e50642 100644 --- a/milena/mln/fun/v2v/enc.hh +++ b/milena/mln/fun/v2v/enc.hh @@ -49,6 +49,7 @@ namespace mln \warning This function works only on types providing enc() member. + \sa data::transform \ingroup funv2v */ template <typename V> diff --git a/milena/mln/fun/v2v/hsl_to_rgb.hh b/milena/mln/fun/v2v/hsl_to_rgb.hh index 574b73c..401e3bc 100644 --- a/milena/mln/fun/v2v/hsl_to_rgb.hh +++ b/milena/mln/fun/v2v/hsl_to_rgb.hh @@ -55,6 +55,9 @@ namespace mln /*! \brief Convert hsl values to rgb. + How to use this function is detailed in section \ref convert. + + \sa data::convert data::transform \ingroup funv2v convert */ template <typename T_rgb> @@ -65,6 +68,12 @@ namespace mln f_hsl_to_rgb_(); + + /*! + This method implements the conversion from HSL to RGB as described by + Max K. Agoston in `Computer Graphics and Geometric Modeling: + Implementation and Algorithms (2005)'. (\cite agoston2005cggmm) + */ template <typename T_hsl> T_rgb operator()(const T_hsl& hsl) const; @@ -93,9 +102,6 @@ namespace mln { } - /// This method implements the conversion from HSL to RGB as described by - /// Max K. Agoston in `Computer Graphics and Geometric Modeling: - /// Implementation and Algorithms (2005)'. template <typename T_rgb> template <typename T_hsl> inline diff --git a/milena/mln/fun/v2v/id.hh b/milena/mln/fun/v2v/id.hh index d1366d1..acaa3f4 100644 --- a/milena/mln/fun/v2v/id.hh +++ b/milena/mln/fun/v2v/id.hh @@ -46,6 +46,7 @@ namespace mln /*! \brief Identity function. + \sa data::transform \ingroup funv2v */ template <typename T> diff --git a/milena/mln/fun/v2v/inc.hh b/milena/mln/fun/v2v/inc.hh index 35bc647..17015a1 100644 --- a/milena/mln/fun/v2v/inc.hh +++ b/milena/mln/fun/v2v/inc.hh @@ -45,6 +45,8 @@ namespace mln /*! \brief Incrementation function. + + \sa data::transform \ingroup funv2v */ template <typename T> diff --git a/milena/mln/fun/v2v/index_of_value.hh b/milena/mln/fun/v2v/index_of_value.hh index b128302..ea0fcc0 100644 --- a/milena/mln/fun/v2v/index_of_value.hh +++ b/milena/mln/fun/v2v/index_of_value.hh @@ -46,6 +46,7 @@ namespace mln /*! File that define a function that gives an index per value. + \sa data::transform \ingroup funv2v */ template <typename T> diff --git a/milena/mln/fun/v2v/linear.hh b/milena/mln/fun/v2v/linear.hh index d0de9fb..f3d8d2d 100644 --- a/milena/mln/fun/v2v/linear.hh +++ b/milena/mln/fun/v2v/linear.hh @@ -56,6 +56,7 @@ namespace mln By defaut, \c T is \c V and \c R is \c T. + \sa data::transform \ingroup funv2v */ template <typename V, typename T = V, typename R = T> diff --git a/milena/mln/fun/v2v/mahalanobis.hh b/milena/mln/fun/v2v/mahalanobis.hh index 46ff33c..9ef6cc3 100644 --- a/milena/mln/fun/v2v/mahalanobis.hh +++ b/milena/mln/fun/v2v/mahalanobis.hh @@ -29,7 +29,7 @@ /// \file /// -/// \brief Define the FIXME +/// \brief Define a function computing the Mahalanobis distance. # include <cmath> # include <mln/core/concept/function.hh> @@ -46,6 +46,11 @@ namespace mln namespace v2v { + /* \brief Compute the Mahalanobis distance. + + \sa data::transform + \ingroup funv2v + */ template <typename V, typename R = float> struct mahalanobis : public Function_v2v< mahalanobis<V,R> >, diff --git a/milena/mln/fun/v2v/norm.hh b/milena/mln/fun/v2v/norm.hh index db8f32b..63872e9 100644 --- a/milena/mln/fun/v2v/norm.hh +++ b/milena/mln/fun/v2v/norm.hh @@ -53,7 +53,7 @@ namespace mln \c V is the type of input values; \c R is the result type. - \see mln::norm::l1. + \see mln::norm::l1 data::transform \ingroup funv2v */ template <typename V, typename R> @@ -67,7 +67,7 @@ namespace mln \c V is the type of input values; \c R is the result type. - \see mln::norm::l2. + \see mln::norm::l2 data::transform \ingroup funv2v */ template <typename V, typename R> @@ -81,7 +81,7 @@ namespace mln \c V is the type of input values; \c R is the result type. - \see mln::norm::linfty. + \see mln::norm::linfty data::transform \ingroup funv2v */ template <typename V, typename R> diff --git a/milena/mln/fun/v2v/projection.hh b/milena/mln/fun/v2v/projection.hh index 4424b67..3f66c04 100644 --- a/milena/mln/fun/v2v/projection.hh +++ b/milena/mln/fun/v2v/projection.hh @@ -51,6 +51,7 @@ namespace mln This function takes points as input and return a point of a lower dimension. + \sa data::transform \ingroup funv2v */ template <typename P, unsigned dir> diff --git a/milena/mln/fun/v2v/qt_rgb_to_int_u.hh b/milena/mln/fun/v2v/qt_rgb_to_int_u.hh index 206df02..6ca52e6 100644 --- a/milena/mln/fun/v2v/qt_rgb_to_int_u.hh +++ b/milena/mln/fun/v2v/qt_rgb_to_int_u.hh @@ -47,6 +47,9 @@ namespace mln /*! \brief Convert value::qt::rgb32 values to value::int_u8. + How to use this function is detailed in section \ref convert. + + \sa data::convert data::transform \ingroup funv2v convert */ template <unsigned n> diff --git a/milena/mln/fun/v2v/rgb8_to_rgbn.hh b/milena/mln/fun/v2v/rgb8_to_rgbn.hh index 2e5fb08..236c95b 100644 --- a/milena/mln/fun/v2v/rgb8_to_rgbn.hh +++ b/milena/mln/fun/v2v/rgb8_to_rgbn.hh @@ -49,8 +49,12 @@ namespace mln /*! \brief Convert a rgb8 value to a rgn, n < 8. - \tparam n defines the output quantification used for the transformation. + \tparam n defines the output quantification used for the + transformation. + How to use this function is detailed in section \ref convert. + + \sa data::convert data::transform \ingroup funv2v convert */ template <unsigned n> diff --git a/milena/mln/fun/v2v/rgb_to_hsl.hh b/milena/mln/fun/v2v/rgb_to_hsl.hh index e13c6d2..c66df46 100644 --- a/milena/mln/fun/v2v/rgb_to_hsl.hh +++ b/milena/mln/fun/v2v/rgb_to_hsl.hh @@ -60,6 +60,9 @@ namespace mln \tparam T_hsl The desired output hsl type. + How to use this function is detailed in section \ref convert. + + \sa data::convert data::transform \ingroup funv2v convert */ template <typename T_hsl> diff --git a/milena/mln/fun/v2v/rgb_to_int_u.hh b/milena/mln/fun/v2v/rgb_to_int_u.hh index 282bc3d..285539d 100644 --- a/milena/mln/fun/v2v/rgb_to_int_u.hh +++ b/milena/mln/fun/v2v/rgb_to_int_u.hh @@ -55,6 +55,9 @@ namespace mln luma = (red + green + blue) / 3; \endverbatim + How to use this function is detailed in section \ref convert. + + \sa data::convert data::transform \ingroup funv2v convert */ template <unsigned n> diff --git a/milena/mln/fun/v2v/rgb_to_luma.hh b/milena/mln/fun/v2v/rgb_to_luma.hh index 3a634f9..74d7be8 100644 --- a/milena/mln/fun/v2v/rgb_to_luma.hh +++ b/milena/mln/fun/v2v/rgb_to_luma.hh @@ -51,6 +51,9 @@ namespace mln luma = 0.299 * red + 0.587 * green + 0.114 * blue; \endverbatim + How to use this function is detailed in section \ref convert. + + \sa data::convert data::transform \ingroup funv2v convert */ template <typename T_luma> diff --git a/milena/mln/fun/v2v/round.hh b/milena/mln/fun/v2v/round.hh index 610b70c..a45b536 100644 --- a/milena/mln/fun/v2v/round.hh +++ b/milena/mln/fun/v2v/round.hh @@ -44,6 +44,8 @@ namespace mln { /*! \brief Round the given value. + + \sa data::transform \ingroup funv2v */ template <typename R> diff --git a/milena/mln/fun/v2v/round_sat.hh b/milena/mln/fun/v2v/round_sat.hh index 9d21028..59d627d 100644 --- a/milena/mln/fun/v2v/round_sat.hh +++ b/milena/mln/fun/v2v/round_sat.hh @@ -47,6 +47,7 @@ namespace mln /*! \brief Round the given value considering its type as circular. + \sa data::transform \ingroup funv2v */ template <typename R> diff --git a/milena/mln/fun/v2v/saturate.hh b/milena/mln/fun/v2v/saturate.hh index 7759d6f..28f14fd 100644 --- a/milena/mln/fun/v2v/saturate.hh +++ b/milena/mln/fun/v2v/saturate.hh @@ -58,6 +58,7 @@ namespace mln return max_V; \endcode + \sa data::convert data::transform \ingroup funv2v */ template <typename V> diff --git a/milena/mln/fun/v2v/value_at_index.hh b/milena/mln/fun/v2v/value_at_index.hh index 90470ce..3a10b2f 100644 --- a/milena/mln/fun/v2v/value_at_index.hh +++ b/milena/mln/fun/v2v/value_at_index.hh @@ -47,6 +47,7 @@ namespace mln /*! \brief File that define a function that gives an index per value. + \sa data::transform \ingroup funv2v */ template <typename T> diff --git a/milena/mln/fun/v2v/wrap.hh b/milena/mln/fun/v2v/wrap.hh index 021bfb4..96c4707 100644 --- a/milena/mln/fun/v2v/wrap.hh +++ b/milena/mln/fun/v2v/wrap.hh @@ -51,6 +51,7 @@ namespace mln /*! \brief Function to wrap values such as 0 -> 0 and [1, L_max] maps to [1, Lmax] (using modulus). + \sa data::transform \ingroup funv2v */ template <typename L> diff --git a/milena/mln/fun/vv2b/eq.hh b/milena/mln/fun/vv2b/eq.hh index be2966f..be7c8a4 100644 --- a/milena/mln/fun/vv2b/eq.hh +++ b/milena/mln/fun/vv2b/eq.hh @@ -46,6 +46,8 @@ namespace mln /*! \brief Functor computing equal between two values. + + \sa data::transform \ingroup funvv2b */ template <typename L, typename R = L> diff --git a/milena/mln/fun/vv2b/ge.hh b/milena/mln/fun/vv2b/ge.hh index cd35b5c..d7a53e6 100644 --- a/milena/mln/fun/vv2b/ge.hh +++ b/milena/mln/fun/vv2b/ge.hh @@ -48,6 +48,7 @@ namespace mln \brief Functor computing "greater or equal than" between two values. + \sa data::transform \ingroup funvv2b */ template <typename L, typename R = L> diff --git a/milena/mln/fun/vv2b/gt.hh b/milena/mln/fun/vv2b/gt.hh index 1d94f1f..7e6a029 100644 --- a/milena/mln/fun/vv2b/gt.hh +++ b/milena/mln/fun/vv2b/gt.hh @@ -46,6 +46,8 @@ namespace mln /*! \brief Functor computing "greater than" between two values. + + \sa data::transform \ingroup funvv2b */ template <typename L, typename R = L> diff --git a/milena/mln/fun/vv2b/implies.hh b/milena/mln/fun/vv2b/implies.hh index 8362fcd..9a5dcff 100644 --- a/milena/mln/fun/vv2b/implies.hh +++ b/milena/mln/fun/vv2b/implies.hh @@ -46,6 +46,8 @@ namespace mln /*! \brief Functor computing logical-implies between two values. + + \sa data::transform \ingroup vv2b */ template <typename L, typename R = L> diff --git a/milena/mln/fun/vv2b/le.hh b/milena/mln/fun/vv2b/le.hh index 615b82b..f97b632 100644 --- a/milena/mln/fun/vv2b/le.hh +++ b/milena/mln/fun/vv2b/le.hh @@ -48,6 +48,7 @@ namespace mln \brief Functor computing "lower or equal than" between two values. + \sa data::transform \ingroup funvv2b */ template <typename L, typename R = L> diff --git a/milena/mln/fun/vv2b/lt.hh b/milena/mln/fun/vv2b/lt.hh index 2ab7d29..9d6d8b1 100644 --- a/milena/mln/fun/vv2b/lt.hh +++ b/milena/mln/fun/vv2b/lt.hh @@ -47,6 +47,7 @@ namespace mln /*! \brief Functor computing "lower than" between two values. + \sa data::transform \ingroup funvv2b */ template <typename L, typename R = L> diff --git a/milena/mln/fun/vv2v/diff_abs.hh b/milena/mln/fun/vv2v/diff_abs.hh index abde9d2..3135b54 100644 --- a/milena/mln/fun/vv2v/diff_abs.hh +++ b/milena/mln/fun/vv2v/diff_abs.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. // @@ -43,9 +44,12 @@ namespace mln namespace vv2v { - // FIXME: Doc. + /*! + \brief A functor computing the diff_absimum of two values. - /// \brief A functor computing the diff_absimum of two values. + \sa data::transform + \ingroup funvv2v + */ template <typename V> struct diff_abs : public Function_vv2v< diff_abs<V> > { diff --git a/milena/mln/fun/vv2v/land.hh b/milena/mln/fun/vv2v/land.hh index 3080e91..0513aca 100644 --- a/milena/mln/fun/vv2v/land.hh +++ b/milena/mln/fun/vv2v/land.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. // @@ -43,7 +44,12 @@ namespace mln namespace vv2v { - /// Functor computing logical-and between two values. + /*! + \brief Functor computing logical-and between two values. + + \sa data::transform + \ingroup funvv2v + */ template <typename L, typename R = L> struct land : public Function_vv2v< land<L,R> > { diff --git a/milena/mln/fun/vv2v/land_not.hh b/milena/mln/fun/vv2v/land_not.hh index 6b7eb49..7e3a003 100644 --- a/milena/mln/fun/vv2v/land_not.hh +++ b/milena/mln/fun/vv2v/land_not.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. // @@ -44,7 +45,12 @@ namespace mln namespace vv2v { - /// Functor computing logical and-not between two values. + /*! + \brief Functor computing logical and-not between two values. + + \sa data::transform + \ingroup funvv2v + */ template <typename L, typename R = L> struct land_not : public Function_vv2v< land_not<L,R> > { diff --git a/milena/mln/fun/vv2v/lor.hh b/milena/mln/fun/vv2v/lor.hh index aee5115..511f3d5 100644 --- a/milena/mln/fun/vv2v/lor.hh +++ b/milena/mln/fun/vv2v/lor.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. // @@ -43,7 +44,12 @@ namespace mln namespace vv2v { - /// Functor computing logical-or between two values. + /*! + \brief Functor computing logical-or between two values. + + \sa data::transform + \ingroup funvv2v + */ template <typename L, typename R = L> struct lor : public Function_vv2v< lor<L,R> > { diff --git a/milena/mln/fun/vv2v/lxor.hh b/milena/mln/fun/vv2v/lxor.hh index 7bcbaca..7cf5ad9 100644 --- a/milena/mln/fun/vv2v/lxor.hh +++ b/milena/mln/fun/vv2v/lxor.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. // @@ -43,7 +44,12 @@ namespace mln namespace vv2v { - /// Functor computing logical-xor between two values. + /*! + \brief Functor computing logical-xor between two values. + + \sa data::transform + \ingroup funvv2v + */ template <typename L, typename R = L> struct lxor : public Function_vv2v< lxor<L,R> > { diff --git a/milena/mln/fun/vv2v/max.hh b/milena/mln/fun/vv2v/max.hh index 8d4a4d9..4e8da81 100644 --- a/milena/mln/fun/vv2v/max.hh +++ b/milena/mln/fun/vv2v/max.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. // @@ -42,9 +43,12 @@ namespace mln namespace vv2v { - // FIXME: Doc. + /*! + \brief A functor computing the maximum of two values. - /// \brief A functor computing the maximum of two values. + \sa data::transform + \ingroup funvv2v + */ template <typename V> struct max : public Function_vv2v< max<V> > { diff --git a/milena/mln/fun/vv2v/min.hh b/milena/mln/fun/vv2v/min.hh index 0f885fc..a83b7d4 100644 --- a/milena/mln/fun/vv2v/min.hh +++ b/milena/mln/fun/vv2v/min.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. // @@ -43,9 +44,12 @@ namespace mln namespace vv2v { - // FIXME: Doc. + /*! + \brief A functor computing the minimum of two values. - /// \brief A functor computing the minimum of two values. + \sa data::transform + \ingroup funvv2v + */ template <typename L, typename R = L> struct min : public Function_vv2v< min<L,R> >, private mlc_converts_to(R,L)::check_t diff --git a/milena/mln/fun/vv2v/vec.hh b/milena/mln/fun/vv2v/vec.hh index 908d4ff..a2b3231 100644 --- a/milena/mln/fun/vv2v/vec.hh +++ b/milena/mln/fun/vv2v/vec.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. // @@ -43,9 +44,12 @@ namespace mln namespace vv2v { - // FIXME: Doc. + /*! + \brief A functor computing the vecimum of two values. - /// \brief A functor computing the vecimum of two values. + \sa data::transform + \ingroup funvv2v + */ template <typename V> struct vec : public Function_vv2v< vec<V> > { -- 1.7.2.5

1 0