uninum 0.1.1

A robust, ergonomic unified number type for Rust with automatic overflow handling, type promotion, and cross-type consistency.
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
//! Comprehensive tests for reference operations in the uninum crate.
//!
//! This module tests reference operation optimizations and ensures proper
//! overflow handling, type promotion, and clone avoidance while maintaining
//! Tests against the standard arithmetic operations.

#[cfg(feature = "decimal")]
use rust_decimal::{Decimal, prelude::ToPrimitive};
use uninum::{Number, num};

// Test basic reference operations optimization for same types
#[test]
fn test_ref_operations_optimization_same_types() {
    let a = Number::from(100_u64);
    let b = Number::from(200_u64);
    let result = &a + &b;
    assert_eq!(result, Number::from(300_u64));

    let c = num!(3.12);
    let d = num!(2.88);
    let result = &c + &d;
    assert_eq!(result, num!(6.0));
}

#[test]
fn test_ref_operations_mixed_types() {
    let int_val = Number::from(42_u64);
    let float_val = num!(3.12);

    let result = &int_val + &float_val;
    assert_eq!(result, num!(45.12));

    let result = &float_val - &int_val;
    assert_eq!(result, num!(-38.88));
}

#[test]
fn test_sub_ref_unsigned_without_promotion() {
    let lhs = Number::from(10u64);
    let rhs = Number::from(3u64);
    let result = &lhs - &rhs;
    assert_eq!(result, Number::from(7u64));
}

// U64 overflow tests
#[test]
fn test_u32_overflow_addition() {
    let a = Number::from(u64::from(u32::MAX));
    let b = Number::from(1_u64);
    let result = &a + &b;
    assert_eq!(result, Number::from(u32::MAX as u64 + 1));

    let result = &a * &Number::from(2_u64);
    assert_eq!(result, Number::from(u32::MAX as u64 * 2));
}

// I64 overflow tests
#[test]
fn test_i32_overflow_scenarios() {
    let i32_max = Number::from(i64::from(i32::MAX));
    let i32_min = Number::from(i64::from(i32::MIN));
    let one = Number::from(1_i64);

    let result = &i32_max + &one;
    assert_eq!(result, Number::from(i32::MAX as i64 + 1));

    let result = &i32_min - &one;
    assert_eq!(result, Number::from(i32::MIN as i64 - 1));
}

// U64 subtraction underflow tests
#[test]
fn test_u32_subtraction_underflow() {
    let small = Number::from(1_000_000_u64);
    let large = Number::from(2_000_000_u64);
    let result = &small - &large;
    assert_eq!(result, Number::from(-1_000_000_i64));
}

// U64 overflow tests
#[test]
#[cfg(feature = "decimal")]
fn test_u64_overflow_to_decimal() {
    let a = Number::from(u64::MAX);
    let b = Number::from(1_u64);
    let result = &a + &b;
    assert!(result.try_get_decimal().is_some());

    if let Some(arc_dec) = result.try_get_decimal() {
        let expected = Decimal::from(u64::MAX) + Decimal::ONE;
        assert_eq!(**arc_dec, expected);
    }
}

#[test]
#[cfg(not(feature = "decimal"))]
fn test_u64_overflow_to_f64_no_decimal() {
    let a = Number::from(u64::MAX);
    let b = Number::from(1_u64);
    let result = &a + &b;
    assert!(result.try_get_f64().is_some());
}

// U64 subtraction underflow tests
#[test]
#[cfg(feature = "decimal")]
fn test_u64_subtraction_underflow() {
    let small = Number::from(1_000_000_000_u64);
    let large = Number::from(2_000_000_000_u64);
    let result = &small - &large;
    assert!(result.try_get_decimal().is_some() || result.try_get_f64().is_some());
}

#[test]
#[cfg(not(feature = "decimal"))]
fn test_u64_subtraction_underflow_no_decimal() {
    let small = Number::from(1_000_000_000_u64);
    let large = Number::from(2_000_000_000_u64);
    let result = &small - &large;
    assert!(result.try_get_f64().is_some());
}

// I64 overflow tests
#[test]
#[cfg(feature = "decimal")]
fn test_i64_overflow_to_decimal() {
    let i64_max = Number::from(i64::MAX);
    let i64_min = Number::from(i64::MIN);
    let one = Number::from(1_i64);

    let result = &i64_max + &one;
    assert!(result.try_get_decimal().is_some());

    let result = &i64_min - &one;
    assert!(result.try_get_decimal().is_some());
}

#[test]
#[cfg(not(feature = "decimal"))]
fn test_i64_overflow_to_f64_no_decimal() {
    let i64_max = Number::from(i64::MAX);
    let one = Number::from(1_i64);
    let result = &i64_max + &one;
    assert!(result.try_get_f64().is_some());
}

// F64 special values tests
#[test]
fn test_f64_special_values() {
    let nan = num!(f64::NAN);
    let inf = num!(f64::INFINITY);
    let normal = num!(42.0);

    let result = &nan + &normal;
    assert!(result.is_nan());

    let result = &inf + &normal;
    assert!(result.is_infinite() && result.is_pos_inf());
}

// Decimal tests
#[cfg(feature = "decimal")]
#[test]
fn test_decimal_operations() {
    let a = Number::from(Decimal::new(312, 2)); // 3.12
    let b = Number::from(Decimal::new(288, 2)); // 2.88
    let result = &a + &b;

    if let Some(arc_dec) = result.try_get_decimal() {
        assert_eq!(**arc_dec, Decimal::new(600, 2)); // 6.00
    }

    let int_val = Number::from(2_u64);
    let result = &a + &int_val;
    assert!(result.try_get_decimal().is_some() || result.try_get_f64().is_some());
}

#[cfg(feature = "decimal")]
#[test]
fn test_decimal_overflow_to_f64() {
    let max_decimal = Number::from(Decimal::MAX);
    let two = Number::from(Decimal::from(2));

    let result = &max_decimal + &two;
    assert!(result.try_get_f64().is_some());

    let result = &max_decimal * &two;
    assert!(result.try_get_f64().is_some());
}

// Boundary condition tests
#[test]
fn test_boundary_conditions() {
    // U64: near max operations
    let u32_near_max = Number::from(u64::from(u32::MAX - 1));
    let u32_one = Number::from(1_u64);
    let result = &u32_near_max + &u32_one;
    assert_eq!(result, Number::from(u64::from(u32::MAX)));

    let u32_two = Number::from(2_u64);
    let result = &u32_near_max + &u32_two;
    assert_eq!(result, Number::from(u32::MAX as u64 + 1));

    // I64: near min operations
    let i32_near_min = Number::from(i64::from(i32::MIN + 1));
    let i32_one = Number::from(1_i64);
    let result = &i32_near_min - &i32_one;
    assert_eq!(result, Number::from(i64::from(i32::MIN)));

    let i32_two = Number::from(2_i64);
    let result = &i32_near_min - &i32_two;
    assert_eq!(result, Number::from(i32::MIN as i64 - 1));
}

// Mixed type operations
#[test]
fn test_mixed_type_operations() {
    let int_val = Number::from(100_i64);
    let float_val = num!(42.5);

    let result = &int_val - &float_val;
    assert_eq!(result, num!(57.5));

    let u_val = Number::from(50_u64);
    let i_val = Number::from(-25_i64);
    let result = &u_val - &i_val;
    assert_eq!(result, Number::from(75_i64));
}

// Primitive reference operations tests
#[test]
fn test_operations_with_primitive_references() {
    let number_val = Number::from(42_i64);
    let primitive_val = 10i32;
    let primitive_ref = &primitive_val;

    // &primitive + &Number
    let result = primitive_ref + &number_val;
    assert_eq!(result, Number::from(52_i64));

    // &Number + &primitive
    let result = &number_val + primitive_ref;
    assert_eq!(result, Number::from(52_i64));

    // Subtraction
    let result = primitive_ref - &number_val;
    assert_eq!(result, Number::from(-32_i64));

    let result = &number_val - primitive_ref;
    assert_eq!(result, Number::from(32_i64));

    // Multiplication
    let result = primitive_ref * &number_val;
    assert_eq!(result, Number::from(420_i64));

    let result = &number_val * primitive_ref;
    assert_eq!(result, Number::from(420_i64));
}

#[test]
fn test_different_primitive_types() {
    let u32_number = Number::from(100_u64);
    let f64_number = num!(3.16);

    let i32_primitive = 50i32;
    let f64_primitive = 2.5f64;
    let u64_primitive = 200u64;

    let result = &u32_number + i32_primitive;
    assert_eq!(result, Number::from(150_i64));

    let result = &f64_number * f64_primitive;
    assert!(result.approx_eq(&num!(7.9), 1e-15, 0.0));

    let result = u64_primitive - &u32_number;
    assert_eq!(result, Number::from(100_u64));
}

// Division operations tests
#[test]
fn test_division_operations() {
    let number_val = Number::from(84_i64);
    let primitive_val = 4i32;

    // Integer division
    let result = &number_val / primitive_val;
    assert_eq!(result, Number::from(21_i64));

    #[cfg(feature = "decimal")]
    {
        let result = primitive_val / &number_val;
        assert!(result.try_get_decimal().is_some());
    }

    #[cfg(not(feature = "decimal"))]
    {
        let result = primitive_val / &number_val;
        // Division with integers promotes to float
        assert_eq!(result, num!(4.0 / 84.0));
    }

    // Float division
    let float_number = num!(10.5);
    let float_primitive = 2.5f64;

    let result = &float_number / float_primitive;
    assert_eq!(result, num!(4.2));

    let result = float_primitive / &float_number;
    // Result may be Decimal or F64 depending on internal promotion logic
    let expected_value = 2.5 / 10.5;

    if let Some(result_f64) = result.try_get_f64() {
        assert!((result_f64 - expected_value).abs() < 1e-15);
    } else {
        #[cfg(feature = "decimal")]
        {
            if let Some(result_decimal) = result.try_get_decimal() {
                // Convert decimal to f64 for comparison
                let result_f64 = result_decimal.to_f64().unwrap_or(0.0);
                assert!((result_f64 - expected_value).abs() < 1e-15);
            } else {
                panic!("Expected result to be F64 or Decimal");
            }
        }
        #[cfg(not(feature = "decimal"))]
        {
            panic!("Expected result to be F64");
        }
    }
}

// Test that reference operations fall back correctly for unsupported
// combinations
#[test]
fn test_reference_arithmetic_trait_coverage() {
    let lhs = Number::from(9i64);
    let rhs = Number::from(3i64);
    let four = Number::from(4i64);

    assert_eq!((&lhs) - &rhs, Number::from(6i64));
    assert_eq!(lhs.clone() - &rhs, Number::from(6i64));
    assert_eq!((&lhs) - rhs.clone(), Number::from(6i64));

    assert_eq!((&lhs) * &four, Number::from(36i64));
    assert_eq!(lhs.clone() * &four, Number::from(36i64));
    assert_eq!((&lhs) * four.clone(), Number::from(36i64));

    assert_eq!((&lhs) / &rhs, Number::from(3i64));
    assert_eq!(lhs.clone() / &rhs, Number::from(3i64));
    assert_eq!((&lhs) / rhs.clone(), Number::from(3i64));

    assert_eq!((&lhs) % &rhs, Number::from(0i64));
    assert_eq!(lhs.clone() % &rhs, Number::from(0i64));
    assert_eq!((&lhs) % rhs, Number::from(0i64));
}

#[test]
fn test_fallback_to_clone_add() {
    let a = Number::from(42_u64);
    let b = num!(3.16);
    let result = &a + &b;

    // Should equal clone + add result
    let expected = a.clone() + b.clone();
    assert_eq!(result, expected);
}

// Test the decimal overflow path that falls back to F64
#[test]
#[cfg(feature = "decimal")]
fn test_sub_ref_decimal_overflow_falls_back_to_f64() {
    let max_decimal = Number::from(Decimal::MAX);
    let negative_one = Number::from(Decimal::new(-1, 0));

    let result = &max_decimal - &negative_one;
    assert!(
        result.try_get_decimal().is_none(),
        "overflowing subtraction should not stay Decimal"
    );
    assert!(
        result.try_get_f64().is_some(),
        "overflowing subtraction should fall back to F64"
    );
}

// Test the decimal overflow path that falls back to F64
#[test]
#[cfg(feature = "decimal")]
fn test_u64_multiplication_decimal_overflow_to_f64() {
    // This tests the specific code path where:
    // 1. U64 * U64 overflows u64
    // 2. Decimal::from(u64) * Decimal::from(u64) ALSO overflows
    // 3. Falls back to F64

    // u64::MAX * u64::MAX overflows both u64 AND Decimal
    let a = Number::from(u64::MAX);
    let b = Number::from(u64::MAX);
    let result = &a * &b;

    // Should fall back to F64 because Decimal can't represent u64::MAX^2
    assert!(result.try_get_f64().is_some());

    if let Some(f) = result.try_get_f64() {
        // u64::MAX * u64::MAX ≈ 3.4 × 10^38
        let expected = (u64::MAX as f64) * (u64::MAX as f64);
        assert_eq!(f, expected);
    }
}

// Test i64 multiplication that overflows both i64 AND Decimal
#[test]
#[cfg(feature = "decimal")]
fn test_i64_multiplication_decimal_overflow_to_f64() {
    // i64::MAX * i64::MAX ≈ 8.5 × 10^37 which exceeds Decimal::MAX
    let a = Number::from(i64::MAX);
    let b = Number::from(i64::MAX);
    let result = &a * &b;

    // Should fall back to F64 because Decimal can't represent i64::MAX^2
    assert!(result.try_get_f64().is_some());

    if let Some(f) = result.try_get_f64() {
        let expected = (i64::MAX as f64) * (i64::MAX as f64);
        assert_eq!(f, expected);
    }
}