xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
basics
MathUtilities.h
1
#pragma once
2
3
#include <
algorithm
>
4
#include <
cassert
>
5
#include <
cstddef
>
6
#include <
cstdint
>
7
#include <
limits
>
8
#include <
optional
>
9
10
namespace
xrpl
{
11
16
[[nodiscard]]
constexpr
std::optional<std::int64_t>
17
checkedAdd
(
std::int64_t
a,
std::int64_t
b)
noexcept
18
{
19
using
L =
std::numeric_limits<std::int64_t>
;
20
21
if
((b > 0 && a > L::max() - b) || (b < 0 && a < L::min() - b))
22
return
std::nullopt;
23
24
return
a + b;
25
}
26
31
[[nodiscard]]
constexpr
std::optional<std::int64_t>
32
checkedSub
(
std::int64_t
a,
std::int64_t
b)
noexcept
33
{
34
using
L =
std::numeric_limits<std::int64_t>
;
35
36
if
((b > 0 && a < L::min() + b) || (b < 0 && a > L::max() + b))
37
return
std::nullopt;
38
39
return
a - b;
40
}
41
46
[[nodiscard]]
constexpr
std::optional<std::int64_t>
47
checkedMul
(
std::int64_t
a,
std::int64_t
b)
noexcept
48
{
49
using
L =
std::numeric_limits<std::int64_t>
;
50
51
if
(a == 0 || b == 0)
52
return
0;
53
54
if
(a > 0)
55
{
56
if
(b > 0 ? a > L::max() / b : b < L::min() / a)
57
return
std::nullopt;
58
}
59
else
if
(b > 0 ? a < L::min() / b : b < L::max() / a)
60
{
61
return
std::nullopt;
62
}
63
64
return
a * b;
65
}
66
67
static_assert
(
checkedAdd
(0, 0) == 0);
68
static_assert
(
checkedAdd
(1, -1) == 0);
69
static_assert
(
checkedAdd
(-5, 2) == -3);
70
static_assert
(!
checkedAdd
(
std::numeric_limits<std::int64_t>::max
(), 1).has_value());
71
static_assert
(!
checkedAdd
(
std::numeric_limits<std::int64_t>::min
(), -1).has_value());
72
static_assert
(
73
checkedAdd
(
std::numeric_limits<std::int64_t>::max
() - 1, 1) ==
74
std::numeric_limits<std::int64_t>::max
());
75
static_assert
(
76
checkedAdd
(
77
std::numeric_limits<std::int64_t>::min
(),
78
std::numeric_limits<std::int64_t>::max
()) == -1);
79
static_assert
(
80
checkedAdd
(
81
std::numeric_limits<std::int64_t>::max
(),
82
std::numeric_limits<std::int64_t>::min
()) == -1);
83
static_assert
(
84
!
checkedAdd
(
std::numeric_limits<std::int64_t>::max
(),
std::numeric_limits<std::int64_t>::max
())
85
.has_value());
86
static_assert
(
87
!
checkedAdd
(
std::numeric_limits<std::int64_t>::min
(),
std::numeric_limits<std::int64_t>::min
())
88
.has_value());
89
90
static_assert
(
checkedSub
(0, 0) == 0);
91
static_assert
(
checkedSub
(1, 1) == 0);
92
static_assert
(
checkedSub
(-5, 2) == -7);
93
static_assert
(
checkedSub
(-5, -2) == -3);
94
static_assert
(!
checkedSub
(
std::numeric_limits<std::int64_t>::min
(), 1).has_value());
95
static_assert
(!
checkedSub
(
std::numeric_limits<std::int64_t>::max
(), -1).has_value());
96
static_assert
(
97
checkedSub
(
std::numeric_limits<std::int64_t>::min
() + 1, 1) ==
98
std::numeric_limits<std::int64_t>::min
());
99
static_assert
(
100
checkedSub
(-1,
std::numeric_limits<std::int64_t>::max
()) ==
101
std::numeric_limits<std::int64_t>::min
());
102
static_assert
(
103
!
checkedSub
(
std::numeric_limits<std::int64_t>::max
(),
std::numeric_limits<std::int64_t>::min
())
104
.has_value());
105
static_assert
(
106
!
checkedSub
(
std::numeric_limits<std::int64_t>::min
(),
std::numeric_limits<std::int64_t>::max
())
107
.has_value());
108
109
static_assert
(
checkedMul
(0,
std::numeric_limits<std::int64_t>::min
()) == 0);
110
static_assert
(
checkedMul
(
std::numeric_limits<std::int64_t>::min
(), 0) == 0);
111
static_assert
(
checkedMul
(-1, -1) == 1);
112
// a > 0, b > 0
113
static_assert
(
114
checkedMul
(
std::numeric_limits<std::int64_t>::max
(), 1) ==
115
std::numeric_limits<std::int64_t>::max
());
116
static_assert
(
117
checkedMul
(
std::numeric_limits<std::int64_t>::max
() / 2, 2) ==
118
std::numeric_limits<std::int64_t>::max
() - 1);
119
static_assert
(!
checkedMul
((
std::numeric_limits<std::int64_t>::max
() / 2) + 1, 2).has_value());
120
static_assert
(!
checkedMul
(2, (
std::numeric_limits<std::int64_t>::max
() / 2) + 1).has_value());
121
// a > 0, b < 0
122
static_assert
(
123
checkedMul
(
std::numeric_limits<std::int64_t>::max
(), -1) ==
124
-
std::numeric_limits<std::int64_t>::max
());
125
static_assert
(
126
checkedMul
((
std::numeric_limits<std::int64_t>::max
() / 2) + 1, -2) ==
127
std::numeric_limits<std::int64_t>::min
());
128
static_assert
(!
checkedMul
((
std::numeric_limits<std::int64_t>::max
() / 2) + 2, -2).has_value());
129
static_assert
(
130
checkedMul
(1,
std::numeric_limits<std::int64_t>::min
()) ==
131
std::numeric_limits<std::int64_t>::min
());
132
static_assert
(
133
checkedMul
(2,
std::numeric_limits<std::int64_t>::min
() / 2) ==
134
std::numeric_limits<std::int64_t>::min
());
135
static_assert
(!
checkedMul
(2, (
std::numeric_limits<std::int64_t>::min
() / 2) - 1).has_value());
136
// a < 0, b > 0
137
static_assert
(
138
checkedMul
(
std::numeric_limits<std::int64_t>::min
(), 1) ==
139
std::numeric_limits<std::int64_t>::min
());
140
static_assert
(
141
checkedMul
(
std::numeric_limits<std::int64_t>::min
() / 2, 2) ==
142
std::numeric_limits<std::int64_t>::min
());
143
static_assert
(!
checkedMul
((
std::numeric_limits<std::int64_t>::min
() / 2) - 1, 2).has_value());
144
static_assert
(!
checkedMul
(
std::numeric_limits<std::int64_t>::min
(), 2).has_value());
145
// a < 0, b < 0
146
static_assert
(
147
checkedMul
(-(
std::numeric_limits<std::int64_t>::max
() / 2), -2) ==
148
std::numeric_limits<std::int64_t>::max
() - 1);
149
static_assert
(!
checkedMul
(
std::numeric_limits<std::int64_t>::min
() / 2, -2).has_value());
150
static_assert
(
151
checkedMul
(-1, -
std::numeric_limits<std::int64_t>::max
()) ==
152
std::numeric_limits<std::int64_t>::max
());
153
static_assert
(!
checkedMul
(
std::numeric_limits<std::int64_t>::min
(), -1).has_value());
154
static_assert
(!
checkedMul
(-1,
std::numeric_limits<std::int64_t>::min
()).has_value());
155
171
constexpr
std::size_t
172
calculatePercent
(
std::size_t
count,
std::size_t
total)
173
{
174
assert(total != 0);
// NOTE No XRPL_ASSERT here, because constexpr
175
return
((
std::min
(count, total) * 100) + total - 1) / total;
176
}
177
178
// unit tests
179
static_assert
(
calculatePercent
(1, 2) == 50);
180
static_assert
(
calculatePercent
(0, 100) == 0);
181
static_assert
(
calculatePercent
(100, 100) == 100);
182
static_assert
(
calculatePercent
(200, 100) == 100);
183
static_assert
(
calculatePercent
(1, 100) == 1);
184
static_assert
(
calculatePercent
(1, 99) == 2);
185
static_assert
(
calculatePercent
(6, 14) == 43);
186
static_assert
(
calculatePercent
(29, 33) == 88);
187
static_assert
(
calculatePercent
(1, 64) == 2);
188
static_assert
(
calculatePercent
(0, 100'000'000) == 0);
189
static_assert
(
calculatePercent
(1, 100'000'000) == 1);
190
static_assert
(
calculatePercent
(50'000'000, 100'000'000) == 50);
191
static_assert
(
calculatePercent
(50'000'001, 100'000'000) == 51);
192
static_assert
(
calculatePercent
(99'999'999, 100'000'000) == 100);
193
194
}
// namespace xrpl
algorithm
cassert
cstddef
cstdint
std::int64_t
limits
std::numeric_limits::max
T max(T... args)
std::numeric_limits::min
T min(T... args)
xrpl
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition
algorithm.h:5
xrpl::checkedSub
constexpr std::optional< std::int64_t > checkedSub(std::int64_t a, std::int64_t b) noexcept
Subtract two signed 64-bit integers, returning std::nullopt when the exact mathematical difference is...
Definition
MathUtilities.h:32
xrpl::checkedAdd
constexpr std::optional< std::int64_t > checkedAdd(std::int64_t a, std::int64_t b) noexcept
Add two signed 64-bit integers, returning std::nullopt when the exact mathematical sum is not represe...
Definition
MathUtilities.h:17
xrpl::calculatePercent
constexpr std::size_t calculatePercent(std::size_t count, std::size_t total)
Calculate one number divided by another number in percentage.
Definition
MathUtilities.h:172
xrpl::checkedMul
constexpr std::optional< std::int64_t > checkedMul(std::int64_t a, std::int64_t b) noexcept
Multiply two signed 64-bit integers, returning std::nullopt when the exact mathematical product is no...
Definition
MathUtilities.h:47
std::numeric_limits
optional
std::size_t
Generated by
1.17.0