$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
complex_neighborhood_base.hh
1 // Copyright (C) 2008, 2009, 2012 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_COMPLEX_NEIGHBORHOOD_BASE_HH
28 # define MLN_CORE_INTERNAL_COMPLEX_NEIGHBORHOOD_BASE_HH
29 
34 
35 # include <mln/core/concept/neighborhood.hh>
36 # include <mln/core/site_set/complex_psite.hh>
37 # include <mln/core/image/complex_neighborhood_piter.hh>
38 
39 # include <mln/core/internal/neighb_base.hh>
40 
41 
42 namespace mln
43 {
44  // Forward declarations.
45  template <typename I, typename G, typename N>
46  class complex_neighborhood_fwd_piter;
47  template <typename I, typename G, typename N>
48  class complex_neighborhood_bkd_piter;
49 
50  namespace internal
51  {
52  template <typename W, typename E>
53  class complex_neighborhood_base;
54  }
55 
56 
57  namespace internal
58  {
67  template <typename W, typename E>
69  {
70  public:
73  typedef typename W::complex_fwd_iter complex_fwd_iter;
74  typedef typename W::complex_bkd_iter complex_bkd_iter;
76 
77  public:
81  typedef mln_geom(W) G;
83  typedef mln_psite(W) psite;
85  typedef mln_site(W) site;
86 
89  typedef
91 
94  typedef
96 
98  typedef fwd_niter niter;
99 
101  typedef W window;
103 
104  public:
106  const W& win() const;
107 
109  bool is_valid() const;
110 
111  private:
113  W win_;
114  };
115 
116 
117 
118 # ifndef MLN_INCLUDE_ONLY
119 
120  template <typename W, typename E>
121  inline
122  const W&
124  {
125  return win_;
126  }
127 
128  template <typename W, typename E>
129  inline
130  bool
132  {
133  return win().is_valid();
134  }
135 
136 # endif // ! MLN_INCLUDE_ONLY
137 
138  } // end of namespace mln::internal
139 
140 } // end of namespace mln
141 
142 #endif // ! MLN_CORE_INTERNAL_COMPLEX_NEIGHBORHOOD_BASE_HH