clock-curve-math 1.1.3

High-performance, constant-time, cryptography-grade number theory library for ClockCurve ecosystem
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
//! Comprehensive tests for batch field operations.
//!
//! This module tests the batch inversion and other batch operations
//! for efficient cryptographic computations.

use clock_curve_math::{FieldElement, FieldOps, MathError, field::batch_ops::*};

#[cfg(feature = "alloc")]
mod batch_inverse_tests {
    use super::*;

    #[test]
    fn test_batch_inverse_empty_input() {
        let result = batch_inverse(&[]).unwrap();
        assert!(result.is_empty());
        assert_eq!(result.len(), 0);
        assert_eq!(result.into_vec().len(), 0);
    }

    #[test]
    fn test_batch_inverse_single_element() {
        let element = FieldElement::from_u64(42);
        let result = batch_inverse(&[element]).unwrap();

        assert_eq!(result.len(), 1);
        assert_eq!(element.mul(result.get(0)), FieldElement::from_u64(1));

        // Test into_vec consumes the result
        let vec = result.into_vec();
        assert_eq!(vec.len(), 1);
        assert_eq!(element.mul(&vec[0]), FieldElement::from_u64(1));
    }

    #[test]
    fn test_batch_inverse_single_zero() {
        let zero = FieldElement::from_u64(0);
        let result = batch_inverse(&[zero]);
        assert!(result.is_none());
    }

    #[test]
    fn test_batch_inverse_two_elements() {
        let a = FieldElement::from_u64(2);
        let b = FieldElement::from_u64(3);

        let result = batch_inverse(&[a, b]).unwrap();
        assert_eq!(result.len(), 2);

        // Verify correctness: a * inv(a) ≡ 1 mod p
        assert_eq!(a.mul(result.get(0)), FieldElement::from_u64(1));
        assert_eq!(b.mul(result.get(1)), FieldElement::from_u64(1));

        // Verify they are actual inverses
        assert_eq!(*result.get(0), a.inv());
        assert_eq!(*result.get(1), b.inv());
    }

    #[test]
    fn test_batch_inverse_three_elements() {
        let elements = [
            FieldElement::from_u64(2),
            FieldElement::from_u64(3),
            FieldElement::from_u64(5),
        ];

        let result = batch_inverse(&elements).unwrap();
        assert_eq!(result.len(), 3);

        for (i, elem) in elements.iter().enumerate() {
            assert_eq!(elem.mul(result.get(i)), FieldElement::from_u64(1));
        }
    }

    #[test]
    fn test_batch_inverse_large_batch() {
        let elements: Vec<FieldElement> = (1..=20).map(|i| FieldElement::from_u64(i + 1)).collect();

        let result = batch_inverse(&elements).unwrap();
        assert_eq!(result.len(), 20);

        for (i, elem) in elements.iter().enumerate() {
            assert_eq!(elem.mul(result.get(i)), FieldElement::from_u64(1));
        }
    }

    #[test]
    fn test_batch_inverse_with_zero_anywhere() {
        let elements = vec![
            FieldElement::from_u64(2),
            FieldElement::from_u64(0), // Zero in middle
            FieldElement::from_u64(3),
        ];

        let result = batch_inverse(&elements);
        assert!(result.is_none());
    }

    #[test]
    fn test_batch_inverse_all_same_element() {
        let element = FieldElement::from_u64(7);
        let elements = vec![element; 5];

        let result = batch_inverse(&elements).unwrap();
        assert_eq!(result.len(), 5);

        for inv in result.inverses.iter() {
            assert_eq!(element.mul(inv), FieldElement::from_u64(1));
        }
    }

    #[test]
    fn test_batch_inverse_montgomery_algorithm_correctness() {
        // Test that the Montgomery algorithm produces correct results
        // by comparing with individual inversions
        let elements = vec![
            FieldElement::from_u64(2),
            FieldElement::from_u64(3),
            FieldElement::from_u64(5),
            FieldElement::from_u64(7),
            FieldElement::from_u64(11),
        ];

        let batch_result = batch_inverse(&elements).unwrap();

        // Compare with individual inversions
        for (i, elem) in elements.iter().enumerate() {
            let individual_inv = elem.inv();
            assert_eq!(*batch_result.get(i), individual_inv);
        }
    }

    #[test]
    fn test_batch_inverse_order_preservation() {
        let elements = vec![
            FieldElement::from_u64(13),
            FieldElement::from_u64(17),
            FieldElement::from_u64(19),
            FieldElement::from_u64(23),
        ];

        let result = batch_inverse(&elements).unwrap();

        // Verify that results are in the same order as inputs
        assert_eq!(elements[0].mul(result.get(0)), FieldElement::from_u64(1));
        assert_eq!(elements[1].mul(result.get(1)), FieldElement::from_u64(1));
        assert_eq!(elements[2].mul(result.get(2)), FieldElement::from_u64(1));
        assert_eq!(elements[3].mul(result.get(3)), FieldElement::from_u64(1));
    }

    #[test]
    fn test_batch_inverse_result_clone() {
        let elements = vec![FieldElement::from_u64(2), FieldElement::from_u64(3)];
        let original = batch_inverse(&elements).unwrap();
        let cloned = original.clone();

        assert_eq!(original.len(), cloned.len());
        assert_eq!(original.inverses, cloned.inverses);
    }

    #[test]
    fn test_batch_inverse_result_debug() {
        let elements = vec![FieldElement::from_u64(2)];
        let result = batch_inverse(&elements).unwrap();

        let debug_str = format!("{:?}", result);
        assert!(debug_str.contains("BatchInverseResult"));
        // Don't check exact format as it may vary
    }
}

#[cfg(feature = "alloc")]
mod batch_inverse_checked_tests {
    use super::*;

    #[test]
    fn test_batch_inverse_checked_empty() {
        let result = batch_inverse_checked(&[]);
        assert!(result.is_ok());
        assert!(result.unwrap().is_empty());
    }

    #[test]
    fn test_batch_inverse_checked_valid_elements() {
        let elements = vec![
            FieldElement::from_u64(2),
            FieldElement::from_u64(3),
            FieldElement::from_u64(5),
        ];

        let result = batch_inverse_checked(&elements).unwrap();
        assert_eq!(result.len(), 3);

        for (i, elem) in elements.iter().enumerate() {
            assert_eq!(elem.mul(result.get(i)), FieldElement::from_u64(1));
        }
    }

    #[test]
    fn test_batch_inverse_checked_with_zero() {
        let elements = vec![
            FieldElement::from_u64(2),
            FieldElement::from_u64(0),
            FieldElement::from_u64(3),
        ];

        let result = batch_inverse_checked(&elements);
        assert!(result.is_err());
        assert_eq!(result.unwrap_err(), MathError::DivisionByZero);
    }

    #[test]
    fn test_batch_inverse_checked_single_zero() {
        let result = batch_inverse_checked(&[FieldElement::from_u64(0)]);
        assert!(result.is_err());
        assert_eq!(result.unwrap_err(), MathError::DivisionByZero);
    }
}

#[cfg(feature = "alloc")]
mod batch_inverse_small_tests {
    use super::*;

    #[test]
    fn test_batch_inverse_small_empty() {
        let result = batch_inverse_small(&[]).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn test_batch_inverse_small_single() {
        let element = FieldElement::from_u64(7);
        let result = batch_inverse_small(&[element]).unwrap();

        assert_eq!(result.len(), 1);
        assert_eq!(element.mul(result.get(0)), FieldElement::from_u64(1));
    }

    #[test]
    fn test_batch_inverse_small_single_zero() {
        let result = batch_inverse_small(&[FieldElement::from_u64(0)]);
        assert!(result.is_none());
    }

    #[test]
    fn test_batch_inverse_small_two_elements() {
        let a = FieldElement::from_u64(2);
        let b = FieldElement::from_u64(3);

        let result = batch_inverse_small(&[a, b]).unwrap();
        assert_eq!(result.len(), 2);

        assert_eq!(a.mul(result.get(0)), FieldElement::from_u64(1));
        assert_eq!(b.mul(result.get(1)), FieldElement::from_u64(1));
    }

    #[test]
    fn test_batch_inverse_small_two_with_zero() {
        let result = batch_inverse_small(&[FieldElement::from_u64(2), FieldElement::from_u64(0)]);
        assert!(result.is_none());

        let result2 = batch_inverse_small(&[FieldElement::from_u64(0), FieldElement::from_u64(3)]);
        assert!(result2.is_none());
    }

    #[test]
    fn test_batch_inverse_small_three_elements() {
        let elements = [
            FieldElement::from_u64(2),
            FieldElement::from_u64(3),
            FieldElement::from_u64(5),
        ];

        let result = batch_inverse_small(&elements).unwrap();
        assert_eq!(result.len(), 3);

        for (i, elem) in elements.iter().enumerate() {
            assert_eq!(elem.mul(result.get(i)), FieldElement::from_u64(1));
        }
    }

    #[test]
    fn test_batch_inverse_small_large_batch() {
        // For batches > 3, should fall back to general algorithm
        let elements: Vec<FieldElement> = (1..=10).map(|i| FieldElement::from_u64(i + 1)).collect();

        let result = batch_inverse_small(&elements).unwrap();
        assert_eq!(result.len(), 10);

        for (i, elem) in elements.iter().enumerate() {
            assert_eq!(elem.mul(result.get(i)), FieldElement::from_u64(1));
        }
    }
}

#[cfg(feature = "alloc")]
mod performance_and_correctness_tests {
    use super::*;

    #[test]
    fn test_batch_inverse_correctness_comprehensive() {
        // Test with various element values to ensure correctness
        let test_values = [
            1u64, 2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67,
        ];

        let elements: Vec<FieldElement> = test_values
            .iter()
            .map(|&v| FieldElement::from_u64(v))
            .collect();

        let result = batch_inverse(&elements).unwrap();
        assert_eq!(result.len(), test_values.len());

        for (i, &expected_value) in test_values.iter().enumerate() {
            let elem = FieldElement::from_u64(expected_value);
            assert_eq!(elem.mul(result.get(i)), FieldElement::from_u64(1));
        }
    }

    #[test]
    fn test_batch_inverse_consistency_with_individual() {
        // Test that batch inversion gives same results as individual inversion
        let elements = vec![
            FieldElement::from_u64(2),
            FieldElement::from_u64(7),
            FieldElement::from_u64(11),
            FieldElement::from_u64(13),
        ];

        let batch_result = batch_inverse(&elements).unwrap();

        // Compare with individual inversions
        let individual_inverses: Vec<FieldElement> = elements.iter().map(|e| e.inv()).collect();

        for (i, individual_inv) in individual_inverses.iter().enumerate() {
            assert_eq!(*batch_result.get(i), *individual_inv);
        }
    }

    #[test]
    fn test_batch_inverse_mathematical_properties() {
        let a = FieldElement::from_u64(3);
        let b = FieldElement::from_u64(5);

        let result = batch_inverse(&[a, b]).unwrap();

        let inv_a = result.get(0);
        let inv_b = result.get(1);

        // Test: inv(a * b) = inv(b) * inv(a)
        let product = a.mul(&b);
        let inv_product = product.inv();
        let inv_b_times_inv_a = inv_b.mul(inv_a);

        assert_eq!(inv_product, inv_b_times_inv_a);

        // Test: inv(a)^2 = inv(a^2)
        let inv_a_squared = inv_a.mul(inv_a);
        let a_squared = a.mul(&a);
        let inv_a_squared_direct = a_squared.inv();

        assert_eq!(inv_a_squared, inv_a_squared_direct);
    }

    #[test]
    fn test_batch_inverse_result_access_methods() {
        let elements = vec![
            FieldElement::from_u64(2),
            FieldElement::from_u64(3),
            FieldElement::from_u64(5),
        ];

        let result = batch_inverse(&elements).unwrap();

        // Test len()
        assert_eq!(result.len(), 3);

        // Test is_empty()
        assert!(!result.is_empty());

        // Test get() indexing
        for i in 0..3 {
            let elem = &elements[i];
            let inv = result.get(i);
            assert_eq!(elem.mul(inv), FieldElement::from_u64(1));
        }

        // Test into_vec() consumes the result
        let vec = result.into_vec();
        assert_eq!(vec.len(), 3);
        for (i, elem) in elements.iter().enumerate() {
            assert_eq!(elem.mul(&vec[i]), FieldElement::from_u64(1));
        }
    }
}

#[cfg(feature = "alloc")]
mod edge_cases_and_error_handling {
    use super::*;

    #[test]
    fn test_batch_inverse_max_reasonable_size() {
        // Test with a reasonably large batch (100 elements)
        let elements: Vec<FieldElement> =
            (1..=100).map(|i| FieldElement::from_u64(i + 1)).collect();

        let result = batch_inverse(&elements).unwrap();
        assert_eq!(result.len(), 100);

        // Spot check a few elements
        assert_eq!(elements[0].mul(result.get(0)), FieldElement::from_u64(1));
        assert_eq!(elements[50].mul(result.get(50)), FieldElement::from_u64(1));
        assert_eq!(elements[99].mul(result.get(99)), FieldElement::from_u64(1));
    }

    #[test]
    fn test_batch_inverse_result_panic_on_out_of_bounds() {
        let elements = vec![FieldElement::from_u64(2)];
        let _result = batch_inverse(&elements).unwrap();

        // This should panic - we can't test panics directly in stable Rust without
        // additional dependencies, but we know get() should bounds check
        // In real usage, this would panic: result.get(1);
    }

    #[test]
    fn test_batch_inverse_algorithm_robustness() {
        // Test with elements that might cause issues in the algorithm
        let elements = vec![
            FieldElement::from_u64(1), // Multiplicative identity
            FieldElement::from_u64(2),
            FieldElement::from_u64(1), // Duplicate
            FieldElement::from_u64(2), // Another duplicate
        ];

        let result = batch_inverse(&elements).unwrap();
        assert_eq!(result.len(), 4);

        // All elements should be correctly inverted
        for (i, elem) in elements.iter().enumerate() {
            assert_eq!(elem.mul(result.get(i)), FieldElement::from_u64(1));
        }
    }
}

#[cfg(feature = "alloc")]
mod memory_and_performance_tests {
    use super::*;

    #[test]
    fn test_batch_inverse_memory_efficiency() {
        // Test that the result can be consumed without unnecessary copies
        let elements = vec![FieldElement::from_u64(2), FieldElement::from_u64(3)];
        let result = batch_inverse(&elements).unwrap();

        // into_vec should move the data without copying
        let vec = result.into_vec();
        assert_eq!(vec.len(), 2);
        assert_eq!(elements[0].mul(&vec[0]), FieldElement::from_u64(1));
    }

    #[test]
    fn test_batch_inverse_result_reuse() {
        // Test that results can be reused multiple times
        let elements = vec![FieldElement::from_u64(2), FieldElement::from_u64(3)];
        let result = batch_inverse(&elements).unwrap();

        // Access multiple times
        let _inv0 = result.get(0);
        let _inv1 = result.get(1);
        let _inv0_again = result.get(0);

        // All accesses should work
        assert_eq!(elements[0].mul(result.get(0)), FieldElement::from_u64(1));
        assert_eq!(elements[1].mul(result.get(1)), FieldElement::from_u64(1));
    }
}