Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
debug/iota.hh
1 // Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development
2 // 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 
35 # include <mln/core/concept/image.hh>
36 
37 // Specializations are in:
38 # include <mln/debug/iota.spe.hh>
39 
40 
41 namespace mln
42 {
43 
44  namespace debug
45  {
46 
52  template <typename I>
53  void iota(Image<I>& input, unsigned base_index);
54 
55 
56 # ifndef MLN_INCLUDE_ONLY
57 
58  namespace impl
59  {
60 
61  template <typename I>
62  inline
63  void
64  iota(trait::image::speed::any, I& input, unsigned base_index)
65  {
66  unsigned i = base_index;
67  mln_piter(I) p(input.domain());
68  for_all(p)
69  input(p) = ++i % mln_max(mln_value(I));
70  }
71 
72  } // end of namespace mln::debug::impl
73 
74 
75 
76  template <typename I>
77  inline
78  void
79  iota(Image<I>& input)
80  {
81  iota(input, 0);
82  }
83 
84 
85  template <typename I>
86  inline
87  void
88  iota(Image<I>& input, unsigned base_index)
89  {
90  trace::entering("debug::iota");
91  mln_precondition(exact(input).is_valid());
92  impl::iota(mln_trait_image_speed(I)(), exact(input), base_index);
93  trace::exiting("debug::iota");
94  }
95 
96 
97 # endif // ! MLN_INCLUDE_ONLY
98 
99  } // end of namespace mln::debug
100 
101 } // end of namespace mln
102 
103 
104 #endif // ! MLN_DEBUG_IOTA_HH