snarkvm-gadgets 0.8.0

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

// Copyright (C) 2019-2021 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 crate::bits::Boolean;

use std::fmt::Debug;

/// The interface for a singed or unsigned integer gadget.
pub trait Integer: Debug + Clone {
    type IntegerType;
    type UnsignedGadget;
    type UnsignedIntegerType;

    const SIZE: usize;

    fn constant(value: Self::IntegerType) -> Self;

    fn one() -> Self;

    fn zero() -> Self;

    fn new(bits: Vec<Boolean>, value: Option<Self::IntegerType>) -> Self;

    /// Returns true if all bits in this `Int` are constant
    fn is_constant(&self) -> bool;

    /// Returns true if both `Int` objects have constant bits
    fn result_is_constant(first: &Self, second: &Self) -> bool {
        first.is_constant() && second.is_constant()
    }

    fn to_bits_le(&self) -> Vec<Boolean>;

    fn to_bits_be(&self) -> Vec<Boolean>;

    fn from_bits_le(bits: &[Boolean]) -> Self;

    fn get_value(&self) -> Option<String>;
}