Bitcoin Core  24.99.0
P2P Digital Currency
overflow.h
Go to the documentation of this file.
1 // Copyright (c) 2021-2022 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_UTIL_OVERFLOW_H
6 #define BITCOIN_UTIL_OVERFLOW_H
7 
8 #include <limits>
9 #include <optional>
10 #include <type_traits>
11 
12 template <class T>
13 [[nodiscard]] bool AdditionOverflow(const T i, const T j) noexcept
14 {
15  static_assert(std::is_integral<T>::value, "Integral required.");
16  if constexpr (std::numeric_limits<T>::is_signed) {
17  return (i > 0 && j > std::numeric_limits<T>::max() - i) ||
18  (i < 0 && j < std::numeric_limits<T>::min() - i);
19  }
20  return std::numeric_limits<T>::max() - i < j;
21 }
22 
23 template <class T>
24 [[nodiscard]] std::optional<T> CheckedAdd(const T i, const T j) noexcept
25 {
26  if (AdditionOverflow(i, j)) {
27  return std::nullopt;
28  }
29  return i + j;
30 }
31 
32 template <class T>
33 [[nodiscard]] T SaturatingAdd(const T i, const T j) noexcept
34 {
35  if constexpr (std::numeric_limits<T>::is_signed) {
36  if (i > 0 && j > std::numeric_limits<T>::max() - i) {
37  return std::numeric_limits<T>::max();
38  }
39  if (i < 0 && j < std::numeric_limits<T>::min() - i) {
40  return std::numeric_limits<T>::min();
41  }
42  } else {
43  if (std::numeric_limits<T>::max() - i < j) {
44  return std::numeric_limits<T>::max();
45  }
46  }
47  return i + j;
48 }
49 
50 #endif // BITCOIN_UTIL_OVERFLOW_H
#define T(expected, seed, data)
bool AdditionOverflow(const T i, const T j) noexcept
Definition: overflow.h:13
std::optional< T > CheckedAdd(const T i, const T j) noexcept
Definition: overflow.h:24
T SaturatingAdd(const T i, const T j) noexcept
Definition: overflow.h:33