leo/gadgets/tests/signed_integer/i64.rs
2021-03-04 10:45:37 -08:00

427 lines
11 KiB
Rust

// Copyright (C) 2019-2021 Aleo Systems Inc.
// This file is part of the Leo library.
// The Leo 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 Leo 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 Leo library. If not, see <https://www.gnu.org/licenses/>.
use leo_gadgets::arithmetic::*;
use leo_gadgets::Int64;
use snarkvm_gadgets::traits::utilities::alloc::AllocGadget;
use snarkvm_gadgets::traits::utilities::boolean::Boolean;
use snarkvm_models::curves::One;
use snarkvm_models::curves::Zero;
use snarkvm_r1cs::ConstraintSystem;
use snarkvm_r1cs::Fr;
use snarkvm_r1cs::TestConstraintSystem;
use rand::Rng;
use rand_core::SeedableRng;
use rand_xorshift::XorShiftRng;
use std::i64;
fn check_all_constant_bits(expected: i64, actual: Int64) {
for (i, b) in actual.bits.iter().enumerate() {
// shift value by i
let mask = 1 << i as i64;
let result = expected & mask;
match *b {
Boolean::Is(_) => panic!(),
Boolean::Not(_) => panic!(),
Boolean::Constant(b) => {
let bit = result == mask;
assert_eq!(b, bit);
}
}
}
}
fn check_all_allocated_bits(expected: i64, actual: Int64) {
for (i, b) in actual.bits.iter().enumerate() {
// shift value by i
let mask = 1 << i as i64;
let result = expected & mask;
match *b {
Boolean::Is(ref b) => {
let bit = result == mask;
assert_eq!(b.get_value().unwrap(), bit);
}
Boolean::Not(ref b) => {
let bit = result == mask;
assert_eq!(!b.get_value().unwrap(), bit);
}
Boolean::Constant(_) => unreachable!(),
}
}
}
#[test]
fn test_int64_constant_and_alloc() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..1000 {
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen();
let a_const = Int64::constant(a);
assert!(a_const.value == Some(a));
check_all_constant_bits(a, a_const);
let a_bit = Int64::alloc(cs.ns(|| "a_bit"), || Ok(a)).unwrap();
assert!(cs.is_satisfied());
assert!(a_bit.value == Some(a));
check_all_allocated_bits(a, a_bit);
}
}
#[test]
fn test_int64_add_constants() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..1000 {
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen();
let b: i64 = rng.gen();
let expected = match a.checked_add(b) {
Some(valid) => valid,
None => continue,
};
let a_bit = Int64::constant(a);
let b_bit = Int64::constant(b);
let r = a_bit.add(cs.ns(|| "addition"), &b_bit).unwrap();
assert!(r.value == Some(expected));
check_all_constant_bits(expected, r);
}
}
#[test]
fn test_int64_add() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..1000 {
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen();
let b: i64 = rng.gen();
let expected = match a.checked_add(b) {
Some(valid) => valid,
None => continue,
};
let a_bit = Int64::alloc(cs.ns(|| "a_bit"), || Ok(a)).unwrap();
let b_bit = Int64::alloc(cs.ns(|| "b_bit"), || Ok(b)).unwrap();
let r = a_bit.add(cs.ns(|| "addition"), &b_bit).unwrap();
assert!(cs.is_satisfied());
assert!(r.value == Some(expected));
check_all_allocated_bits(expected, r);
// Flip a bit_gadget and see if the addition constraint still works
if cs.get("addition/result bit_gadget 0/boolean").is_zero() {
cs.set("addition/result bit_gadget 0/boolean", Fr::one());
} else {
cs.set("addition/result bit_gadget 0/boolean", Fr::zero());
}
assert!(!cs.is_satisfied());
}
}
#[test]
fn test_int64_sub_constants() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..1000 {
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen();
let b: i64 = rng.gen();
if b.checked_neg().is_none() {
// negate with overflows will fail: -128
continue;
}
let expected = match a.checked_sub(b) {
// subtract with overflow will fail: -0
Some(valid) => valid,
None => continue,
};
let a_bit = Int64::constant(a);
let b_bit = Int64::constant(b);
let r = a_bit.sub(cs.ns(|| "subtraction"), &b_bit).unwrap();
assert!(r.value == Some(expected));
check_all_constant_bits(expected, r);
}
}
#[test]
fn test_int64_sub() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..1000 {
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen();
let b: i64 = rng.gen();
if b.checked_neg().is_none() {
// negate with overflows will fail: -128
continue;
}
let expected = match a.checked_sub(b) {
// subtract with overflow will fail: -0
Some(valid) => valid,
None => continue,
};
let a_bit = Int64::alloc(cs.ns(|| "a_bit"), || Ok(a)).unwrap();
let b_bit = Int64::alloc(cs.ns(|| "b_bit"), || Ok(b)).unwrap();
let r = a_bit.sub(cs.ns(|| "subtraction"), &b_bit).unwrap();
assert!(cs.is_satisfied());
assert!(r.value == Some(expected));
check_all_allocated_bits(expected, r);
// Flip a bit_gadget and see if the subtraction constraint still works
if cs
.get("subtraction/add_complement/result bit_gadget 0/boolean")
.is_zero()
{
cs.set("subtraction/add_complement/result bit_gadget 0/boolean", Fr::one());
} else {
cs.set("subtraction/add_complement/result bit_gadget 0/boolean", Fr::zero());
}
assert!(!cs.is_satisfied());
}
}
#[test]
fn test_int64_mul_constants() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..5 {
let mut cs = TestConstraintSystem::<Fr>::new();
let max = i32::MAX as i64;
let min = i32::MIN as i64;
let a: i64 = rng.gen_range(min..max);
let b: i64 = rng.gen_range(min..max);
let expected = match a.checked_mul(b) {
Some(valid) => valid,
None => continue,
};
let a_bit = Int64::constant(a);
let b_bit = Int64::constant(b);
let r = a_bit.mul(cs.ns(|| "multiplication"), &b_bit).unwrap();
assert!(r.value == Some(expected));
check_all_constant_bits(expected, r);
}
}
#[test]
fn test_int64_mul() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..5 {
let mut cs = TestConstraintSystem::<Fr>::new();
let max = i32::MAX as i64;
let min = i32::MIN as i64;
let a: i64 = rng.gen_range(min..max);
let b: i64 = rng.gen_range(min..max);
let expected = match a.checked_mul(b) {
Some(valid) => valid,
None => continue,
};
let a_bit = Int64::alloc(cs.ns(|| "a_bit"), || Ok(a)).unwrap();
let b_bit = Int64::alloc(cs.ns(|| "b_bit"), || Ok(b)).unwrap();
let r = a_bit.mul(cs.ns(|| "multiplication"), &b_bit).unwrap();
assert!(cs.is_satisfied());
assert!(r.value == Some(expected));
check_all_allocated_bits(expected, r);
// Flip a bit_gadget and see if the multiplication constraint still works
if cs.get("multiplication/result bit_gadget 0/boolean").is_zero() {
cs.set("multiplication/result bit_gadget 0/boolean", Fr::one());
} else {
cs.set("multiplication/result bit_gadget 0/boolean", Fr::zero());
}
assert!(!cs.is_satisfied());
}
}
#[test]
fn test_int64_div_constants() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..3 {
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen();
let b: i64 = rng.gen();
if a.checked_neg().is_none() {
return;
}
let expected = match a.checked_div(b) {
Some(valid) => valid,
None => return,
};
let a_bit = Int64::constant(a);
let b_bit = Int64::constant(b);
let r = a_bit.div(cs.ns(|| "division"), &b_bit).unwrap();
assert!(r.value == Some(expected));
check_all_constant_bits(expected, r);
}
}
#[test]
fn test_int64_div() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
for _ in 0..3 {
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen();
let b: i64 = rng.gen();
if a.checked_neg().is_none() {
continue;
}
let expected = match a.checked_div(b) {
Some(valid) => valid,
None => return,
};
let a_bit = Int64::alloc(cs.ns(|| "a_bit"), || Ok(a)).unwrap();
let b_bit = Int64::alloc(cs.ns(|| "b_bit"), || Ok(b)).unwrap();
let r = a_bit.div(cs.ns(|| "division"), &b_bit).unwrap();
assert!(cs.is_satisfied());
assert!(r.value == Some(expected));
check_all_allocated_bits(expected, r);
}
}
#[ignore]
#[test]
fn test_int64_pow_constants() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen_range(-16..16);
let b: i64 = rng.gen_range(-12..12);
let expected = a.checked_pow(b as u32).unwrap();
let a_bit = Int64::constant(a);
let b_bit = Int64::constant(b);
let r = a_bit.pow(cs.ns(|| "exponentiation"), &b_bit).unwrap();
assert!(r.value == Some(expected));
check_all_constant_bits(expected, r);
}
#[ignore]
#[test]
fn test_int64_pow() {
let mut rng = XorShiftRng::seed_from_u64(1231275789u64);
let mut cs = TestConstraintSystem::<Fr>::new();
let a: i64 = rng.gen_range(-16..16);
let b: i64 = rng.gen_range(-12..12);
let expected = a.checked_pow(b as u32).unwrap();
let a_bit = Int64::alloc(cs.ns(|| "a_bit"), || Ok(a)).unwrap();
let b_bit = Int64::alloc(cs.ns(|| "b_bit"), || Ok(b)).unwrap();
let r = a_bit.pow(cs.ns(|| "exponentiation"), &b_bit).unwrap();
assert!(cs.is_satisfied());
assert!(r.value == Some(expected));
check_all_allocated_bits(expected, r);
// Flip a bit_gadget and see if the exponentiation constraint still works
if cs
.get("exponentiation/multiply_by_self_0/result bit_gadget 0/boolean")
.is_zero()
{
cs.set(
"exponentiation/multiply_by_self_0/result bit_gadget 0/boolean",
Fr::one(),
);
} else {
cs.set(
"exponentiation/multiply_by_self_0/result bit_gadget 0/boolean",
Fr::zero(),
);
}
assert!(!cs.is_satisfied());
}