pathfinder-crypto 0.22.5

Cryptographic primitives used by Pathfinder
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

use std::cmp::Ordering;

use crate::MontFelt;

impl MontFelt {
    /// Returns whether the value is zero
    #[inline(always)]
    pub const fn is_zero(&self) -> bool {
        self.0[0] == 0 && self.0[1] == 0 && self.0[2] == 0 && self.0[3] == 0
    }

    /// Return whether the value is one
    #[inline(always)]
    pub const fn is_one(&self) -> bool {
        self.0[0] == MontFelt::R[0]
            && self.0[1] == MontFelt::R[1]
            && self.0[2] == MontFelt::R[2]
            && self.0[3] == MontFelt::R[3]
    }

    /// Compares two elements' native integer representation
    #[inline(always)]
    pub const fn const_cmp_native(&self, x: &MontFelt) -> Ordering {
        let a = self.const_reduce_full();
        let b = x.const_reduce_full();
        a.const_cmp(&b)
    }

    /// Compare representations
    #[inline(always)]
    pub const fn const_cmp(&self, x: &MontFelt) -> Ordering {
        let mut i = 4;
        while i > 0 {
            i -= 1;
            if self.0[i] < x.0[i] {
                return Ordering::Less;
            } else if self.0[i] > x.0[i] {
                return Ordering::Greater;
            }
        }
        Ordering::Equal
    }

    /// Equality
    #[inline(always)]
    pub const fn const_eq(&self, x: &MontFelt) -> bool {
        self.const_cmp(x) as i8 == 0
    }

    /// Greater than
    #[inline(always)]
    pub const fn const_gt(&self, x: &MontFelt) -> bool {
        self.const_cmp(x) as i8 > 0
    }

    /// Greater than or equal
    #[inline(always)]
    pub const fn const_geq(&self, x: &MontFelt) -> bool {
        self.const_cmp(x) as i8 >= 0
    }

    /// Less than
    #[inline(always)]
    pub const fn const_lt(&self, x: &MontFelt) -> bool {
        (self.const_cmp(x) as i8) < 0
    }

    /// Less than or equal
    #[inline(always)]
    pub const fn const_leq(&self, x: &MontFelt) -> bool {
        self.const_cmp(x) as i8 <= 0
    }
}

impl Ord for MontFelt {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.const_cmp_native(other)
    }
}

impl PartialOrd for MontFelt {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_ord() {
        let a = MontFelt::ONE;
        let b = MontFelt::ONE + MontFelt::ONE;
        let c = MontFelt::ONE + MontFelt::ONE + MontFelt::ONE;

        assert!(a < b);
        assert!(a <= b);
        assert!(a < c);
        assert!(a <= c);
        assert!(b < c);
        assert!(b <= c);

        assert!(b > a);
        assert!(b >= a);
        assert!(c > a);
        assert!(c >= a);
        assert!(c > b);
        assert!(c >= b);

        assert!(a == a);
        assert!(b == b);
        assert!(c == c);
    }
}