snarkvm-console-types-boolean 0.9.11

Type operations for a decentralized virtual machine
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

// Copyright (C) 2019-2022 Aleo Systems Inc.
// This file is part of the snarkVM library.

// The snarkVM library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The snarkVM library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the snarkVM library. If not, see <https://www.gnu.org/licenses/>.

use super::*;

impl<E: Environment> FromBits for Boolean<E> {
    /// Initializes a new boolean by extracting the first bit from a list of length 1.
    fn from_bits_le(bits_le: &[bool]) -> Result<Self> {
        match bits_le.len().is_one() {
            true => Ok(Boolean::new(bits_le[0])),
            false => bail!("Boolean::from_bits_le expects a list of one boolean, found {}", bits_le.len()),
        }
    }

    /// Initializes a new boolean by extracting the first bit from a list of length 1.
    fn from_bits_be(bits_be: &[bool]) -> Result<Self> {
        match bits_be.len().is_one() {
            true => Ok(Boolean::new(bits_be[0])),
            false => bail!("Boolean::from_bits_be expects a list of one boolean, found {}", bits_be.len()),
        }
    }
}

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

    type CurrentEnvironment = Console;

    const ITERATIONS: usize = 100;

    fn check_from_bits_le() -> Result<()> {
        let mut rng = TestRng::default();

        for i in 1..ITERATIONS {
            // Sample a random element.
            let expected: Boolean<CurrentEnvironment> = Uniform::rand(&mut rng);
            let given_bits = expected.to_bits_le();
            assert_eq!(Boolean::<CurrentEnvironment>::size_in_bits(), given_bits.len());

            let candidate = Boolean::<CurrentEnvironment>::from_bits_le(&given_bits)?;
            assert_eq!(expected, candidate);

            // Add excess zero bits.
            let candidate = vec![given_bits, vec![false; i]].concat();
            assert!(Boolean::<CurrentEnvironment>::from_bits_le(&candidate).is_err());
        }
        Ok(())
    }

    fn check_from_bits_be() -> Result<()> {
        let mut rng = TestRng::default();

        for i in 1..ITERATIONS {
            // Sample a random element.
            let expected: Boolean<CurrentEnvironment> = Uniform::rand(&mut rng);
            let given_bits = expected.to_bits_be();
            assert_eq!(Boolean::<CurrentEnvironment>::size_in_bits(), given_bits.len());

            let candidate = Boolean::<CurrentEnvironment>::from_bits_be(&given_bits)?;
            assert_eq!(expected, candidate);

            // Add excess zero bits.
            let candidate = vec![vec![false; i], given_bits].concat();
            assert!(Boolean::<CurrentEnvironment>::from_bits_be(&candidate).is_err());
        }
        Ok(())
    }

    #[test]
    fn test_from_bits_le() -> Result<()> {
        check_from_bits_le()
    }

    #[test]
    fn test_from_bits_be() -> Result<()> {
        check_from_bits_be()
    }
}