automatic.hpp
17.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
#ifndef BOOST_NUMERIC_AUTOMATIC_HPP
#define BOOST_NUMERIC_AUTOMATIC_HPP
// Copyright (c) 2012 Robert Ramey
//
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// policy which creates expanded results types designed
// to avoid overflows.
#include <limits>
#include <cstdint> // (u)intmax_t,
#include <type_traits> // conditional
#include <boost/integer.hpp>
#include "safe_common.hpp"
#include "checked_result.hpp"
#include "checked_default.hpp"
#include "checked_integer.hpp"
#include "checked_result_operations.hpp"
#include "interval.hpp"
#include "utility.hpp"
namespace boost {
namespace safe_numerics {
struct automatic {
private:
// the following returns the "true" type. After calculating the new max and min
// these return the minimum size type which can hold the expected result.
struct defer_stored_signed_lazily {
template<std::intmax_t Min, std::intmax_t Max>
using type = utility::signed_stored_type<Min, Max>;
};
struct defer_stored_unsigned_lazily {
template<std::uintmax_t Min, std::uintmax_t Max>
using type = utility::unsigned_stored_type<Min, Max>;
};
template<typename T, T Min, T Max>
struct result_type {
using type = typename std::conditional<
std::numeric_limits<T>::is_signed,
defer_stored_signed_lazily,
defer_stored_unsigned_lazily
>::type::template type<Min, Max>;
};
public:
///////////////////////////////////////////////////////////////////////
template<typename T, typename U>
struct addition_result {
using temp_base_type = typename std::conditional<
// if both arguments are unsigned
! std::numeric_limits<T>::is_signed
&& ! std::numeric_limits<U>::is_signed,
// result is unsigned
std::uintmax_t,
// otherwise result is signed
std::intmax_t
>::type;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_interval_type u_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
constexpr static const r_interval_type r_interval = t_interval + u_interval;
constexpr static auto rl = r_interval.l;
constexpr static auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
template<typename T, typename U>
struct subtraction_result {
// result of subtraction are always signed.
using temp_base_type = intmax_t;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_interval_type u_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
constexpr static const r_interval_type r_interval = t_interval - u_interval;
constexpr static auto rl = r_interval.l;
constexpr static auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
template<typename T, typename U>
struct multiplication_result {
using temp_base_type = typename std::conditional<
// if both arguments are unsigned
! std::numeric_limits<T>::is_signed
&& ! std::numeric_limits<U>::is_signed,
// result is unsigned
std::uintmax_t,
// otherwise result is signed
std::intmax_t
>::type;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_interval_type u_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
constexpr static const r_interval_type r_interval = t_interval * u_interval;
constexpr static const auto rl = r_interval.l;
constexpr static const auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
template<typename T, typename U>
struct division_result {
using temp_base_type = typename std::conditional<
// if both arguments are unsigned
! std::numeric_limits<T>::is_signed
&& ! std::numeric_limits<U>::is_signed,
// result is unsigned
std::uintmax_t,
// otherwise result is signed
std::intmax_t
>::type;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_interval_type u_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
constexpr static r_interval_type rx(){
if(u_interval.u < r_type(0)
|| u_interval.l > r_type(0))
return t_interval / u_interval;
return utility::minmax(
std::initializer_list<r_type> {
t_interval.l / u_interval.l,
t_interval.l / r_type(-1),
t_interval.l / r_type(1),
t_interval.l / u_interval.u,
t_interval.u / u_interval.l,
t_interval.u / r_type(-1),
t_interval.u / r_type(1),
t_interval.u / u_interval.u,
}
);
}
constexpr static const r_interval_type r_interval = rx();
constexpr static auto rl = r_interval.l;
constexpr static auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
template<typename T, typename U>
struct modulus_result {
using temp_base_type = typename std::conditional<
// if both arguments are unsigned
! std::numeric_limits<T>::is_signed
&& ! std::numeric_limits<U>::is_signed,
// result is unsigned
std::uintmax_t,
// otherwise result is signed
std::intmax_t
>::type;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_interval_type u_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
constexpr static r_interval_type rx(){
if(u_interval.u < r_type(0)
|| u_interval.l > r_type(0))
return t_interval / u_interval;
return utility::minmax(
std::initializer_list<r_type> {
t_interval.l % u_interval.l,
t_interval.l % r_type(-1),
t_interval.l % r_type(1),
t_interval.l % u_interval.u,
t_interval.u % u_interval.l,
t_interval.u % r_type(-1),
t_interval.u % r_type(1),
t_interval.u % u_interval.u,
}
);
}
constexpr static const r_interval_type r_interval = rx();
constexpr static auto rl = r_interval.l;
constexpr static auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
// note: comparison_result (<, >, ...) is special.
// The return value is always a bool. The type returned here is
// the intermediate type applied to make the values comparable.
template<typename T, typename U>
struct comparison_result {
using temp_base_type = typename std::conditional<
// if both arguments are unsigned
! std::numeric_limits<T>::is_signed
&& ! std::numeric_limits<U>::is_signed,
// result is unsigned
std::uintmax_t,
// otherwise result is signed
std::intmax_t
>::type;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_interval_type u_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
// workaround some microsoft problem
#if 0
constexpr static r_type min(const r_type & t, const r_type & u){
// assert(! u.exception());
// assert(! t.exception());
return static_cast<bool>(t < u) ? t : u;
}
constexpr static r_type max(const r_type & t, const r_type & u){
// assert(! u.exception());
// assert(! t.exception());
return static_cast<bool>(t < u) ? u : t;
}
#endif
// union of two intervals
// note: we can't use t_interval | u_interval because it
// depends on max and min which in turn depend on < which in turn
// depends on implicit conversion of tribool to bool
constexpr static r_interval_type union_interval(
const r_interval_type & t,
const r_interval_type & u
){
//const r_type & rl = min(t.l, u.l);
const r_type & rmin = static_cast<bool>(t.l < u.l) ? t.l : u.l;
//const r_type & ru = max(t.u, u.u);
const r_type & rmax = static_cast<bool>(t.u < u.u) ? u.u : t.u;
return r_interval_type(rmin, rmax);
}
constexpr static const r_interval_type r_interval =
union_interval(t_interval, u_interval);
constexpr static auto rl = r_interval.l;
constexpr static auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
// shift operations
template<typename T, typename U>
struct left_shift_result {
using temp_base_type = typename std::conditional<
std::numeric_limits<T>::is_signed,
std::intmax_t,
std::uintmax_t
>::type;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_interval_type u_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
constexpr static const r_interval_type r_interval =
t_interval << u_interval;
constexpr static auto rl = r_interval.l;
constexpr static auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
template<typename T, typename U>
struct right_shift_result {
using temp_base_type = typename std::conditional<
std::numeric_limits<T>::is_signed,
std::intmax_t,
std::uintmax_t
>::type;
using r_type = checked_result<temp_base_type>;
using r_interval_type = interval<r_type>;
constexpr static const r_interval_type t_interval{
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::min())),
checked::cast<temp_base_type>(base_value(std::numeric_limits<T>::max()))
};
constexpr static const r_type u_min
= checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::min()));
constexpr static const r_interval_type u_interval{
u_min.exception()
? r_type(0)
: u_min,
checked::cast<temp_base_type>(base_value(std::numeric_limits<U>::max()))
};
constexpr static const r_interval_type r_interval = t_interval >> u_interval;
constexpr static auto rl = r_interval.l;
constexpr static auto ru = r_interval.u;
using type = typename result_type<
temp_base_type,
rl.exception()
? std::numeric_limits<temp_base_type>::min()
: static_cast<temp_base_type>(rl),
ru.exception()
? std::numeric_limits<temp_base_type>::max()
: static_cast<temp_base_type>(ru)
>::type;
};
///////////////////////////////////////////////////////////////////////
template<typename T, typename U>
struct bitwise_and_result {
using type = decltype(
typename base_type<T>::type()
& typename base_type<U>::type()
);
};
template<typename T, typename U>
struct bitwise_or_result {
using type = decltype(
typename base_type<T>::type()
| typename base_type<U>::type()
);
};
template<typename T, typename U>
struct bitwise_xor_result {
using type = decltype(
typename base_type<T>::type()
^ typename base_type<U>::type()
);
};
};
} // safe_numerics
} // boost
#endif // BOOST_NUMERIC_AUTOMATIC_HPP