$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
logical/xor.hh
1 // Copyright (C) 2007, 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_LOGICAL_XOR_HH
28 # define MLN_LOGICAL_XOR_HH
29 
33 
34 # include <mln/logical/includes.hh>
35 # include <mln/fun/vv2v/lxor.hh>
36 
37 
38 namespace mln
39 {
40 
41  namespace logical
42  {
43 
55  template <typename L, typename R>
56  mln_ch_fun_vv2v(lxor, L, R)
57  xor_(const Image<L>& lhs, const Image<R>& rhs);
58 
59 
74  template <typename L, typename R>
75  void xor_inplace(Image<L>& lhs, const Image<R>& rhs);
76 
77 
78 # ifndef MLN_INCLUDE_ONLY
79 
80  template <typename L, typename R>
81  inline
82  mln_ch_fun_vv2v(lxor, L, R)
83  xor_(const Image<L>& lhs, const Image<R>& rhs)
84  {
85  mln_trace("logical::xor_");
86 
87  internal::tests(lhs, rhs);
88 
89  mln_fun_vv2v(lxor, L, R) f;
90  mln_ch_fun_vv2v(lxor, L, R) output = data::transform(lhs, rhs, f);
91 
92  return output;
93  }
94 
95  template <typename L, typename R>
96  inline
97  void xor_inplace(Image<L>& lhs, const Image<R>& rhs)
98  {
99  mln_trace("logical::xor_inplace");
100 
101  mlc_converts_to(mln_fun_vv2v_result(lxor, L, R),
102  mln_value(L))::check();
103 
104  internal::tests(lhs, rhs);
105 
106  mln_fun_vv2v(lxor, L, R) f;
107  data::transform_inplace(lhs, rhs, f);
108 
109  }
110 
111 # endif // ! MLN_INCLUDE_ONLY
112 
113  } // end of namespace mln::logical
114 
115 } // end of namespace mln
116 
117 
118 #endif // ! MLN_LOGICAL_XOR_HH