Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
compare.hh
1 // Copyright (C) 2007, 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_DATA_COMPARE_HH
28 # define MLN_DATA_COMPARE_HH
29 
33 
34 # include <mln/core/concept/image.hh>
35 # include <mln/fun/vv2b/eq.hh>
36 # include <mln/fun/vv2b/le.hh>
37 # include <mln/fun/vv2b/lt.hh>
38 # include <mln/test/predicate.hh>
39 
40 
41 namespace mln
42 {
43 
51  //
52  template <typename L, typename R>
53  bool operator == (const Image<L>& lhs, const Image<R>& rhs);
54 
55 
63  //
64  template <typename L, typename R>
65  bool operator < (const Image<L>& lhs, const Image<R>& rhs);
66 
67 
75  //
76  template <typename L, typename R> // required!
77  bool operator <= (const Image<L>& lhs, const Image<R>& rhs);
78 
79 
80 
81 # ifndef MLN_INCLUDE_ONLY
82 
83 
84  template <typename L, typename R>
85  inline
86  bool operator == (const Image<L>& lhs_, const Image<R>& rhs_)
87  {
88  trace::entering("data::compare (==)");
89 
90  const L& lhs = exact(lhs_);
91  const R& rhs = exact(rhs_);
92 
93  mln_precondition(lhs.is_valid());
94  mln_precondition(rhs.is_valid());
95  mln_precondition(lhs.domain() == rhs.domain());
96 
98  bool res = test::predicate(lhs, rhs, F());
99 
100  trace::exiting("data::compare (==)");
101  return res;
102  }
103 
104 
105  template <typename L, typename R>
106  inline
107  bool operator < (const Image<L>& lhs_, const Image<R>& rhs_)
108  {
109  trace::entering("data::compare (<)");
110 
111  const L& lhs = exact(lhs_);
112  const R& rhs = exact(rhs_);
113 
114  mln_precondition(lhs.domain() == rhs.domain());
115 
117  bool res = test::predicate(lhs_, rhs_, F());
118 
119  trace::exiting("data::compare (<)");
120  return res;
121  }
122 
123 
124  template <typename L, typename R> // required!
125  inline
126  bool operator <= (const Image<L>& lhs_, const Image<R>& rhs_)
127  {
128  trace::entering("data::compare (<=)");
129 
130  const L& lhs = exact(lhs_);
131  const R& rhs = exact(rhs_);
132 
133  mln_precondition(lhs.domain() == rhs.domain());
134 
136  bool res = test::predicate(lhs_, rhs_, F());
137 
138  trace::exiting("data::compare (<=)");
139  return res;
140  }
141 
142 # endif // ! MLN_INCLUDE_ONLY
143 
144 } // end of namespace mln
145 
146 
147 #endif // ! MLN_DATA_COMPARE_HH