Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
lemmings.hh
1 // Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
2 //
3 // This file is part of Olena.
4 //
5 // Olena is free software: you can redistribute it and/or modify it under
6 // the terms of the GNU General Public License as published by the Free
7 // Software Foundation, version 2 of the License.
8 //
9 // Olena is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
16 //
17 // As a special exception, you may use this file as part of a free
18 // software project without restriction. Specifically, if other files
19 // instantiate templates or use macros or inline functions from this
20 // file, or you compile this file and link it with other files to produce
21 // an executable, this file does not by itself cause the resulting
22 // executable to be covered by the GNU General Public License. This
23 // exception does not however invalidate any other reasons why the
24 // executable file might be covered by the GNU General Public License.
25 
26 #ifndef MLN_UTIL_LEMMINGS_HH
27 # define MLN_UTIL_LEMMINGS_HH
28 
32 
33 # include <mln/core/concept/image.hh>
34 
35 
36 namespace mln
37 {
38 
39  namespace util
40  {
41 
45  template <typename I>
46  struct lemmings_ : public Object< lemmings_<I> >
47  {
48  lemmings_(const Image<I>& ima, const mln_psite(I)& pt,
49  const mln_deduce(I, psite, delta)& dpt, const mln_value(I)& val);
50 
51  mln_psite(I) operator()();
52 
53  const I& ima_;
54  mln_psite(I) pt_;
55  const mln_deduce(I, psite, delta)& dpt_;
56  const mln_value(I)& val_;
57  };
58 
72  template <typename I>
73  mln_psite(I)
74  lemmings(const Image<I>& ima, const mln_psite(I)& pt,
75  const mln_deduce(I, psite, delta)& dpt, const mln_value(I)& val);
76 
77 
78 # ifndef MLN_INCLUDE_ONLY
79 
80  // lemmings
81 
82  template <typename I>
83  inline
84  lemmings_<I>::lemmings_(const Image<I>& ima, const mln_psite(I)& pt,
85  const mln_deduce(I, psite, delta)& dpt, const mln_value(I)& val)
86  : ima_(exact(ima)),
87  pt_(pt),
88  dpt_(dpt),
89  val_(val)
90  {
91  }
92 
93  template <typename I>
94  mln_psite(I)
95  lemmings_<I>::operator()()
96  {
97  while (ima_.domain().has(pt_) && ima_(pt_) == val_)
98  pt_ += dpt_;
99  return pt_;
100  }
101 
102  template <typename I>
103  mln_psite(I)
104  lemmings(const Image<I>& ima, const mln_psite(I)& pt,
105  const mln_deduce(I, psite, delta)& dpt, const mln_value(I)& val)
106  {
107  lemmings_<I> lm(ima, pt, dpt, val);
108  return lm();
109  }
110 
111 # endif // ! MLN_INCLUDE_ONLY
112 
113  } // end of namespace mln::util
114 
115 } // end of namespace mln
116 
117 
118 #endif // ! MLN_UTIL_LEMMINGS_HH