Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
window_base.hh
1 // Copyright (C) 2008, 2009 EPITA Research and Development Laboratory
2 // (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_WINDOW_BASE_HH
28 # define MLN_CORE_INTERNAL_WINDOW_BASE_HH
29 
33 
34 # include <mln/core/concept/window.hh>
35 
36 
37 namespace mln
38 {
39 
40  namespace internal
41  {
42 
43 
48  template <typename D, typename E>
49  struct window_base : public Window<E>
50  {
51 
53  typedef D dpsite;
54 
56  typedef mln_psite(D) psite;
57 
59  typedef mln_site(D) site;
60 
62  typedef psite center_t;
63 
65  // This method is used in the neighborhood window-adapter.
66  bool is_neighbable_() const;
67 
69  bool is_valid() const;
70 
71  protected:
72  window_base();
73  };
74 
75 
76 # ifndef MLN_INCLUDE_ONLY
77 
78  template <typename D, typename E>
79  inline
80  window_base<D,E>::window_base()
81  {
82  }
83 
84  template <typename D, typename E>
85  inline
86  bool
87  window_base<D,E>::is_valid() const
88  {
89  return true;
90  }
91 
92  template <typename D, typename E>
93  inline
94  bool
95  window_base<D,E>::is_neighbable_() const
96  {
97  return exact(this)->is_symmetric() && ! exact(this)->is_centered();
98  }
99 
100 # endif // ! MLN_INCLUDE_ONLY
101 
102  } // end of namespace mln::internal
103 
104 } // end of namespace mln
105 
106 
107 #endif // ! MLN_CORE_INTERNAL_WINDOW_BASE_HH