Sourcemeta Core 0.0.0
Loading...
Searching...
No Matches
numeric_decimal.h
1#ifndef SOURCEMETA_CORE_NUMERIC_DECIMAL_H_
2#define SOURCEMETA_CORE_NUMERIC_DECIMAL_H_
3
4#ifndef SOURCEMETA_CORE_NUMERIC_EXPORT
5#include <sourcemeta/core/numeric_export.h>
6#endif
7
8#include <sourcemeta/core/preprocessor.h>
9
10#include <cassert> // assert
11#include <concepts> // std::integral
12#include <cstdint> // std::int32_t, std::int64_t, std::uint32_t, std::uint64_t
13#include <string> // std::string
14#include <string_view> // std::string_view
15#include <type_traits> // std::is_signed_v
16
17namespace sourcemeta::core {
18
21class SOURCEMETA_CORE_NUMERIC_EXPORT Decimal {
22public:
24 Decimal() noexcept;
25
28
30 Decimal(const Decimal &other);
31
33 Decimal(Decimal &&other) noexcept;
34
36 template <typename T>
37 requires std::integral<T> && std::is_signed_v<T> &&
38 (!std::same_as<T, std::int64_t>)
39 Decimal(const T value) : Decimal{static_cast<std::int64_t>(value)} {}
40
42 Decimal(std::int64_t value);
43
45 template <typename T>
46 requires std::integral<T> && std::is_unsigned_v<T> &&
47 (!std::same_as<T, std::uint64_t>)
48 Decimal(const T value) : Decimal{static_cast<std::uint64_t>(value)} {}
49
51 Decimal(std::uint64_t value);
52
54 explicit Decimal(float value);
55
57 explicit Decimal(double value);
58
60 explicit Decimal(const char *const value);
61
63 explicit Decimal(const std::string &value);
64
66 explicit Decimal(const std::string_view value);
67
69 auto operator=(const Decimal &other) -> Decimal &;
70
72 auto operator=(Decimal &&other) noexcept -> Decimal &;
73
75 [[nodiscard]] static auto nan(std::uint64_t payload = 0) -> Decimal;
76
78 [[nodiscard]] static auto snan(std::uint64_t payload = 0) -> Decimal;
79
82 [[nodiscard]] static auto strict_from(double value) -> Decimal;
83
86 [[nodiscard]] static auto exact_from(double value) -> Decimal;
87
89 [[nodiscard]] static auto infinity() -> Decimal;
90
92 [[nodiscard]] static auto negative_infinity() -> Decimal;
93
95 [[nodiscard]] auto to_scientific_string() const -> std::string;
96
98 [[nodiscard]] auto to_string() const -> std::string;
99
101 [[nodiscard]] auto to_int64() const -> std::int64_t;
102
104 [[nodiscard]] auto to_int32() const -> std::int32_t;
105
107 [[nodiscard]] auto to_uint64() const -> std::uint64_t;
108
110 [[nodiscard]] auto to_uint32() const -> std::uint32_t;
111
113 [[nodiscard]] auto to_float() const -> float;
114
116 [[nodiscard]] auto to_double() const -> double;
117
119 [[nodiscard]] auto is_zero() const -> bool;
120
125 [[nodiscard]] auto is_integral() const -> bool;
126
134 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_integer() const -> bool {
135 return (this->flags_ & FLAG_INTEGER_LITERAL) != 0;
136 }
137
139 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_finite() const -> bool {
140 return (this->flags_ & (FLAG_NAN | FLAG_SNAN | FLAG_INFINITE)) == 0;
141 }
142
146 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_real() const -> bool {
147 return this->is_finite() && !this->is_integral();
148 }
149
152 [[nodiscard]] auto is_float() const -> bool;
153
156 [[nodiscard]] auto is_double() const -> bool;
157
159 [[nodiscard]] auto is_int32() const -> bool;
160
162 [[nodiscard]] auto is_int64() const -> bool;
163
165 [[nodiscard]] auto is_uint32() const -> bool;
166
168 [[nodiscard]] auto is_uint64() const -> bool;
169
172 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_nan() const -> bool {
173 return (this->flags_ & FLAG_NAN) != 0;
174 }
175
177 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_snan() const -> bool {
178 return (this->flags_ & FLAG_SNAN) != 0;
179 }
180
182 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_qnan() const -> bool {
183 return (this->flags_ & FLAG_NAN) != 0 && ((this->flags_ & FLAG_SNAN) == 0);
184 }
185
187 [[nodiscard]] SOURCEMETA_FORCEINLINE auto nan_payload() const
188 -> std::uint64_t {
189 assert(this->is_nan());
190 return static_cast<std::uint64_t>(this->coefficient_);
191 }
192
194 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_infinite() const -> bool {
195 return (this->flags_ & FLAG_INFINITE) != 0;
196 }
197
199 [[nodiscard]] SOURCEMETA_FORCEINLINE auto is_signed() const -> bool {
200 return (this->flags_ & FLAG_SIGN) != 0;
201 }
202
204 [[nodiscard]] auto to_integral() const -> Decimal;
205
207 [[nodiscard]] auto divisible_by(const Decimal &divisor) const -> bool;
208
210 [[nodiscard]] auto reduce() const -> Decimal;
211
214 [[nodiscard]] auto trim() const -> Decimal;
215
217 [[nodiscard]] auto logb() const -> Decimal;
218
220 [[nodiscard]] auto scale_by(const Decimal &scale) const -> Decimal;
221
223 [[nodiscard]] auto same_quantum(const Decimal &other) const -> bool;
224
226 [[nodiscard]] auto compare_total(const Decimal &other) const -> Decimal;
227
229 [[nodiscard]] auto divide_integer(const Decimal &other) const -> Decimal;
230
232 auto operator+=(const Decimal &other) -> Decimal &;
233
235 auto operator-=(const Decimal &other) -> Decimal &;
236
238 auto operator*=(const Decimal &other) -> Decimal &;
239
241 auto operator/=(const Decimal &other) -> Decimal &;
242
244 auto operator%=(const Decimal &other) -> Decimal &;
245
247 [[nodiscard]] auto operator+(const Decimal &other) const -> Decimal;
248
250 [[nodiscard]] auto operator-(const Decimal &other) const -> Decimal;
251
253 [[nodiscard]] auto operator*(const Decimal &other) const -> Decimal;
254
256 [[nodiscard]] auto operator/(const Decimal &other) const -> Decimal;
257
259 [[nodiscard]] auto operator%(const Decimal &other) const -> Decimal;
260
262 [[nodiscard]] auto operator-() const -> Decimal;
263
265 [[nodiscard]] auto operator+() const -> Decimal;
266
268 auto operator++() -> Decimal &;
269
271 auto operator++(int) -> Decimal;
272
274 auto operator--() -> Decimal &;
275
277 auto operator--(int) -> Decimal;
278
280 [[nodiscard]] auto operator==(const Decimal &other) const -> bool;
281
283 [[nodiscard]] auto operator!=(const Decimal &other) const -> bool;
284
286 [[nodiscard]] auto operator<(const Decimal &other) const -> bool;
287
289 [[nodiscard]] auto operator<=(const Decimal &other) const -> bool;
290
292 [[nodiscard]] auto operator>(const Decimal &other) const -> bool;
293
295 [[nodiscard]] auto operator>=(const Decimal &other) const -> bool;
296
297private:
298 static constexpr std::uint8_t FLAG_SIGN = 0x01;
299 static constexpr std::uint8_t FLAG_NAN = 0x02;
300 static constexpr std::uint8_t FLAG_SNAN = 0x04;
301 static constexpr std::uint8_t FLAG_INFINITE = 0x08;
302 static constexpr std::uint8_t FLAG_INTEGER_LITERAL = 0x40;
303
304 // Gives up at most the stated number of trailing zeros, lifting the exponent
305 // by one for each, which is what both of the public strips are made of
306 [[nodiscard]] auto remove_trailing_zeros(std::int32_t allowance) const
307 -> Decimal;
308
309 std::int64_t coefficient_{0};
310 std::uint64_t coefficient_high_{0};
311 std::int32_t exponent_{0};
312 std::uint8_t flags_{0};
313};
314
315template <typename T>
316 requires std::integral<T>
317inline auto operator+(const T left, const Decimal &right) -> Decimal {
318 return Decimal{left} + right;
319}
320
321template <typename T>
322 requires std::integral<T>
323inline auto operator-(const T left, const Decimal &right) -> Decimal {
324 return Decimal{left} - right;
325}
326
327template <typename T>
328 requires std::integral<T>
329inline auto operator*(const T left, const Decimal &right) -> Decimal {
330 return Decimal{left} * right;
331}
332
333template <typename T>
334 requires std::integral<T>
335inline auto operator/(const T left, const Decimal &right) -> Decimal {
336 return Decimal{left} / right;
337}
338
339template <typename T>
340 requires std::integral<T>
341inline auto operator%(const T left, const Decimal &right) -> Decimal {
342 return Decimal{left} % right;
343}
344
345template <typename T>
346 requires std::integral<T>
347inline auto operator==(const T left, const Decimal &right) -> bool {
348 return Decimal{left} == right;
349}
350
351template <typename T>
352 requires std::integral<T>
353inline auto operator!=(const T left, const Decimal &right) -> bool {
354 return Decimal{left} != right;
355}
356
357template <typename T>
358 requires std::integral<T>
359inline auto operator<(const T left, const Decimal &right) -> bool {
360 return Decimal{left} < right;
361}
362
363template <typename T>
364 requires std::integral<T>
365inline auto operator<=(const T left, const Decimal &right) -> bool {
366 return Decimal{left} <= right;
367}
368
369template <typename T>
370 requires std::integral<T>
371inline auto operator>(const T left, const Decimal &right) -> bool {
372 return Decimal{left} > right;
373}
374
375template <typename T>
376 requires std::integral<T>
377inline auto operator>=(const T left, const Decimal &right) -> bool {
378 return Decimal{left} >= right;
379}
380
381} // namespace sourcemeta::core
382
383#endif
auto is_double() const -> bool
SOURCEMETA_FORCEINLINE auto is_snan() const -> bool
Check if the decimal number is a signaling NaN.
Definition numeric_decimal.h:177
auto to_double() const -> double
Convert the decimal number to a 64-bit double.
Decimal(const std::string &value)
Construct a decimal number from a C++ string.
Decimal(const char *const value)
Construct a decimal number from a C-string.
auto divide_integer(const Decimal &other) const -> Decimal
Integer division (truncate toward zero).
Decimal(float value)
Construct a decimal number from a 32-bit float.
auto to_uint32() const -> std::uint32_t
Convert the decimal number to a 32-bit unsigned integer.
auto is_uint64() const -> bool
Check if the decimal number fits in a 64-bit unsigned integer.
auto is_uint32() const -> bool
Check if the decimal number fits in a 32-bit unsigned integer.
auto to_string() const -> std::string
Convert the decimal number to a plain string representation.
auto reduce() const -> Decimal
Strip trailing zeros from the coefficient.
SOURCEMETA_FORCEINLINE auto is_signed() const -> bool
Check if the decimal number is signed (negative, including -0).
Definition numeric_decimal.h:199
auto is_int32() const -> bool
Check if the decimal number fits in a 32-bit signed integer.
SOURCEMETA_FORCEINLINE auto is_finite() const -> bool
Check if the decimal number is finite.
Definition numeric_decimal.h:139
SOURCEMETA_FORCEINLINE auto is_real() const -> bool
Definition numeric_decimal.h:146
SOURCEMETA_FORCEINLINE auto is_qnan() const -> bool
Check if the decimal number is a quiet NaN.
Definition numeric_decimal.h:182
auto is_integral() const -> bool
auto is_zero() const -> bool
Check if the decimal number is zero.
SOURCEMETA_FORCEINLINE auto is_integer() const -> bool
Definition numeric_decimal.h:134
auto to_scientific_string() const -> std::string
Convert the decimal number to scientific notation string.
auto is_float() const -> bool
Decimal(const std::string_view value)
Construct a decimal number from a string view.
auto logb() const -> Decimal
Return the adjusted exponent (floor of base-10 logarithm).
static auto exact_from(double value) -> Decimal
auto divisible_by(const Decimal &divisor) const -> bool
Check if this decimal number is divisible by another.
Decimal(const T value)
Construct a decimal number from an unsigned integral type.
Definition numeric_decimal.h:48
Decimal() noexcept
Construct a decimal number initialized to zero.
static auto nan(std::uint64_t payload=0) -> Decimal
Create a quiet NaN (Not a Number) value with an optional payload.
auto to_uint64() const -> std::uint64_t
Convert the decimal number to a 64-bit unsigned integer.
static auto strict_from(double value) -> Decimal
auto same_quantum(const Decimal &other) const -> bool
Check if two numbers have the same quantum (exponent).
SOURCEMETA_FORCEINLINE auto is_nan() const -> bool
Definition numeric_decimal.h:172
SOURCEMETA_FORCEINLINE auto nan_payload() const -> std::uint64_t
Get the payload of a NaN value (0 if no payload).
Definition numeric_decimal.h:187
Decimal(std::int64_t value)
Construct a decimal number from a 64-bit signed integer.
Decimal(double value)
Construct a decimal number from a 64-bit double.
auto to_integral() const -> Decimal
Round the decimal number to an integral value.
auto to_int32() const -> std::int32_t
Convert the decimal number to a 32-bit signed integer.
Decimal(std::uint64_t value)
Construct a decimal number from a 64-bit unsigned integer.
auto compare_total(const Decimal &other) const -> Decimal
IEEE 754 total ordering comparison returning -1, 0, or 1.
static auto negative_infinity() -> Decimal
Create a negative infinity value.
SOURCEMETA_FORCEINLINE auto is_infinite() const -> bool
Check if the decimal number is infinite.
Definition numeric_decimal.h:194
auto trim() const -> Decimal
auto scale_by(const Decimal &scale) const -> Decimal
Scale the number by a power of 10.
static auto infinity() -> Decimal
Create a positive infinity value.
auto to_int64() const -> std::int64_t
Convert the decimal number to a 64-bit signed integer.
static auto snan(std::uint64_t payload=0) -> Decimal
Create a signaling NaN value with an optional payload.
auto to_float() const -> float
Convert the decimal number to a 32-bit float.
auto is_int64() const -> bool
Check if the decimal number fits in a 64-bit signed integer.
Definition numeric_decimal.h:21