Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
trait/neighborhood.hh
1 // Copyright (C) 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_TRAIT_NEIGHBORHOOD_HH
27 # define MLN_TRAIT_NEIGHBORHOOD_HH
28 
32 
33 # include <string>
34 
35 
38 # define mln_trait_neighborhood_kind(N) \
39  typename mln::trait::neighborhood< N >::nature
40 # define mln_trait_neighborhood_kind_(N) \
41  mln::trait::neighborhood< N >::nature
42 
43 
44 
45 namespace mln
46 {
47 
48  namespace trait
49  {
50 
51  // Forward declaration.
52  struct undef;
53 
54 
55  /*----------------.
56  | Traits values. |
57  `----------------*/
58 
59  // FIXME: Might be moved to another file, as it's the case for
60  // images and values.
61 
63  namespace neighborhood
64  {
65 
67  struct kind
68  {
70  struct any
71  {
72  std::string name() const { return "kind::any"; }
73  };
74 
76  struct generic : any
77  {
78  std::string name() const { return "kind::generic"; }
79  };
80 
83  struct regular : any
84  {
85  std::string name() const { return "kind::regular"; }
86  };
87  };
88  }
89 
90 
91 
92  struct undefined_neighborhood_
93  {
94  typedef undef kind;
95  };
96 
97 
98  struct default_neighborhood_ : undefined_neighborhood_
99  {
100  typedef trait::neighborhood::kind::generic kind;
101  };
102 
103 
104  template <typename V>
105  struct neighborhood_ : default_neighborhood_
106  {
107  };
108 
109  } // end of namespace mln::trait
110 
111 } // end of namespace mln
112 
113 #endif // ! MLN_TRAIT_NEIGHBORHOOD_HH