Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
sym.hh
1 // Copyright (C) 2007, 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_WIN_SYM_HH
27 # define MLN_WIN_SYM_HH
28 
32 
33 # include <mln/core/concept/window.hh>
34 # include <mln/core/concept/weighted_window.hh>
35 
36 
37 
38 namespace mln
39 {
40 
41  namespace win
42  {
43 
46  template <typename W>
47  W sym(const Window<W>& win);
48 
51  template <typename W>
52  W sym(const Weighted_Window<W>& w_win);
53 
54 
55 # ifndef MLN_INCLUDE_ONLY
56 
57  template <typename W>
58  inline
59  W sym(const Window<W>& win)
60  {
61  trace::entering("win::sym");
62  mln_precondition(exact(win).is_valid());
63  W tmp = exact(win);
64  tmp.sym();
65  trace::exiting("win::sym");
66  return tmp;
67  }
68 
69  template <typename W>
70  inline
71  W sym(const Weighted_Window<W>& w_win)
72  {
73  trace::entering("win::sym");
74  mln_precondition(exact(w_win).is_valid());
75  W tmp = exact(w_win);
76  tmp.sym();
77  trace::exiting("win::sym");
78  return tmp;
79  }
80 
81 # endif // ! MLN_INCLUDE_ONLY
82 
83  } // end of namespace mln::win
84 
85 } // end of namespace mln
86 
87 
88 #endif // ! MLN_WIN_SYM_HH