$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
primary.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_CORE_ROUTINE_PRIMARY_HH
27 # define MLN_CORE_ROUTINE_PRIMARY_HH
28 
35 
36 # include <mln/core/concept/image.hh>
37 
38 
39 namespace mln
40 {
41 
42  // Forward declaration.
43  namespace internal
44  {
45  template <typename I> struct primary_type;
46  }
47 
48 
50  template <typename I>
51  const typename internal::primary_type<I>::ret&
52  primary(const Image<I>& input);
53 
54 
55 
56 # ifndef MLN_INCLUDE_ONLY
57 
58 
59  namespace internal
60  {
61 
62  // Primary_type.
63 
64  template <typename I> struct primary_type;
65 
66  template <typename I, typename C>
67  struct primary_type_helper
68  {
69  typedef typename I::delegatee D;
70  typedef typename primary_type<D>::ret ret;
71  };
72 
73  template <typename I>
74  struct primary_type_helper< I, mln::trait::image::category::primary >
75  {
76  typedef I ret;
77  };
78 
79  template <typename I>
80  struct primary_type
81  {
82  typedef mln_trait_image_category(I) Cat;
83  typedef typename primary_type_helper<I, Cat>::ret ret;
84  };
85 
86 
87  // Routine.
88 
89  template <typename I>
90  const typename internal::primary_type<I>::ret&
91  primary_(const Image<I>& input); // Forward declaration.
92 
93  template <typename I>
94  inline
95  const typename internal::primary_type<I>::ret&
96  primary_(trait::image::category::primary,
97  const Image<I>& input)
98  {
99  return exact(input);
100  }
101 
102  template <typename I>
103  inline
104  const typename internal::primary_type<I>::ret&
105  primary_(trait::image::category::morpher,
106  const Image<I>& input)
107  {
108  return primary_(exact(input).unmorph_());
109  }
110 
111  template <typename I>
112  inline
113  const typename internal::primary_type<I>::ret&
114  primary_(const Image<I>& input)
115  {
116  return primary_(mln_trait_image_category(I)(),
117  input);
118  }
119 
120  } // end of namespace mln::internal
121 
122 
123 
124  // Facade.
125 
126  template <typename I>
127  inline
128  const typename internal::primary_type<I>::ret&
129  primary(const Image<I>& input)
130  {
131  mln_precondition(exact(input).is_valid());
132  return internal::primary_(input);
133  }
134 
135 
136 # endif // ! MLN_INCLUDE_ONLY
137 
138 } // end of namespace mln
139 
140 
141 #endif // ! MLN_CORE_ROUTINE_PRIMARY_HH