... |
... |
@@ -12,438 +12,438 @@
|
12 |
12 |
*
|
13 |
13 |
* This software is provided "AS IS" with no warranty of any kind,
|
14 |
14 |
* express or implied, and with no claim as to its suitability for any
|
15 |
15 |
* purpose.
|
16 |
16 |
*
|
17 |
17 |
*/
|
18 |
18 |
|
19 |
19 |
#ifndef LEMON_TOLERANCE_H
|
20 |
20 |
#define LEMON_TOLERANCE_H
|
21 |
21 |
|
22 |
22 |
///\ingroup misc
|
23 |
23 |
///\file
|
24 |
24 |
///\brief A basic tool to handle the anomalies of calculation with
|
25 |
25 |
///floating point numbers.
|
26 |
26 |
///
|
27 |
27 |
///\todo It should be in a module like "Basic tools"
|
28 |
28 |
|
29 |
29 |
|
30 |
30 |
namespace lemon {
|
31 |
31 |
|
32 |
32 |
/// \addtogroup misc
|
33 |
33 |
/// @{
|
34 |
34 |
|
35 |
35 |
///\brief A class to provide a basic way to
|
36 |
36 |
///handle the comparison of numbers that are obtained
|
37 |
37 |
///as a result of a probably inexact computation.
|
38 |
38 |
///
|
39 |
39 |
///Tolerance is a class to provide a basic way to
|
40 |
40 |
///handle the comparison of numbers that are obtained
|
41 |
41 |
///as a result of a probably inexact computation.
|
42 |
42 |
///
|
43 |
43 |
///This is an abstract class, it should be specialized for all numerical
|
44 |
|
///data types. These specialized classes like \ref Tolerance\<double\>
|
|
44 |
///data types. These specialized classes like Tolerance<double>
|
45 |
45 |
///may offer additional tuning parameters.
|
46 |
46 |
///
|
47 |
47 |
///\sa Tolerance<float>
|
48 |
48 |
///\sa Tolerance<double>
|
49 |
49 |
///\sa Tolerance<long double>
|
50 |
50 |
///\sa Tolerance<int>
|
51 |
51 |
#if defined __GNUC__ && !defined __STRICT_ANSI__
|
52 |
52 |
///\sa Tolerance<long long int>
|
53 |
53 |
#endif
|
54 |
54 |
///\sa Tolerance<unsigned int>
|
55 |
55 |
#if defined __GNUC__ && !defined __STRICT_ANSI__
|
56 |
56 |
///\sa Tolerance<unsigned long long int>
|
57 |
57 |
#endif
|
58 |
58 |
|
59 |
59 |
template<class T>
|
60 |
60 |
class Tolerance
|
61 |
61 |
{
|
62 |
62 |
public:
|
63 |
63 |
typedef T Value;
|
64 |
64 |
|
65 |
65 |
///\name Comparisons
|
66 |
66 |
///The concept is that these bool functions return with \c true only if
|
67 |
67 |
///the related comparisons hold even if some numerical error appeared
|
68 |
68 |
///during the computations.
|
69 |
69 |
|
70 |
70 |
///@{
|
71 |
71 |
|
72 |
72 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
73 |
73 |
static bool less(Value a,Value b) {return false;}
|
74 |
74 |
///Returns \c true if \c a is \e surely different from \c b
|
75 |
75 |
static bool different(Value a,Value b) {return false;}
|
76 |
76 |
///Returns \c true if \c a is \e surely positive
|
77 |
77 |
static bool positive(Value a) {return false;}
|
78 |
78 |
///Returns \c true if \c a is \e surely negative
|
79 |
79 |
static bool negative(Value a) {return false;}
|
80 |
80 |
///Returns \c true if \c a is \e surely non-zero
|
81 |
81 |
static bool nonZero(Value a) {return false;}
|
82 |
82 |
|
83 |
83 |
///@}
|
84 |
84 |
|
85 |
85 |
///Returns the zero value.
|
86 |
86 |
static Value zero() {return T();}
|
87 |
87 |
|
88 |
88 |
// static bool finite(Value a) {}
|
89 |
89 |
// static Value big() {}
|
90 |
90 |
// static Value negativeBig() {}
|
91 |
91 |
};
|
92 |
92 |
|
93 |
93 |
|
94 |
|
///Float specialization of \ref Tolerance.
|
|
94 |
///Float specialization of Tolerance.
|
95 |
95 |
|
96 |
|
///Float specialization of \ref Tolerance.
|
|
96 |
///Float specialization of Tolerance.
|
97 |
97 |
///\sa Tolerance
|
98 |
98 |
///\relates Tolerance
|
99 |
99 |
template<>
|
100 |
100 |
class Tolerance<float>
|
101 |
101 |
{
|
102 |
102 |
static float def_epsilon;
|
103 |
103 |
float _epsilon;
|
104 |
104 |
public:
|
105 |
105 |
///\e
|
106 |
106 |
typedef float Value;
|
107 |
107 |
|
108 |
108 |
///Constructor setting the epsilon tolerance to the default value.
|
109 |
109 |
Tolerance() : _epsilon(def_epsilon) {}
|
110 |
110 |
///Constructor setting the epsilon tolerance.
|
111 |
111 |
Tolerance(float e) : _epsilon(e) {}
|
112 |
112 |
|
113 |
113 |
///Return the epsilon value.
|
114 |
114 |
Value epsilon() const {return _epsilon;}
|
115 |
115 |
///Set the epsilon value.
|
116 |
116 |
void epsilon(Value e) {_epsilon=e;}
|
117 |
117 |
|
118 |
118 |
///Return the default epsilon value.
|
119 |
119 |
static Value defaultEpsilon() {return def_epsilon;}
|
120 |
120 |
///Set the default epsilon value.
|
121 |
121 |
static void defaultEpsilon(Value e) {def_epsilon=e;}
|
122 |
122 |
|
123 |
123 |
///\name Comparisons
|
124 |
124 |
///See class Tolerance for more details.
|
125 |
125 |
|
126 |
126 |
///@{
|
127 |
127 |
|
128 |
128 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
129 |
129 |
bool less(Value a,Value b) const {return a+_epsilon<b;}
|
130 |
130 |
///Returns \c true if \c a is \e surely different from \c b
|
131 |
131 |
bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
|
132 |
132 |
///Returns \c true if \c a is \e surely positive
|
133 |
133 |
bool positive(Value a) const { return _epsilon<a; }
|
134 |
134 |
///Returns \c true if \c a is \e surely negative
|
135 |
135 |
bool negative(Value a) const { return -_epsilon>a; }
|
136 |
136 |
///Returns \c true if \c a is \e surely non-zero
|
137 |
137 |
bool nonZero(Value a) const { return positive(a)||negative(a); }
|
138 |
138 |
|
139 |
139 |
///@}
|
140 |
140 |
|
141 |
141 |
///Returns zero
|
142 |
142 |
static Value zero() {return 0;}
|
143 |
143 |
};
|
144 |
144 |
|
145 |
|
///Double specialization of \ref Tolerance.
|
|
145 |
///Double specialization of Tolerance.
|
146 |
146 |
|
147 |
|
///Double specialization of \ref Tolerance.
|
|
147 |
///Double specialization of Tolerance.
|
148 |
148 |
///\sa Tolerance
|
149 |
149 |
///\relates Tolerance
|
150 |
150 |
template<>
|
151 |
151 |
class Tolerance<double>
|
152 |
152 |
{
|
153 |
153 |
static double def_epsilon;
|
154 |
154 |
double _epsilon;
|
155 |
155 |
public:
|
156 |
156 |
///\e
|
157 |
157 |
typedef double Value;
|
158 |
158 |
|
159 |
159 |
///Constructor setting the epsilon tolerance to the default value.
|
160 |
160 |
Tolerance() : _epsilon(def_epsilon) {}
|
161 |
161 |
///Constructor setting the epsilon tolerance.
|
162 |
162 |
Tolerance(double e) : _epsilon(e) {}
|
163 |
163 |
|
164 |
164 |
///Return the epsilon value.
|
165 |
165 |
Value epsilon() const {return _epsilon;}
|
166 |
166 |
///Set the epsilon value.
|
167 |
167 |
void epsilon(Value e) {_epsilon=e;}
|
168 |
168 |
|
169 |
169 |
///Return the default epsilon value.
|
170 |
170 |
static Value defaultEpsilon() {return def_epsilon;}
|
171 |
171 |
///Set the default epsilon value.
|
172 |
172 |
static void defaultEpsilon(Value e) {def_epsilon=e;}
|
173 |
173 |
|
174 |
174 |
///\name Comparisons
|
175 |
175 |
///See class Tolerance for more details.
|
176 |
176 |
|
177 |
177 |
///@{
|
178 |
178 |
|
179 |
179 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
180 |
180 |
bool less(Value a,Value b) const {return a+_epsilon<b;}
|
181 |
181 |
///Returns \c true if \c a is \e surely different from \c b
|
182 |
182 |
bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
|
183 |
183 |
///Returns \c true if \c a is \e surely positive
|
184 |
184 |
bool positive(Value a) const { return _epsilon<a; }
|
185 |
185 |
///Returns \c true if \c a is \e surely negative
|
186 |
186 |
bool negative(Value a) const { return -_epsilon>a; }
|
187 |
187 |
///Returns \c true if \c a is \e surely non-zero
|
188 |
188 |
bool nonZero(Value a) const { return positive(a)||negative(a); }
|
189 |
189 |
|
190 |
190 |
///@}
|
191 |
191 |
|
192 |
192 |
///Returns zero
|
193 |
193 |
static Value zero() {return 0;}
|
194 |
194 |
};
|
195 |
195 |
|
196 |
|
///Long double specialization of \ref Tolerance.
|
|
196 |
///Long double specialization of Tolerance.
|
197 |
197 |
|
198 |
|
///Long double specialization of \ref Tolerance.
|
|
198 |
///Long double specialization of Tolerance.
|
199 |
199 |
///\sa Tolerance
|
200 |
200 |
///\relates Tolerance
|
201 |
201 |
template<>
|
202 |
202 |
class Tolerance<long double>
|
203 |
203 |
{
|
204 |
204 |
static long double def_epsilon;
|
205 |
205 |
long double _epsilon;
|
206 |
206 |
public:
|
207 |
207 |
///\e
|
208 |
208 |
typedef long double Value;
|
209 |
209 |
|
210 |
210 |
///Constructor setting the epsilon tolerance to the default value.
|
211 |
211 |
Tolerance() : _epsilon(def_epsilon) {}
|
212 |
212 |
///Constructor setting the epsilon tolerance.
|
213 |
213 |
Tolerance(long double e) : _epsilon(e) {}
|
214 |
214 |
|
215 |
215 |
///Return the epsilon value.
|
216 |
216 |
Value epsilon() const {return _epsilon;}
|
217 |
217 |
///Set the epsilon value.
|
218 |
218 |
void epsilon(Value e) {_epsilon=e;}
|
219 |
219 |
|
220 |
220 |
///Return the default epsilon value.
|
221 |
221 |
static Value defaultEpsilon() {return def_epsilon;}
|
222 |
222 |
///Set the default epsilon value.
|
223 |
223 |
static void defaultEpsilon(Value e) {def_epsilon=e;}
|
224 |
224 |
|
225 |
225 |
///\name Comparisons
|
226 |
226 |
///See class Tolerance for more details.
|
227 |
227 |
|
228 |
228 |
///@{
|
229 |
229 |
|
230 |
230 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
231 |
231 |
bool less(Value a,Value b) const {return a+_epsilon<b;}
|
232 |
232 |
///Returns \c true if \c a is \e surely different from \c b
|
233 |
233 |
bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
|
234 |
234 |
///Returns \c true if \c a is \e surely positive
|
235 |
235 |
bool positive(Value a) const { return _epsilon<a; }
|
236 |
236 |
///Returns \c true if \c a is \e surely negative
|
237 |
237 |
bool negative(Value a) const { return -_epsilon>a; }
|
238 |
238 |
///Returns \c true if \c a is \e surely non-zero
|
239 |
239 |
bool nonZero(Value a) const { return positive(a)||negative(a); }
|
240 |
240 |
|
241 |
241 |
///@}
|
242 |
242 |
|
243 |
243 |
///Returns zero
|
244 |
244 |
static Value zero() {return 0;}
|
245 |
245 |
};
|
246 |
246 |
|
247 |
|
///Integer specialization of \ref Tolerance.
|
|
247 |
///Integer specialization of Tolerance.
|
248 |
248 |
|
249 |
|
///Integer specialization of \ref Tolerance.
|
|
249 |
///Integer specialization of Tolerance.
|
250 |
250 |
///\sa Tolerance
|
251 |
251 |
template<>
|
252 |
252 |
class Tolerance<int>
|
253 |
253 |
{
|
254 |
254 |
public:
|
255 |
255 |
///\e
|
256 |
256 |
typedef int Value;
|
257 |
257 |
|
258 |
258 |
///\name Comparisons
|
259 |
|
///See \ref Tolerance for more details.
|
|
259 |
///See Tolerance for more details.
|
260 |
260 |
|
261 |
261 |
///@{
|
262 |
262 |
|
263 |
263 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
264 |
264 |
static bool less(Value a,Value b) { return a<b;}
|
265 |
265 |
///Returns \c true if \c a is \e surely different from \c b
|
266 |
266 |
static bool different(Value a,Value b) { return a!=b; }
|
267 |
267 |
///Returns \c true if \c a is \e surely positive
|
268 |
268 |
static bool positive(Value a) { return 0<a; }
|
269 |
269 |
///Returns \c true if \c a is \e surely negative
|
270 |
270 |
static bool negative(Value a) { return 0>a; }
|
271 |
271 |
///Returns \c true if \c a is \e surely non-zero
|
272 |
272 |
static bool nonZero(Value a) { return a!=0; }
|
273 |
273 |
|
274 |
274 |
///@}
|
275 |
275 |
|
276 |
276 |
///Returns zero
|
277 |
277 |
static Value zero() {return 0;}
|
278 |
278 |
};
|
279 |
279 |
|
280 |
|
///Unsigned integer specialization of \ref Tolerance.
|
|
280 |
///Unsigned integer specialization of Tolerance.
|
281 |
281 |
|
282 |
282 |
///Unsigned integer specialization of \ref Tolerance.
|
283 |
283 |
///\sa Tolerance
|
284 |
284 |
template<>
|
285 |
285 |
class Tolerance<unsigned int>
|
286 |
286 |
{
|
287 |
287 |
public:
|
288 |
288 |
///\e
|
289 |
289 |
typedef unsigned int Value;
|
290 |
290 |
|
291 |
291 |
///\name Comparisons
|
292 |
|
///See \ref Tolerance for more details.
|
|
292 |
///See Tolerance for more details.
|
293 |
293 |
|
294 |
294 |
///@{
|
295 |
295 |
|
296 |
296 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
297 |
297 |
static bool less(Value a,Value b) { return a<b;}
|
298 |
298 |
///Returns \c true if \c a is \e surely different from \c b
|
299 |
299 |
static bool different(Value a,Value b) { return a!=b; }
|
300 |
300 |
///Returns \c true if \c a is \e surely positive
|
301 |
301 |
static bool positive(Value a) { return 0<a; }
|
302 |
302 |
///Returns \c true if \c a is \e surely negative
|
303 |
303 |
static bool negative(Value) { return false; }
|
304 |
304 |
///Returns \c true if \c a is \e surely non-zero
|
305 |
305 |
static bool nonZero(Value a) { return a!=0; }
|
306 |
306 |
|
307 |
307 |
///@}
|
308 |
308 |
|
309 |
309 |
///Returns zero
|
310 |
310 |
static Value zero() {return 0;}
|
311 |
311 |
};
|
312 |
312 |
|
313 |
313 |
|
314 |
|
///Long integer specialization of \ref Tolerance.
|
|
314 |
///Long integer specialization of Tolerance.
|
315 |
315 |
|
316 |
|
///Long integer specialization of \ref Tolerance.
|
|
316 |
///Long integer specialization of Tolerance.
|
317 |
317 |
///\sa Tolerance
|
318 |
318 |
template<>
|
319 |
319 |
class Tolerance<long int>
|
320 |
320 |
{
|
321 |
321 |
public:
|
322 |
322 |
///\e
|
323 |
323 |
typedef long int Value;
|
324 |
324 |
|
325 |
325 |
///\name Comparisons
|
326 |
|
///See \ref Tolerance for more details.
|
|
326 |
///See Tolerance for more details.
|
327 |
327 |
|
328 |
328 |
///@{
|
329 |
329 |
|
330 |
330 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
331 |
331 |
static bool less(Value a,Value b) { return a<b;}
|
332 |
332 |
///Returns \c true if \c a is \e surely different from \c b
|
333 |
333 |
static bool different(Value a,Value b) { return a!=b; }
|
334 |
334 |
///Returns \c true if \c a is \e surely positive
|
335 |
335 |
static bool positive(Value a) { return 0<a; }
|
336 |
336 |
///Returns \c true if \c a is \e surely negative
|
337 |
337 |
static bool negative(Value a) { return 0>a; }
|
338 |
338 |
///Returns \c true if \c a is \e surely non-zero
|
339 |
339 |
static bool nonZero(Value a) { return a!=0;}
|
340 |
340 |
|
341 |
341 |
///@}
|
342 |
342 |
|
343 |
343 |
///Returns zero
|
344 |
344 |
static Value zero() {return 0;}
|
345 |
345 |
};
|
346 |
346 |
|
347 |
|
///Unsigned long integer specialization of \ref Tolerance.
|
|
347 |
///Unsigned long integer specialization of Tolerance.
|
348 |
348 |
|
349 |
349 |
///Unsigned long integer specialization of \ref Tolerance.
|
350 |
350 |
///\sa Tolerance
|
351 |
351 |
template<>
|
352 |
352 |
class Tolerance<unsigned long int>
|
353 |
353 |
{
|
354 |
354 |
public:
|
355 |
355 |
///\e
|
356 |
356 |
typedef unsigned long int Value;
|
357 |
357 |
|
358 |
358 |
///\name Comparisons
|
359 |
|
///See \ref Tolerance for more details.
|
|
359 |
///See Tolerance for more details.
|
360 |
360 |
|
361 |
361 |
///@{
|
362 |
362 |
|
363 |
363 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
364 |
364 |
static bool less(Value a,Value b) { return a<b;}
|
365 |
365 |
///Returns \c true if \c a is \e surely different from \c b
|
366 |
366 |
static bool different(Value a,Value b) { return a!=b; }
|
367 |
367 |
///Returns \c true if \c a is \e surely positive
|
368 |
368 |
static bool positive(Value a) { return 0<a; }
|
369 |
369 |
///Returns \c true if \c a is \e surely negative
|
370 |
370 |
static bool negative(Value) { return false; }
|
371 |
371 |
///Returns \c true if \c a is \e surely non-zero
|
372 |
372 |
static bool nonZero(Value a) { return a!=0;}
|
373 |
373 |
|
374 |
374 |
///@}
|
375 |
375 |
|
376 |
376 |
///Returns zero
|
377 |
377 |
static Value zero() {return 0;}
|
378 |
378 |
};
|
379 |
379 |
|
380 |
380 |
#if defined __GNUC__ && !defined __STRICT_ANSI__
|
381 |
381 |
|
382 |
|
///Long long integer specialization of \ref Tolerance.
|
|
382 |
///Long long integer specialization of Tolerance.
|
383 |
383 |
|
384 |
384 |
///Long long integer specialization of \ref Tolerance.
|
385 |
385 |
///\warning This class (more exactly, type <tt>long long</tt>)
|
386 |
386 |
///is not ansi compatible.
|
387 |
387 |
///\sa Tolerance
|
388 |
388 |
template<>
|
389 |
389 |
class Tolerance<long long int>
|
390 |
390 |
{
|
391 |
391 |
public:
|
392 |
392 |
///\e
|
393 |
393 |
typedef long long int Value;
|
394 |
394 |
|
395 |
395 |
///\name Comparisons
|
396 |
396 |
///See \ref Tolerance for more details.
|
397 |
397 |
|
398 |
398 |
///@{
|
399 |
399 |
|
400 |
400 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
401 |
401 |
static bool less(Value a,Value b) { return a<b;}
|
402 |
402 |
///Returns \c true if \c a is \e surely different from \c b
|
403 |
403 |
static bool different(Value a,Value b) { return a!=b; }
|
404 |
404 |
///Returns \c true if \c a is \e surely positive
|
405 |
405 |
static bool positive(Value a) { return 0<a; }
|
406 |
406 |
///Returns \c true if \c a is \e surely negative
|
407 |
407 |
static bool negative(Value a) { return 0>a; }
|
408 |
408 |
///Returns \c true if \c a is \e surely non-zero
|
409 |
409 |
static bool nonZero(Value a) { return a!=0;}
|
410 |
410 |
|
411 |
411 |
///@}
|
412 |
412 |
|
413 |
413 |
///Returns zero
|
414 |
414 |
static Value zero() {return 0;}
|
415 |
415 |
};
|
416 |
416 |
|
417 |
|
///Unsigned long long integer specialization of \ref Tolerance.
|
|
417 |
///Unsigned long long integer specialization of Tolerance.
|
418 |
418 |
|
419 |
419 |
///Unsigned long long integer specialization of \ref Tolerance.
|
420 |
420 |
///\warning This class (more exactly, type <tt>unsigned long long</tt>)
|
421 |
421 |
///is not ansi compatible.
|
422 |
422 |
///\sa Tolerance
|
423 |
423 |
template<>
|
424 |
424 |
class Tolerance<unsigned long long int>
|
425 |
425 |
{
|
426 |
426 |
public:
|
427 |
427 |
///\e
|
428 |
428 |
typedef unsigned long long int Value;
|
429 |
429 |
|
430 |
430 |
///\name Comparisons
|
431 |
431 |
///See \ref Tolerance for more details.
|
432 |
432 |
|
433 |
433 |
///@{
|
434 |
434 |
|
435 |
435 |
///Returns \c true if \c a is \e surely strictly less than \c b
|
436 |
436 |
static bool less(Value a,Value b) { return a<b;}
|
437 |
437 |
///Returns \c true if \c a is \e surely different from \c b
|
438 |
438 |
static bool different(Value a,Value b) { return a!=b; }
|
439 |
439 |
///Returns \c true if \c a is \e surely positive
|
440 |
440 |
static bool positive(Value a) { return 0<a; }
|
441 |
441 |
///Returns \c true if \c a is \e surely negative
|
442 |
442 |
static bool negative(Value) { return false; }
|
443 |
443 |
///Returns \c true if \c a is \e surely non-zero
|
444 |
444 |
static bool nonZero(Value a) { return a!=0;}
|
445 |
445 |
|
446 |
446 |
///@}
|
447 |
447 |
|
448 |
448 |
///Returns zero
|
449 |
449 |
static Value zero() {return 0;}
|