$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
debug/iota.hh
1 // Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and
2 // Development Laboratory (LRDE)
3 //
4 // This file is part of Olena.
5 //
6 // Olena is free software: you can redistribute it and/or modify it under
7 // the terms of the GNU General Public License as published by the Free
8 // Software Foundation, version 2 of the License.
9 //
10 // Olena is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
17 //
18 // As a special exception, you may use this file as part of a free
19 // software project without restriction. Specifically, if other files
20 // instantiate templates or use macros or inline functions from this
21 // file, or you compile this file and link it with other files to produce
22 // an executable, this file does not by itself cause the resulting
23 // executable to be covered by the GNU General Public License. This
24 // exception does not however invalidate any other reasons why the
25 // executable file might be covered by the GNU General Public License.
26 
27 #ifndef MLN_DEBUG_IOTA_HH
28 # define MLN_DEBUG_IOTA_HH
29 
32 
33 # include <mln/core/concept/image.hh>
34 
35 namespace mln
36 {
37  namespace trait
38  {
39  // FIXME: Move this to mln/trait/ and generalize it?
40 
41  /* Local trait: Modulus type compatible with `unsigned'.
42 
43  The `mln::debug::iota' routine below performs an operation
44  `i % m', where `i' is an `unsigned' value and `m' is the
45  image's maximum value type. However, this operation is not
46  valid when `m' is a `float' or a `double'. Hence the following
47  trait, returning `unsigned' for these floating-point
48  value types and `T' for any other value type T. */
49  template <typename T> struct modulus_type { typedef T ret; };
50  template <> struct modulus_type<float> { typedef unsigned ret; };
51  template <> struct modulus_type<double> { typedef unsigned ret; };
52 
53  } // end of namespace mln::debug
54 
55 } // end of namespace mln
56 
57 
58 // Specializations are in:
59 # include <mln/debug/iota.spe.hh>
60 
61 
62 namespace mln
63 {
64 
65  namespace debug
66  {
67 
76  template <typename I>
77  void iota(Image<I>& input, unsigned base_index);
78 
79 
80 # ifndef MLN_INCLUDE_ONLY
81 
82  namespace impl
83  {
84 
85  template <typename I>
86  inline
87  void
88  iota(trait::image::speed::any, I& input, unsigned base_index)
89  {
90  unsigned i = base_index;
91  mln_piter(I) p(input.domain());
92  typedef mln_value(I) V;
93  for_all(p)
94  input(p) =
95  static_cast<V>(++i % mln_max(typename trait::modulus_type<V>::ret));
96  }
97 
98  } // end of namespace mln::debug::impl
99 
100 
101 
102  template <typename I>
103  inline
104  void
105  iota(Image<I>& input)
106  {
107  iota(input, 0);
108  }
109 
110 
111  template <typename I>
112  inline
113  void
114  iota(Image<I>& input, unsigned base_index)
115  {
116  mln_trace("debug::iota");
117  mln_precondition(exact(input).is_valid());
118  impl::iota(mln_trait_image_speed(I)(), exact(input), base_index);
119  }
120 
121 
122 # endif // ! MLN_INCLUDE_ONLY
123 
124  } // end of namespace mln::debug
125 
126 } // end of namespace mln
127 
128 
129 #endif // ! MLN_DEBUG_IOTA_HH