$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
neighb_niter_base.hh
1 // Copyright (C) 2009, 2012, 2013 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_CORE_INTERNAL_NEIGHB_NITER_BASE_HH
28 # define MLN_CORE_INTERNAL_NEIGHB_NITER_BASE_HH
29 
33 
34 # include <mln/core/internal/site_relative_iterator_base.hh>
35 # include <mln/core/internal/neighb_niter_impl.hh>
36 
37 namespace mln
38 {
39 
40  namespace internal
41  {
42 
46  template <typename W, typename N, typename I, typename E>
49  E,
50  mln_psite(N) >,
51  public internal::neighb_niter_impl<W,E>
52  {
53  public:
54 
57 
58  template <typename P>
59  neighb_niter_base(const N& nbh, const P& c);
60 
63  bool is_valid_() const;
64 
66  void invalidate_();
67 
69  void do_start_();
70 
72  void do_next_();
73 
75  mln_psite(W) compute_p_() const;
77  protected:
78 
79  I i_;
80  };
81 
82 
83 
84 # ifndef MLN_INCLUDE_ONLY
85 
86 
87  // neighb_niter_base<W,N,I,E>
88 
89  template <typename W, typename N, typename I, typename E>
90  inline
92  {
93  }
94 
95  template <typename W, typename N, typename I, typename E>
96  template <typename P>
97  inline
98  neighb_niter_base<W,N,I,E>::neighb_niter_base(const N& nbh, const P& c)
99  {
100  this->change_target(nbh);
101  this->center_at(c);
102 
103  }
104 
105  template <typename W, typename N, typename I, typename E>
106  inline
107  bool
109  {
110  return i_.is_valid();
111  }
112 
113  template <typename W, typename N, typename I, typename E>
114  inline
115  void
117  {
118  i_.invalidate();
119  }
120 
121  template <typename W, typename N, typename I, typename E>
122  inline
123  void
125  {
126  i_.start();
127  }
128 
129  template <typename W, typename N, typename I, typename E>
130  inline
131  void
133  {
134  i_.next();
135  }
136 
137  template <typename W, typename N, typename I, typename E>
138  inline
139  mln_psite(W)
140  neighb_niter_base<W,N,I,E>::compute_p_() const
141  {
142  return i_.compute_p_();
143  }
144 
145 
146 # endif // ! MLN_INCLUDE_ONLY
147 
148 
149  } // end of namespace mln::internal
150 
151 } // end of namespace mln
152 
153 
154 #endif // ! MLN_CORE_INTERNAL_NEIGHB_NITER_BASE_HH