fixed-bigint 0.4.0

Fixed-size big integer implementation for Rust
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

// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Absolute difference implementation for FixedUInt.

use super::{FixedUInt, MachineWord, const_ct_select};
use crate::machineword::ConstMachineWord;
use const_num_traits::{AbsDiff, ConstZero, OverflowingSub, WrappingSub};
use const_num_traits::{Personality, PersonalityTag};

c0nst::c0nst! {
    c0nst impl<T: [c0nst] ConstMachineWord + MachineWord, const N: usize, P: Personality> AbsDiff for FixedUInt<T, N, P> {
        type Output = Self;
        fn abs_diff(self, other: Self) -> Self {
            match P::TAG {
                PersonalityTag::Nct => {
                    if self >= other {
                        self - other
                    } else {
                        other - self
                    }
                }
                PersonalityTag::Ct => {
                    let (diff, borrow) =
                        <Self as OverflowingSub>::overflowing_sub(self, other);
                    let neg_diff =
                        <Self as WrappingSub>::wrapping_sub(<Self as ConstZero>::ZERO, diff);
                    const_ct_select(diff, neg_diff, borrow as u8)
                }
            }
        }
    }

    c0nst impl<T: [c0nst] ConstMachineWord + MachineWord, const N: usize, P: Personality> AbsDiff for &FixedUInt<T, N, P> {
        type Output = FixedUInt<T, N, P>;
        fn abs_diff(self, other: Self) -> FixedUInt<T, N, P> {
            <FixedUInt<T, N, P> as AbsDiff>::abs_diff(*self, *other)
        }
    }
}

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

    #[test]
    fn test_abs_diff() {
        type U16 = FixedUInt<u8, 2>;

        assert_eq!(
            AbsDiff::abs_diff(U16::from(10u8), U16::from(3u8)),
            U16::from(7u8)
        );
        assert_eq!(
            AbsDiff::abs_diff(U16::from(3u8), U16::from(10u8)),
            U16::from(7u8)
        );
        assert_eq!(
            AbsDiff::abs_diff(U16::from(5u8), U16::from(5u8)),
            U16::from(0u8)
        );
        assert_eq!(
            AbsDiff::abs_diff(U16::from(0u8), U16::from(100u8)),
            U16::from(100u8)
        );
        assert_eq!(
            AbsDiff::abs_diff(U16::from(255u8), U16::from(0u8)),
            U16::from(255u8)
        );
    }

    c0nst::c0nst! {
        pub c0nst fn const_abs_diff<T: [c0nst] ConstMachineWord + MachineWord, const N: usize, P: Personality>(
            a: FixedUInt<T, N, P>,
            b: FixedUInt<T, N, P>,
        ) -> FixedUInt<T, N, P> {
            AbsDiff::abs_diff(a, b)
        }
    }

    #[test]
    fn test_const_abs_diff() {
        type U16 = FixedUInt<u8, 2>;

        assert_eq!(
            const_abs_diff(U16::from(10u8), U16::from(3u8)),
            U16::from(7u8)
        );

        #[cfg(feature = "nightly")]
        {
            const A: U16 = FixedUInt::from_array([10, 0]);
            const B: U16 = FixedUInt::from_array([3, 0]);
            const DIFF: U16 = const_abs_diff(A, B);
            assert_eq!(DIFF, FixedUInt::from_array([7, 0]));
        }
    }
}