decimal-scaled 0.3.2

Const-generic base-10 fixed-point decimals (D9/D18/D38/D76/D153/D307) with integer-only transcendentals correctly rounded to within 0.5 ULP — exact at the type's last representable place. Deterministic across every platform; no_std-friendly.
Documentation
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
#![cfg(feature = "macros")]
//! Integration tests for the `d38!` proc-macro.
//!
//! See `macros/README.md` for the macro spec. This corpus covers
//! decimal literals (positive / negative, fractional, underscore
//! separators), scientific notation, the `scale N` and `rounded`
//! qualifiers, and the compile-time error path when a literal is
//! lossy without `rounded`.

use decimal_scaled::{D38, D38s0, D38s2, D38s5, D38s6, D38s12, d38};

// --- Auto-scale inference --------------------------------------------

#[test]
fn auto_scale_inference_simple() {
    let v = d38!(1.23);
    assert_eq!(v, D38s2::from_bits(123));
}

#[test]
fn auto_scale_inference_integer() {
    let v = d38!(123);
    assert_eq!(v, D38s0::from_bits(123));
}

#[test]
fn auto_scale_inference_zero_fractional() {
    let v = d38!(1.0);
    assert_eq!(v, D38::<1>::from_bits(10));
}

#[test]
fn auto_scale_inference_trailing_zero_preserved() {
    let v = d38!(1.230);
    assert_eq!(v, D38::<3>::from_bits(1230));
}

#[test]
fn auto_scale_inference_leading_zero_after_dot() {
    let v = d38!(0.001);
    assert_eq!(v, D38::<3>::from_bits(1));
}

#[test]
fn auto_scale_inference_negative() {
    let v = d38!(-1.23);
    assert_eq!(v, D38s2::from_bits(-123));
}

#[test]
fn auto_scale_inference_with_underscores() {
    let v = d38!(1_234.567_89);
    assert_eq!(v, D38s5::from_bits(123_456_789));
}

// --- Scientific notation ---------------------------------------------

#[test]
fn sci_simple() {
    // 1.5e3 = 1500; mantissa scale 1, exponent 3 -> natural scale = max(0, 1-3) = 0.
    let v = d38!(1.5e3);
    assert_eq!(v, D38s0::from_bits(1500));
}

#[test]
fn sci_negative_exponent() {
    // 1.5e-3 = 0.0015; mantissa scale 1, exponent -3 -> natural scale = 4.
    let v = d38!(1.5e-3);
    assert_eq!(v, D38::<4>::from_bits(15));
}

#[test]
fn sci_zero_exponent() {
    let v = d38!(1.5e0);
    assert_eq!(v, D38::<1>::from_bits(15));
}

#[test]
fn sci_integer_with_exponent() {
    // 1e6 = 1_000_000; mantissa scale 0, exponent 6 -> natural scale 0,
    // digits padded by 6 zeros.
    let v = d38!(1e6);
    assert_eq!(v, D38s0::from_bits(1_000_000));
}

#[test]
fn sci_trailing_zero_mantissa() {
    // 1.500e2 = 150.0; mantissa scale 3, exponent 2 -> natural scale 1.
    let v = d38!(1.500e2);
    assert_eq!(v, D38::<1>::from_bits(1500));
}

#[test]
fn sci_negative_value() {
    let v = d38!(-2.5e-2);
    assert_eq!(v, D38::<3>::from_bits(-25));
}

// --- `scale N` qualifier ---------------------------------------------

#[test]
fn explicit_scale_up_pads_with_zeros() {
    let v = d38!(1.23, scale 4);
    assert_eq!(v, D38::<4>::from_bits(12_300));
}

#[test]
fn explicit_scale_equal_is_identity() {
    let v = d38!(1.23, scale 2);
    assert_eq!(v, D38s2::from_bits(123));
}

#[test]
fn explicit_scale_zero_on_integer() {
    let v = d38!(42, scale 0);
    assert_eq!(v, D38s0::from_bits(42));
}

#[test]
fn explicit_scale_with_sci_notation() {
    // 1.5e3 = 1500 (natural scale 0); explicit scale 5 -> pad with 5 zeros.
    let v = d38!(1.5e3, scale 5);
    assert_eq!(v, D38::<5>::from_bits(150_000_000));
}

// --- `rounded` qualifier ---------------------------------------------

#[test]
fn rounded_half_to_even_below_half() {
    // 1.234999 at scale 2 -> 1.23 (below half).
    let v = d38!(1.234999, scale 2, rounded);
    assert_eq!(v, D38s2::from_bits(123));
}

#[test]
fn rounded_half_to_even_above_half() {
    // 1.235001 at scale 2 -> 1.24 (above half).
    let v = d38!(1.235001, scale 2, rounded);
    assert_eq!(v, D38s2::from_bits(124));
}

#[test]
fn rounded_half_to_even_exact_half_ties_to_even() {
    // 1.235 at scale 2 -> 1.24 (tie, 4 is even).
    let v = d38!(1.235, scale 2, rounded);
    assert_eq!(v, D38s2::from_bits(124));

    // 1.225 at scale 2 -> 1.22 (tie, 2 is even).
    let v = d38!(1.225, scale 2, rounded);
    assert_eq!(v, D38s2::from_bits(122));
}

#[test]
fn rounded_negative_value() {
    let v = d38!(-1.235, scale 2, rounded);
    assert_eq!(v, D38s2::from_bits(-124));
}

// --- More named precision tiers --------------------------------------

#[test]
fn explicit_scale_to_max_supported() {
    let v = d38!(1, scale 38);
    assert_eq!(v.to_bits(), 10_i128.pow(38));
}

#[test]
fn primary_alias_d38s12() {
    let v = d38!(1.500_000_000_000);
    assert_eq!(v, D38s12::from_bits(1_500_000_000_000));
}

#[test]
fn financial_cents() {
    let v = d38!(0.50);
    assert_eq!(v, D38s2::from_bits(50));
}

#[test]
fn satoshi_grade() {
    // 0.123_456_78 at scale 8.
    let v = d38!(0.123_456_78);
    assert_eq!(v, D38::<8>::from_bits(12_345_678));
}

#[test]
fn small_value_via_sci() {
    let v = d38!(1e-9);
    assert_eq!(v, D38::<9>::from_bits(1));
}

#[test]
fn six_digit_micro() {
    let v = d38!(1.234_567, scale 6);
    assert_eq!(v, D38s6::from_bits(1_234_567));
}

// --- Inline expressions ---------------------------------------------

#[test]
fn expression_simple_arithmetic() {
    let v = d38!(10 * 12 + 3, scale 0);
    assert_eq!(v, D38s0::from_bits(123));
}

#[test]
fn expression_with_scale_factor() {
    // Scale 4 means each input unit becomes 10_000 bits.
    let v = d38!(5, scale 4);
    assert_eq!(v, D38::<4>::from_bits(50_000));
}

#[test]
fn expression_with_variable() {
    let x: i128 = 42;
    let v = d38!(x, scale 2);
    assert_eq!(v, D38s2::from_bits(4_200));
}

#[test]
fn expression_with_const() {
    const N: i128 = 100;
    let v = d38!(N + 23, scale 2);
    assert_eq!(v, D38s2::from_bits(12_300));
}

#[test]
fn expression_function_call() {
    fn produce() -> i128 {
        7
    }
    let v = d38!(produce() * 2, scale 0);
    assert_eq!(v, D38s0::from_bits(14));
}

#[test]
fn expression_negative_result() {
    let v = d38!(0 - 5, scale 2);
    assert_eq!(v, D38s2::from_bits(-500));
}

#[test]
fn expression_const_context_works() {
    const N: i128 = 42;
    const V: D38s2 = d38!(N * 3, scale 2);
    assert_eq!(V, D38s2::from_bits(12_600));
}

// ── Per-width entry points: narrow tiers ──────────────────────────────

#[test]
fn d9_literal_inferred_scale() {
    use decimal_scaled::{d9, D9s2};
    let v = d9!(1.23);
    assert_eq!(v, D9s2::from_bits(123));
}

#[test]
fn d9_max_scale_9() {
    use decimal_scaled::{d9, D9s9};
    let v = d9!(0.000_000_001);  // raw 1 at scale 9
    assert_eq!(v, D9s9::from_bits(1));
}

#[test]
fn d18_literal_inferred_scale() {
    use decimal_scaled::{d18, D18s4};
    let v = d18!(1234.5678);
    assert_eq!(v, D18s4::from_bits(12_345_678));
}

#[test]
fn d18_explicit_scale_pad() {
    use decimal_scaled::{d18, D18s9};
    let v = d18!(1.5, scale 9);
    assert_eq!(v, D18s9::from_bits(1_500_000_000));
}

#[test]
fn d18_expression_form() {
    use decimal_scaled::{d18, D18s4};
    let raw: i64 = 12345;
    let v = d18!(raw, scale 4);
    assert_eq!(v.to_bits(), 12345i64 * 10_000);
    let _: D18s4 = v;
}

// ── Per-width entry points: wide tiers ────────────────────────────────

#[cfg(feature = "wide")]
#[test]
fn d76_literal_inferred_scale() {
    use decimal_scaled::{d76, D76s2};
    let v: D76s2 = d76!(1.23);
    assert_eq!(v.to_string(), "1.23");
}

#[cfg(feature = "wide")]
#[test]
fn d76_explicit_scale() {
    use decimal_scaled::{d76, D76s12};
    let v: D76s12 = d76!(0.000_000_000_001);  // scale 12 inferred and matched
    assert_eq!(v.to_string(), "0.000000000001");
}

#[cfg(feature = "wide")]
#[test]
fn d153_literal_inferred() {
    use decimal_scaled::{d153, D153s35};
    // Use a value whose natural scale matches the alias.
    let v: D153s35 = d153!(2.71828182845904523536028747135266250);
    assert!(v.to_string().starts_with("2.71828182845904523536028747"));
}

#[cfg(feature = "wide")]
#[test]
fn d307_literal_inferred() {
    use decimal_scaled::{d307, D307s35};
    let v: D307s35 = d307!(3.14159265358979323846264338327950288);
    assert!(v.to_string().starts_with("3.14159265358979323846264338327950288"));
}

// ── Per-scale wrapper macros ──────────────────────────────────────────

#[test]
fn d9_per_scale_wrapper_d9s2() {
    use decimal_scaled::{d9s2, D9s2};
    let v: D9s2 = d9s2!(1.23);
    assert_eq!(v, D9s2::from_bits(123));
}

#[test]
fn d18_per_scale_wrapper_d18s12() {
    use decimal_scaled::{d18s12, D18s12};
    let v: D18s12 = d18s12!(1.5);
    assert_eq!(v, D18s12::from_bits(1_500_000_000_000));
}

#[test]
fn d38_per_scale_wrapper_d38s12() {
    use decimal_scaled::{d38s12, D38s12};
    let v: D38s12 = d38s12!(1.5);
    assert_eq!(v, D38s12::from_bits(1_500_000_000_000));
}

#[test]
fn d38_per_scale_wrapper_forwards_qualifiers() {
    use decimal_scaled::{d38s2, D38s2};
    // Scale 2 is pre-baked; `rounded` is forwarded as a tail
    // qualifier.
    let v: D38s2 = d38s2!(1.234_567, rounded);
    assert_eq!(v, D38s2::from_bits(123));
}

#[cfg(feature = "wide")]
#[test]
fn d76_per_scale_wrapper_d76s35() {
    use decimal_scaled::{d76s35, D76s35};
    let v: D76s35 = d76s35!(1.5);
    // 1.5 at scale 35 = 1.5 * 10^35.
    assert_eq!(v.to_string(), "1.50000000000000000000000000000000000");
}

// ── Radix-prefixed literals ───────────────────────────────────────────

#[test]
fn d38_hex_prefix_integer() {
    use decimal_scaled::{d38, D38s0};
    // 0xFF == 255 — scale defaults to 0 for radix-prefixed integers.
    let v: D38s0 = d38!(0xFF);
    assert_eq!(v.to_bits(), 255);
}

#[test]
fn d38_oct_prefix_integer() {
    use decimal_scaled::{d38, D38s0};
    let v: D38s0 = d38!(0o755);  // == 493
    assert_eq!(v.to_bits(), 493);
}

#[test]
fn d38_bin_prefix_integer() {
    use decimal_scaled::{d38, D38s0};
    let v: D38s0 = d38!(0b1010_0110);  // == 166
    assert_eq!(v.to_bits(), 166);
}

#[test]
fn d38_hex_with_explicit_scale() {
    use decimal_scaled::{d38, D38s2};
    let v: D38s2 = d38!(0x7B, scale 2);  // 123 at scale 2 = 1.23
    assert_eq!(v.to_string(), "1.23");
}

#[test]
fn d38_explicit_radix_qualifier() {
    use decimal_scaled::{d38, D38s0};
    let v: D38s0 = d38!(123, radix 8);  // octal: 1*64 + 2*8 + 3 = 83
    assert_eq!(v.to_bits(), 83);
}

#[cfg(feature = "wide")]
#[test]
fn d76_hex_prefix() {
    use decimal_scaled::{d76, D76s0};
    let v: D76s0 = d76!(0xDEAD_BEEF);
    assert_eq!(v.to_string(), "3735928559");
}

// ── Fractional radix literals ─────────────────────────────────────────

#[test]
fn d38_hex_fractional_literal() {
    use decimal_scaled::{d38, D38};
    // 1.A3 in hex = 0x1A3 magnitude = 419. The decimal point split
    // gives 2 hex fractional digits. Scale must be supplied — the
    // bits ARE the parsed magnitude (no scale shift).
    let v: D38<2> = d38!(1.A3, radix 16, scale 2);
    assert_eq!(v.to_bits(), 419);
}

#[test]
fn d38_bin_fractional_literal() {
    use decimal_scaled::{d38, D38};
    // 11.0110 in binary = 0b110110 = 54. Stored at scale 4 → 0.0054.
    let v: D38<4> = d38!(11.0110, radix 2, scale 4);
    assert_eq!(v.to_bits(), 54);
}

#[test]
fn d38_oct_fractional_literal() {
    use decimal_scaled::{d38, D38};
    // 17.3 in octal: digits "173" in base 8 = 1*64 + 7*8 + 3 = 123.
    let v: D38<2> = d38!(17.3, radix 8, scale 2);
    assert_eq!(v.to_bits(), 123);
}

#[test]
fn d38_negative_hex_fractional() {
    use decimal_scaled::{d38, D38};
    let v: D38<2> = d38!(-1.A3, radix 16, scale 2);
    assert_eq!(v.to_bits(), -419);
}

#[test]
fn d38_hex_fractional_ident_dot_ident() {
    use decimal_scaled::{d38, D38};
    // `FF.AA` in radix 16: Rust tokenises both halves as idents
    // (no leading digit on either side). Magnitude in base 16 is
    // 0xFFAA = 65450.
    let v: D38<2> = d38!(FF.AA, radix 16, scale 2);
    assert_eq!(v.to_bits(), 65450);
}

#[test]
fn d38_hex_fractional_int_dot_ident() {
    use decimal_scaled::{d38, D38};
    // `7.AB` in radix 16: 7 is an Int literal, AB an Ident.
    // 0x7AB = 1963.
    let v: D38<3> = d38!(7.AB, radix 16, scale 3);
    assert_eq!(v.to_bits(), 1963);
}

#[test]
fn d38_hex_fractional_ident_dot_int() {
    use decimal_scaled::{d38, D38};
    // `AB.7` in radix 16: AB is an Ident, 7 is an Int literal.
    // 0xAB7 = 2743.
    let v: D38<3> = d38!(AB.7, radix 16, scale 3);
    assert_eq!(v.to_bits(), 2743);
}

#[test]
fn d38_hex_integer_only_radix() {
    use decimal_scaled::{d38, D38};
    // Bare IDENT (no prefix, no dot) under explicit `radix 16`.
    let v: D38<0> = d38!(BEEF, radix 16);
    assert_eq!(v.to_bits(), 0xBEEF);
}