snarkvm_circuit_types_integers/
not.rs

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
// Copyright 2024 Aleo Network Foundation
// This file is part of the snarkVM library.

// 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.

use super::*;

impl<E: Environment, I: IntegerType> Not for Integer<E, I> {
    type Output = Integer<E, I>;

    fn not(self) -> Self::Output {
        (&self).not()
    }
}

impl<E: Environment, I: IntegerType> Not for &Integer<E, I> {
    type Output = Integer<E, I>;

    fn not(self) -> Self::Output {
        // Flip each bit in the representation of the `self` integer.
        Integer { bits_le: self.bits_le.iter().map(|b| !b).collect(), phantom: Default::default() }
    }
}

impl<E: Environment, I: IntegerType> Metrics<dyn Not<Output = Integer<E, I>>> for Integer<E, I> {
    type Case = Mode;

    fn count(_case: &Self::Case) -> Count {
        Count::is(0, 0, 0, 0)
    }
}

impl<E: Environment, I: IntegerType> OutputMode<dyn Not<Output = Integer<E, I>>> for Integer<E, I> {
    type Case = Mode;

    fn output_mode(case: &Self::Case) -> Mode {
        match case {
            Mode::Constant => Mode::Constant,
            _ => Mode::Private,
        }
    }
}

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

    use core::ops::RangeInclusive;

    const ITERATIONS: u64 = 128;

    fn check_not<I: IntegerType + Not<Output = I>>(
        name: &str,
        first: console::Integer<<Circuit as Environment>::Network, I>,
        mode: Mode,
    ) {
        let a = Integer::<Circuit, I>::new(mode, first);
        let expected = !first;

        Circuit::scope(name, || {
            let candidate = a.not();
            assert_eq!(expected, candidate.eject_value());
            assert_count!(Not(Integer<I>) => Integer<I>, &mode);
            assert_output_mode!(Not(Integer<I>) => Integer<I>, &mode, candidate);
        });
        Circuit::reset();
    }

    fn run_test<I: IntegerType + Not<Output = I>>(mode: Mode) {
        let mut rng = TestRng::default();

        for i in 0..ITERATIONS {
            let name = format!("Not: {mode} {i}");
            let value = Uniform::rand(&mut rng);
            check_not::<I>(&name, value, mode);
        }

        // Check the 0 case.
        let name = format!("Not: {mode} zero");
        check_not::<I>(&name, console::Integer::zero(), mode);

        // Check the 1 case.
        let name = format!("Not: {mode} one");
        check_not::<I>(&name, console::Integer::one(), mode);
    }

    fn run_exhaustive_test<I: IntegerType + Not<Output = I>>(mode: Mode)
    where
        RangeInclusive<I>: Iterator<Item = I>,
    {
        for value in I::MIN..=I::MAX {
            let value = console::Integer::<_, I>::new(value);

            let name = format!("Not: {mode}");
            check_not::<I>(&name, value, mode);
        }
    }

    test_integer_unary!(run_test, i8, not);
    test_integer_unary!(run_test, i16, not);
    test_integer_unary!(run_test, i32, not);
    test_integer_unary!(run_test, i64, not);
    test_integer_unary!(run_test, i128, not);

    test_integer_unary!(run_test, u8, not);
    test_integer_unary!(run_test, u16, not);
    test_integer_unary!(run_test, u32, not);
    test_integer_unary!(run_test, u64, not);
    test_integer_unary!(run_test, u128, not);

    test_integer_unary!(#[ignore], run_exhaustive_test, u8, not, exhaustive);
    test_integer_unary!(#[ignore], run_exhaustive_test, i8, not, exhaustive);
}