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

// 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> One for Scalar<E> {
    /// Returns the `1` element of the scalar.
    fn one() -> Self {
        Self::new(E::Scalar::one())
    }

    /// Returns `true` if the element is one.
    fn is_one(&self) -> bool {
        self.scalar.is_one()
    }
}

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

    type CurrentEnvironment = Console;

    const ITERATIONS: u64 = 100;

    #[test]
    fn test_one() {
        let one = Scalar::<CurrentEnvironment>::one();

        for (index, bit) in one.to_bits_le().iter().enumerate() {
            match index == 0 {
                true => assert!(bit),
                false => assert!(!bit),
            }
        }
    }

    #[test]
    fn test_is_one() {
        assert!(Scalar::<CurrentEnvironment>::one().is_one());

        let mut rng = TestRng::default();

        // Note: This test technically has a `1 / MODULUS` probability of being flaky.
        for _ in 0..ITERATIONS {
            let scalar: Scalar<CurrentEnvironment> = Uniform::rand(&mut rng);
            assert!(!scalar.is_one());
        }
    }
}