ruint 1.18.0

Unsigned integer type with const-generic bit length
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

//! Support for the [`ark-ff`](https://crates.io/crates/ark-ff) crate.
#![cfg(feature = "ark-ff-04")]
#![cfg_attr(docsrs, doc(cfg(feature = "ark-ff-04")))]

use crate::{ToFieldError, Uint};
use ark_ff_04::{
    PrimeField,
    biginteger::BigInt,
    fields::models::{Fp, FpConfig},
};

// FEATURE: Implement the `BigInteger` trait.

// BigInt

impl<const BITS: usize, const LIMBS: usize> From<BigInt<LIMBS>> for Uint<BITS, LIMBS> {
    fn from(value: BigInt<LIMBS>) -> Self {
        Self::from_limbs(value.0)
    }
}

impl<const BITS: usize, const LIMBS: usize> From<&BigInt<LIMBS>> for Uint<BITS, LIMBS> {
    fn from(value: &BigInt<LIMBS>) -> Self {
        Self::from_limbs(value.0)
    }
}

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for BigInt<LIMBS> {
    fn from(value: Uint<BITS, LIMBS>) -> Self {
        Self::new(value.into_limbs())
    }
}

impl<const BITS: usize, const LIMBS: usize> From<&Uint<BITS, LIMBS>> for BigInt<LIMBS> {
    fn from(value: &Uint<BITS, LIMBS>) -> Self {
        Self::new(value.into_limbs())
    }
}

// Fp

impl<P: FpConfig<LIMBS>, const BITS: usize, const LIMBS: usize> From<Fp<P, LIMBS>>
    for Uint<BITS, LIMBS>
{
    fn from(value: Fp<P, LIMBS>) -> Self {
        value.into_bigint().into()
    }
}

impl<P: FpConfig<LIMBS>, const BITS: usize, const LIMBS: usize> From<&Fp<P, LIMBS>>
    for Uint<BITS, LIMBS>
{
    fn from(value: &Fp<P, LIMBS>) -> Self {
        value.into_bigint().into()
    }
}

impl<P: FpConfig<LIMBS>, const BITS: usize, const LIMBS: usize> TryFrom<Uint<BITS, LIMBS>>
    for Fp<P, LIMBS>
{
    type Error = ToFieldError;

    fn try_from(value: Uint<BITS, LIMBS>) -> Result<Self, ToFieldError> {
        Self::from_bigint(value.into()).ok_or(ToFieldError::NotInField)
    }
}

impl<P: FpConfig<LIMBS>, const BITS: usize, const LIMBS: usize> TryFrom<&Uint<BITS, LIMBS>>
    for Fp<P, LIMBS>
{
    type Error = ToFieldError;

    fn try_from(value: &Uint<BITS, LIMBS>) -> Result<Self, ToFieldError> {
        Self::from_bigint(value.into()).ok_or(ToFieldError::NotInField)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::aliases::U256;
    use ark_bn254_04::{Fq, FqConfig, Fr, FrConfig};
    use ark_ff_04::MontConfig;
    use proptest::proptest;

    macro_rules! test_roundtrip {
        ($ark:ty, $bits:expr, $limbs:expr) => {
            proptest!(|(value: Uint<$bits, $limbs>)| {
                let ark: $ark = value.into();
                let back: Uint<$bits, $limbs> = ark.into();
                assert_eq!(back, value);
            });
        }
    }

    #[test]
    fn test_roundtrip() {
        use ark_ff_04::*;
        test_roundtrip!(BigInteger64, 64, 1);
        test_roundtrip!(BigInteger128, 128, 2);
        test_roundtrip!(BigInteger256, 256, 4);
        test_roundtrip!(BigInteger320, 320, 5);
        test_roundtrip!(BigInteger384, 384, 6);
        test_roundtrip!(BigInteger448, 448, 7);
        test_roundtrip!(BigInteger768, 768, 12);
        test_roundtrip!(BigInteger832, 832, 13);
    }

    #[test]
    fn test_fq_roundtrip() {
        let modulus: U256 = FqConfig::MODULUS.into();
        proptest!(|(value: U256)| {
            let value: U256 = value % modulus;
            let f: Fq = value.try_into().unwrap();
            let back: U256 = f.into();
            assert_eq!(back, value);
        });
    }

    #[test]
    fn test_fr_roundtrip() {
        let modulus: U256 = FrConfig::MODULUS.into();
        proptest!(|(value: U256)| {
            let value: U256 = value % modulus;
            let f: Fr = value.try_into().unwrap();
            let back: U256 = f.into();
            assert_eq!(back, value);
        });
    }
}