plonky2/src/gates/comparison.rs

687 lines
26 KiB
Rust
Raw Normal View History

2021-09-13 12:13:32 -07:00
use std::marker::PhantomData;
use crate::field::extension_field::target::ExtensionTarget;
use crate::field::extension_field::Extendable;
use crate::field::field_types::{Field, PrimeField, RichField};
use crate::gates::gate::Gate;
use crate::iop::generator::{GeneratedValues, SimpleGenerator, WitnessGenerator};
use crate::iop::target::Target;
use crate::iop::wire::Wire;
use crate::iop::witness::{PartitionWitness, Witness};
use crate::plonk::circuit_builder::CircuitBuilder;
2021-09-14 15:13:26 -07:00
use crate::plonk::plonk_common::{reduce_with_powers, reduce_with_powers_ext_recursive};
2021-09-13 12:13:32 -07:00
use crate::plonk::vars::{EvaluationTargets, EvaluationVars, EvaluationVarsBase};
use crate::util::{bits_u64, ceil_div_usize};
2021-09-13 12:13:32 -07:00
2021-09-17 13:09:24 -07:00
/// A gate for checking that one value is less than or equal to another.
2021-09-13 12:13:32 -07:00
#[derive(Clone, Debug)]
2021-09-22 11:49:28 -07:00
pub struct ComparisonGate<F: PrimeField + Extendable<D>, const D: usize> {
2021-09-13 14:52:02 -07:00
pub(crate) num_bits: usize,
pub(crate) num_chunks: usize,
2021-09-13 12:13:32 -07:00
_phantom: PhantomData<F>,
}
impl<F: RichField + Extendable<D>, const D: usize> ComparisonGate<F, D> {
2021-09-14 12:35:17 -07:00
pub fn new(num_bits: usize, num_chunks: usize) -> Self {
debug_assert!(num_bits < bits_u64(F::ORDER));
2021-09-13 12:13:32 -07:00
Self {
2021-09-13 14:52:02 -07:00
num_bits,
num_chunks,
2021-09-13 12:13:32 -07:00
_phantom: PhantomData,
}
}
2021-09-13 14:52:02 -07:00
pub fn chunk_bits(&self) -> usize {
ceil_div_usize(self.num_bits, self.num_chunks)
2021-09-13 12:13:32 -07:00
}
2021-09-14 12:35:17 -07:00
pub fn wire_first_input(&self) -> usize {
0
2021-09-13 12:13:32 -07:00
}
2021-09-14 12:35:17 -07:00
pub fn wire_second_input(&self) -> usize {
1
2021-09-13 12:13:32 -07:00
}
2021-10-12 11:41:34 -07:00
pub fn wire_result_bool(&self) -> usize {
2
2021-09-13 12:13:32 -07:00
}
2021-10-12 11:41:34 -07:00
pub fn wire_most_significant_diff(&self) -> usize {
3
}
2021-09-14 12:35:17 -07:00
pub fn wire_first_chunk_val(&self, chunk: usize) -> usize {
2021-09-13 14:52:02 -07:00
debug_assert!(chunk < self.num_chunks);
2021-10-12 11:41:34 -07:00
4 + chunk
2021-09-13 12:13:32 -07:00
}
2021-09-14 12:35:17 -07:00
pub fn wire_second_chunk_val(&self, chunk: usize) -> usize {
2021-09-13 14:52:02 -07:00
debug_assert!(chunk < self.num_chunks);
2021-10-12 11:41:34 -07:00
4 + self.num_chunks + chunk
2021-09-13 12:13:32 -07:00
}
2021-09-14 12:35:17 -07:00
pub fn wire_equality_dummy(&self, chunk: usize) -> usize {
2021-09-13 14:52:02 -07:00
debug_assert!(chunk < self.num_chunks);
2021-10-12 11:41:34 -07:00
4 + 2 * self.num_chunks + chunk
2021-09-13 12:13:32 -07:00
}
2021-09-14 12:35:17 -07:00
pub fn wire_chunks_equal(&self, chunk: usize) -> usize {
2021-09-13 14:52:02 -07:00
debug_assert!(chunk < self.num_chunks);
2021-10-12 11:41:34 -07:00
4 + 3 * self.num_chunks + chunk
2021-09-13 12:13:32 -07:00
}
2021-09-16 11:16:32 -07:00
pub fn wire_intermediate_value(&self, chunk: usize) -> usize {
debug_assert!(chunk < self.num_chunks);
2021-10-12 11:41:34 -07:00
4 + 4 * self.num_chunks + chunk
}
/// The `bit_index`th bit of 2^n - 1 + most_significant_diff.
pub fn wire_most_significant_diff_bit(&self, bit_index: usize) -> usize {
4 + 5 * self.num_chunks + bit_index
2021-09-16 11:16:32 -07:00
}
2021-09-13 12:13:32 -07:00
}
impl<F: RichField + Extendable<D>, const D: usize> Gate<F, D> for ComparisonGate<F, D> {
fn id(&self) -> String {
format!("{:?}<D={}>", self, D)
}
fn eval_unfiltered(&self, vars: EvaluationVars<F, D>) -> Vec<F::Extension> {
let mut constraints = Vec::with_capacity(self.num_constraints());
2021-09-14 12:35:17 -07:00
let first_input = vars.local_wires[self.wire_first_input()];
let second_input = vars.local_wires[self.wire_second_input()];
// Get chunks and assert that they match
let first_chunks: Vec<F::Extension> = (0..self.num_chunks)
.map(|i| vars.local_wires[self.wire_first_chunk_val(i)])
.collect();
let second_chunks: Vec<F::Extension> = (0..self.num_chunks)
.map(|i| vars.local_wires[self.wire_second_chunk_val(i)])
.collect();
2021-09-14 14:24:15 -07:00
let first_chunks_combined = reduce_with_powers(
&first_chunks,
F::Extension::from_canonical_usize(1 << self.chunk_bits()),
);
let second_chunks_combined = reduce_with_powers(
&second_chunks,
F::Extension::from_canonical_usize(1 << self.chunk_bits()),
);
2021-09-14 12:35:17 -07:00
constraints.push(first_chunks_combined - first_input);
constraints.push(second_chunks_combined - second_input);
2021-09-13 12:13:32 -07:00
let chunk_size = 1 << self.chunk_bits();
let mut most_significant_diff_so_far = F::Extension::ZERO;
2021-09-13 12:13:32 -07:00
2021-09-14 12:35:17 -07:00
for i in 0..self.num_chunks {
// Range-check the chunks to be less than `chunk_size`.
2021-10-25 15:49:44 -07:00
let first_product: F::Extension = (0..chunk_size)
.map(|x| first_chunks[i] - F::Extension::from_canonical_usize(x))
.product();
2021-10-25 15:49:44 -07:00
let second_product: F::Extension = (0..chunk_size)
.map(|x| second_chunks[i] - F::Extension::from_canonical_usize(x))
.product();
2021-09-15 14:40:28 -07:00
constraints.push(first_product);
constraints.push(second_product);
let difference = second_chunks[i] - first_chunks[i];
2021-09-14 12:35:17 -07:00
let equality_dummy = vars.local_wires[self.wire_equality_dummy(i)];
let chunks_equal = vars.local_wires[self.wire_chunks_equal(i)];
2021-09-13 12:13:32 -07:00
// Two constraints to assert that `chunks_equal` is valid.
2021-09-14 12:35:17 -07:00
constraints.push(difference * equality_dummy - (F::Extension::ONE - chunks_equal));
constraints.push(chunks_equal * difference);
2021-09-13 12:13:32 -07:00
// Update `most_significant_diff_so_far`.
2021-09-16 11:16:32 -07:00
let intermediate_value = vars.local_wires[self.wire_intermediate_value(i)];
constraints.push(intermediate_value - chunks_equal * most_significant_diff_so_far);
most_significant_diff_so_far =
intermediate_value + (F::Extension::ONE - chunks_equal) * difference;
2021-09-13 12:13:32 -07:00
}
let most_significant_diff = vars.local_wires[self.wire_most_significant_diff()];
constraints.push(most_significant_diff - most_significant_diff_so_far);
2021-09-14 12:35:17 -07:00
2021-10-12 11:41:34 -07:00
let most_significant_diff_bits: Vec<F::Extension> = (0..self.chunk_bits() + 1)
.map(|i| vars.local_wires[self.wire_most_significant_diff_bit(i)])
.collect();
2021-10-12 11:50:00 -07:00
// Range-check the bits.
2021-11-30 17:12:13 +01:00
for &bit in &most_significant_diff_bits {
constraints.push(bit * (F::Extension::ONE - bit));
2021-10-12 11:50:00 -07:00
}
2021-10-12 11:41:52 -07:00
let bits_combined = reduce_with_powers(&most_significant_diff_bits, F::Extension::TWO);
2021-10-12 13:31:05 -07:00
let two_n = F::Extension::from_canonical_u64(1 << self.chunk_bits());
constraints.push((two_n + most_significant_diff) - bits_combined);
2021-10-12 11:41:34 -07:00
2021-10-12 13:31:05 -07:00
// Iff first <= second, the top (n + 1st) bit of (2^n + most_significant_diff) will be 1.
2021-10-12 11:41:34 -07:00
let result_bool = vars.local_wires[self.wire_result_bool()];
constraints.push(result_bool - most_significant_diff_bits[self.chunk_bits()]);
2021-09-14 12:35:17 -07:00
2021-09-13 12:13:32 -07:00
constraints
}
fn eval_unfiltered_base(&self, vars: EvaluationVarsBase<F>) -> Vec<F> {
2021-09-14 14:53:33 -07:00
let mut constraints = Vec::with_capacity(self.num_constraints());
let first_input = vars.local_wires[self.wire_first_input()];
let second_input = vars.local_wires[self.wire_second_input()];
// Get chunks and assert that they match
let first_chunks: Vec<F> = (0..self.num_chunks)
.map(|i| vars.local_wires[self.wire_first_chunk_val(i)])
.collect();
let second_chunks: Vec<F> = (0..self.num_chunks)
.map(|i| vars.local_wires[self.wire_second_chunk_val(i)])
.collect();
let first_chunks_combined = reduce_with_powers(
&first_chunks,
F::from_canonical_usize(1 << self.chunk_bits()),
);
let second_chunks_combined = reduce_with_powers(
&second_chunks,
F::from_canonical_usize(1 << self.chunk_bits()),
);
constraints.push(first_chunks_combined - first_input);
constraints.push(second_chunks_combined - second_input);
let chunk_size = 1 << self.chunk_bits();
let mut most_significant_diff_so_far = F::ZERO;
2021-09-14 14:53:33 -07:00
for i in 0..self.num_chunks {
// Range-check the chunks to be less than `chunk_size`.
2021-10-25 15:49:44 -07:00
let first_product: F = (0..chunk_size)
.map(|x| first_chunks[i] - F::from_canonical_usize(x))
.product();
2021-10-25 15:49:44 -07:00
let second_product: F = (0..chunk_size)
.map(|x| second_chunks[i] - F::from_canonical_usize(x))
.product();
2021-09-15 14:40:28 -07:00
constraints.push(first_product);
constraints.push(second_product);
2021-09-15 17:47:15 -07:00
let difference = second_chunks[i] - first_chunks[i];
2021-09-14 14:53:33 -07:00
let equality_dummy = vars.local_wires[self.wire_equality_dummy(i)];
let chunks_equal = vars.local_wires[self.wire_chunks_equal(i)];
// Two constraints to assert that `chunks_equal` is valid.
2021-09-14 14:53:33 -07:00
constraints.push(difference * equality_dummy - (F::ONE - chunks_equal));
constraints.push(chunks_equal * difference);
// Update `most_significant_diff_so_far`.
2021-09-16 11:16:32 -07:00
let intermediate_value = vars.local_wires[self.wire_intermediate_value(i)];
constraints.push(intermediate_value - chunks_equal * most_significant_diff_so_far);
most_significant_diff_so_far =
2021-09-16 11:16:32 -07:00
intermediate_value + (F::ONE - chunks_equal) * difference;
2021-09-14 14:53:33 -07:00
}
let most_significant_diff = vars.local_wires[self.wire_most_significant_diff()];
constraints.push(most_significant_diff - most_significant_diff_so_far);
2021-09-14 14:53:33 -07:00
2021-10-12 11:41:34 -07:00
let most_significant_diff_bits: Vec<F> = (0..self.chunk_bits() + 1)
.map(|i| vars.local_wires[self.wire_most_significant_diff_bit(i)])
.collect();
2021-10-12 11:50:00 -07:00
// Range-check the bits.
2021-11-30 17:12:13 +01:00
for &bit in &most_significant_diff_bits {
constraints.push(bit * (F::ONE - bit));
2021-10-12 11:50:00 -07:00
}
2021-10-12 11:41:52 -07:00
let bits_combined = reduce_with_powers(&most_significant_diff_bits, F::TWO);
2021-10-12 13:31:05 -07:00
let two_n = F::from_canonical_u64(1 << self.chunk_bits());
constraints.push((two_n + most_significant_diff) - bits_combined);
2021-10-12 11:41:34 -07:00
2021-10-12 13:31:05 -07:00
// Iff first <= second, the top (n + 1st) bit of (2^n - 1 + most_significant_diff) will be 1.
2021-10-12 11:41:34 -07:00
let result_bool = vars.local_wires[self.wire_result_bool()];
constraints.push(result_bool - most_significant_diff_bits[self.chunk_bits()]);
2021-09-14 14:53:33 -07:00
constraints
2021-09-13 12:13:32 -07:00
}
fn eval_unfiltered_recursively(
&self,
builder: &mut CircuitBuilder<F, D>,
vars: EvaluationTargets<D>,
) -> Vec<ExtensionTarget<D>> {
2021-09-14 15:13:26 -07:00
let mut constraints = Vec::with_capacity(self.num_constraints());
let first_input = vars.local_wires[self.wire_first_input()];
let second_input = vars.local_wires[self.wire_second_input()];
// Get chunks and assert that they match
let first_chunks: Vec<ExtensionTarget<D>> = (0..self.num_chunks)
.map(|i| vars.local_wires[self.wire_first_chunk_val(i)])
.collect();
let second_chunks: Vec<ExtensionTarget<D>> = (0..self.num_chunks)
.map(|i| vars.local_wires[self.wire_second_chunk_val(i)])
.collect();
2021-10-12 11:41:52 -07:00
let chunk_base = builder.constant(F::from_canonical_usize(1 << self.chunk_bits()));
let first_chunks_combined =
reduce_with_powers_ext_recursive(builder, &first_chunks, chunk_base);
let second_chunks_combined =
reduce_with_powers_ext_recursive(builder, &second_chunks, chunk_base);
2021-09-14 15:13:26 -07:00
constraints.push(builder.sub_extension(first_chunks_combined, first_input));
constraints.push(builder.sub_extension(second_chunks_combined, second_input));
let chunk_size = 1 << self.chunk_bits();
let mut most_significant_diff_so_far = builder.zero_extension();
2021-09-14 15:13:26 -07:00
let one = builder.one_extension();
// Find the chosen chunk.
for i in 0..self.num_chunks {
// Range-check the chunks to be less than `chunk_size`.
2021-09-15 14:40:28 -07:00
let mut first_product = one;
let mut second_product = one;
for x in 0..chunk_size {
2021-09-27 22:34:23 -07:00
let x_f = builder.constant_extension(F::Extension::from_canonical_usize(x));
let first_diff = builder.sub_extension(first_chunks[i], x_f);
let second_diff = builder.sub_extension(second_chunks[i], x_f);
2021-09-15 14:40:28 -07:00
first_product = builder.mul_extension(first_product, first_diff);
second_product = builder.mul_extension(second_product, second_diff);
}
constraints.push(first_product);
constraints.push(second_product);
let difference = builder.sub_extension(second_chunks[i], first_chunks[i]);
2021-09-14 15:13:26 -07:00
let equality_dummy = vars.local_wires[self.wire_equality_dummy(i)];
let chunks_equal = vars.local_wires[self.wire_chunks_equal(i)];
// Two constraints to assert that `chunks_equal` is valid.
2021-09-14 15:13:26 -07:00
let diff_times_equal = builder.mul_extension(difference, equality_dummy);
let not_equal = builder.sub_extension(one, chunks_equal);
constraints.push(builder.sub_extension(diff_times_equal, not_equal));
constraints.push(builder.mul_extension(chunks_equal, difference));
// Update `most_significant_diff_so_far`.
2021-09-16 11:16:32 -07:00
let intermediate_value = vars.local_wires[self.wire_intermediate_value(i)];
let old_diff = builder.mul_extension(chunks_equal, most_significant_diff_so_far);
2021-09-16 11:16:32 -07:00
constraints.push(builder.sub_extension(intermediate_value, old_diff));
2021-09-14 15:13:26 -07:00
let not_equal = builder.sub_extension(one, chunks_equal);
2021-09-15 17:47:15 -07:00
let new_diff = builder.mul_extension(not_equal, difference);
2021-09-16 11:16:32 -07:00
most_significant_diff_so_far = builder.add_extension(intermediate_value, new_diff);
2021-09-14 15:13:26 -07:00
}
let most_significant_diff = vars.local_wires[self.wire_most_significant_diff()];
2021-09-15 16:41:37 -07:00
constraints
.push(builder.sub_extension(most_significant_diff, most_significant_diff_so_far));
2021-09-14 15:13:26 -07:00
2021-10-12 11:41:34 -07:00
let most_significant_diff_bits: Vec<ExtensionTarget<D>> = (0..self.chunk_bits() + 1)
.map(|i| vars.local_wires[self.wire_most_significant_diff_bit(i)])
.collect();
2021-10-12 11:50:00 -07:00
// Range-check the bits.
2021-11-30 17:12:13 +01:00
for &this_bit in &most_significant_diff_bits {
2021-10-12 11:50:00 -07:00
let inverse = builder.sub_extension(one, this_bit);
constraints.push(builder.mul_extension(this_bit, inverse));
}
2021-10-12 11:41:34 -07:00
let two = builder.two();
2021-10-12 11:41:52 -07:00
let bits_combined =
reduce_with_powers_ext_recursive(builder, &most_significant_diff_bits, two);
2021-10-12 13:31:05 -07:00
let two_n =
builder.constant_extension(F::Extension::from_canonical_u64(1 << self.chunk_bits()));
let sum = builder.add_extension(two_n, most_significant_diff);
2021-10-12 11:41:34 -07:00
constraints.push(builder.sub_extension(sum, bits_combined));
2021-10-12 13:31:05 -07:00
// Iff first <= second, the top (n + 1st) bit of (2^n + most_significant_diff) will be 1.
2021-10-12 11:41:34 -07:00
let result_bool = vars.local_wires[self.wire_result_bool()];
2021-10-12 11:41:52 -07:00
constraints.push(
builder.sub_extension(result_bool, most_significant_diff_bits[self.chunk_bits()]),
);
2021-09-14 15:13:26 -07:00
constraints
2021-09-13 12:13:32 -07:00
}
fn generators(
&self,
gate_index: usize,
_local_constants: &[F],
) -> Vec<Box<dyn WitnessGenerator<F>>> {
2021-09-14 12:35:17 -07:00
let gen = ComparisonGenerator::<F, D> {
gate_index,
gate: self.clone(),
};
vec![Box::new(gen.adapter())]
2021-09-13 12:13:32 -07:00
}
fn num_wires(&self) -> usize {
2021-10-12 11:41:34 -07:00
4 + 5 * self.num_chunks + (self.chunk_bits() + 1)
2021-09-13 12:13:32 -07:00
}
fn num_constants(&self) -> usize {
0
}
fn degree(&self) -> usize {
2021-09-16 11:16:32 -07:00
1 << self.chunk_bits()
2021-09-13 12:13:32 -07:00
}
fn num_constraints(&self) -> usize {
2021-10-12 11:50:00 -07:00
6 + 5 * self.num_chunks + self.chunk_bits()
2021-09-13 12:13:32 -07:00
}
}
#[derive(Debug)]
struct ComparisonGenerator<F: RichField + Extendable<D>, const D: usize> {
gate_index: usize,
gate: ComparisonGate<F, D>,
}
impl<F: RichField + Extendable<D>, const D: usize> SimpleGenerator<F>
for ComparisonGenerator<F, D>
{
fn dependencies(&self) -> Vec<Target> {
let local_target = |input| Target::wire(self.gate_index, input);
2021-11-30 17:12:13 +01:00
vec![
local_target(self.gate.wire_first_input()),
local_target(self.gate.wire_second_input()),
]
2021-09-13 12:13:32 -07:00
}
fn run_once(&self, witness: &PartitionWitness<F>, out_buffer: &mut GeneratedValues<F>) {
let local_wire = |input| Wire {
gate: self.gate_index,
input,
};
let get_local_wire = |input| witness.get_wire(local_wire(input));
2021-09-14 12:35:17 -07:00
let first_input = get_local_wire(self.gate.wire_first_input());
let second_input = get_local_wire(self.gate.wire_second_input());
2021-09-13 12:13:32 -07:00
let first_input_u64 = first_input.to_canonical_u64();
let second_input_u64 = second_input.to_canonical_u64();
2021-10-12 13:31:05 -07:00
let result = F::from_canonical_usize((first_input_u64 <= second_input_u64) as usize);
2021-09-14 14:26:04 -07:00
let chunk_size = 1 << self.gate.chunk_bits();
let first_input_chunks: Vec<F> = (0..self.gate.num_chunks)
2021-09-13 12:13:32 -07:00
.scan(first_input_u64, |acc, _| {
let tmp = *acc % chunk_size;
*acc /= chunk_size;
2021-09-13 12:13:32 -07:00
Some(F::from_canonical_u64(tmp))
})
.collect();
let second_input_chunks: Vec<F> = (0..self.gate.num_chunks)
2021-09-13 12:13:32 -07:00
.scan(second_input_u64, |acc, _| {
let tmp = *acc % chunk_size;
*acc /= chunk_size;
2021-09-13 12:13:32 -07:00
Some(F::from_canonical_u64(tmp))
})
.collect();
2021-09-13 14:52:02 -07:00
let chunks_equal: Vec<F> = (0..self.gate.num_chunks)
2021-09-13 12:13:32 -07:00
.map(|i| F::from_bool(first_input_chunks[i] == second_input_chunks[i]))
.collect();
let equality_dummies: Vec<F> = first_input_chunks
.iter()
.zip(second_input_chunks.iter())
.map(|(&f, &s)| if f == s { F::ONE } else { F::ONE / (s - f) })
2021-09-13 12:13:32 -07:00
.collect();
2021-09-16 11:16:32 -07:00
let mut most_significant_diff_so_far = F::ZERO;
let mut intermediate_values = Vec::new();
2021-09-21 18:01:21 -07:00
for i in 0..self.gate.num_chunks {
2021-09-13 18:03:57 -07:00
if first_input_chunks[i] != second_input_chunks[i] {
2021-09-16 11:16:32 -07:00
most_significant_diff_so_far = second_input_chunks[i] - first_input_chunks[i];
intermediate_values.push(F::ZERO);
} else {
intermediate_values.push(most_significant_diff_so_far);
2021-09-13 18:03:57 -07:00
}
}
2021-09-16 11:16:32 -07:00
let most_significant_diff = most_significant_diff_so_far;
2021-09-15 16:41:37 -07:00
2021-10-25 15:49:44 -07:00
let two_n = F::from_canonical_usize(1 << self.gate.chunk_bits());
let two_n_plus_msd = (two_n + most_significant_diff).to_canonical_u64();
let msd_bits_u64: Vec<u64> = (0..self.gate.chunk_bits() + 1)
2021-10-12 11:41:34 -07:00
.scan(two_n_plus_msd, |acc, _| {
let tmp = *acc % 2;
*acc /= 2;
2021-10-25 15:49:44 -07:00
Some(tmp)
2021-10-12 11:41:34 -07:00
})
.collect();
2021-10-25 17:28:59 -07:00
let msd_bits: Vec<F> = msd_bits_u64
.iter()
.map(|x| F::from_canonical_u64(*x))
.collect();
2021-10-12 11:41:34 -07:00
2021-10-12 11:41:52 -07:00
out_buffer.set_wire(local_wire(self.gate.wire_result_bool()), result);
2021-09-15 16:41:37 -07:00
out_buffer.set_wire(
local_wire(self.gate.wire_most_significant_diff()),
most_significant_diff,
);
2021-09-13 14:52:02 -07:00
for i in 0..self.gate.num_chunks {
2021-09-13 12:13:32 -07:00
out_buffer.set_wire(
2021-09-14 12:35:17 -07:00
local_wire(self.gate.wire_first_chunk_val(i)),
2021-09-13 12:13:32 -07:00
first_input_chunks[i],
);
out_buffer.set_wire(
2021-09-14 12:35:17 -07:00
local_wire(self.gate.wire_second_chunk_val(i)),
2021-09-13 12:13:32 -07:00
second_input_chunks[i],
);
out_buffer.set_wire(
2021-09-14 12:35:17 -07:00
local_wire(self.gate.wire_equality_dummy(i)),
2021-09-13 12:13:32 -07:00
equality_dummies[i],
);
out_buffer.set_wire(local_wire(self.gate.wire_chunks_equal(i)), chunks_equal[i]);
2021-09-16 11:16:32 -07:00
out_buffer.set_wire(
local_wire(self.gate.wire_intermediate_value(i)),
intermediate_values[i],
);
2021-09-13 12:13:32 -07:00
}
2021-10-12 11:41:34 -07:00
for i in 0..self.gate.chunk_bits() + 1 {
out_buffer.set_wire(
2021-10-12 11:41:52 -07:00
local_wire(self.gate.wire_most_significant_diff_bit(i)),
2021-10-12 11:41:34 -07:00
msd_bits[i],
);
}
2021-09-13 12:13:32 -07:00
}
}
#[cfg(test)]
mod tests {
2021-09-13 17:51:55 -07:00
use std::marker::PhantomData;
2021-09-13 12:13:32 -07:00
use anyhow::Result;
2021-09-13 17:51:48 -07:00
use rand::Rng;
2021-09-13 12:13:32 -07:00
2021-09-13 14:52:02 -07:00
use crate::field::extension_field::quartic::QuarticExtension;
2021-09-13 17:17:31 -07:00
use crate::field::field_types::{Field, PrimeField};
2021-11-02 12:04:42 -07:00
use crate::field::goldilocks_field::GoldilocksField;
2021-09-13 12:13:32 -07:00
use crate::gates::comparison::ComparisonGate;
use crate::gates::gate::Gate;
use crate::gates::gate_testing::{test_eval_fns, test_low_degree};
use crate::hash::hash_types::HashOut;
use crate::plonk::vars::EvaluationVars;
#[test]
fn wire_indices() {
2021-11-02 12:04:42 -07:00
type CG = ComparisonGate<GoldilocksField, 4>;
2021-09-13 14:52:02 -07:00
let num_bits = 40;
let num_chunks = 5;
2021-09-13 12:13:32 -07:00
let gate = CG {
2021-09-13 14:52:02 -07:00
num_bits,
num_chunks,
2021-09-13 12:13:32 -07:00
_phantom: PhantomData,
};
2021-09-14 12:35:17 -07:00
assert_eq!(gate.wire_first_input(), 0);
assert_eq!(gate.wire_second_input(), 1);
2021-10-12 11:41:34 -07:00
assert_eq!(gate.wire_result_bool(), 2);
assert_eq!(gate.wire_most_significant_diff(), 3);
assert_eq!(gate.wire_first_chunk_val(0), 4);
assert_eq!(gate.wire_first_chunk_val(4), 8);
assert_eq!(gate.wire_second_chunk_val(0), 9);
assert_eq!(gate.wire_second_chunk_val(4), 13);
assert_eq!(gate.wire_equality_dummy(0), 14);
assert_eq!(gate.wire_equality_dummy(4), 18);
assert_eq!(gate.wire_chunks_equal(0), 19);
assert_eq!(gate.wire_chunks_equal(4), 23);
assert_eq!(gate.wire_intermediate_value(0), 24);
assert_eq!(gate.wire_intermediate_value(4), 28);
assert_eq!(gate.wire_most_significant_diff_bit(0), 29);
assert_eq!(gate.wire_most_significant_diff_bit(8), 37);
2021-09-13 12:13:32 -07:00
}
#[test]
fn low_degree() {
2021-09-13 15:11:33 -07:00
let num_bits = 40;
let num_chunks = 5;
2021-11-02 12:04:42 -07:00
test_low_degree::<GoldilocksField, _, 4>(ComparisonGate::<_, 4>::new(num_bits, num_chunks))
2021-09-13 12:13:32 -07:00
}
#[test]
fn eval_fns() -> Result<()> {
2021-09-13 15:11:33 -07:00
let num_bits = 40;
let num_chunks = 5;
2021-11-02 12:04:42 -07:00
test_eval_fns::<GoldilocksField, _, 4>(ComparisonGate::<_, 4>::new(num_bits, num_chunks))
2021-09-13 12:13:32 -07:00
}
#[test]
fn test_gate_constraint() {
2021-11-02 12:04:42 -07:00
type F = GoldilocksField;
type FF = QuarticExtension<GoldilocksField>;
2021-09-13 17:17:31 -07:00
const D: usize = 4;
let num_bits = 40;
let num_chunks = 5;
let chunk_bits = num_bits / num_chunks;
// Returns the local wires for a comparison gate given the two inputs.
let get_wires = |first_input: F, second_input: F| -> Vec<FF> {
2021-09-13 17:17:31 -07:00
let mut v = Vec::new();
let first_input_u64 = first_input.to_canonical_u64();
let second_input_u64 = second_input.to_canonical_u64();
2021-10-12 13:31:05 -07:00
let result_bool = F::from_bool(first_input_u64 <= second_input_u64);
2021-10-12 11:41:34 -07:00
let chunk_size = 1 << chunk_bits;
let mut first_input_chunks: Vec<F> = (0..num_chunks)
.scan(first_input_u64, |acc, _| {
let tmp = *acc % chunk_size;
*acc /= chunk_size;
Some(F::from_canonical_u64(tmp))
})
.collect();
let mut second_input_chunks: Vec<F> = (0..num_chunks)
.scan(second_input_u64, |acc, _| {
let tmp = *acc % chunk_size;
*acc /= chunk_size;
Some(F::from_canonical_u64(tmp))
})
.collect();
let mut chunks_equal: Vec<F> = (0..num_chunks)
.map(|i| F::from_bool(first_input_chunks[i] == second_input_chunks[i]))
.collect();
let mut equality_dummies: Vec<F> = first_input_chunks
.iter()
.zip(second_input_chunks.iter())
.map(|(&f, &s)| if f == s { F::ONE } else { F::ONE / (s - f) })
.collect();
2021-09-16 11:16:32 -07:00
let mut most_significant_diff_so_far = F::ZERO;
let mut intermediate_values = Vec::new();
for i in 0..num_chunks {
if first_input_chunks[i] != second_input_chunks[i] {
2021-09-16 11:16:32 -07:00
most_significant_diff_so_far = second_input_chunks[i] - first_input_chunks[i];
intermediate_values.push(F::ZERO);
} else {
intermediate_values.push(most_significant_diff_so_far);
2021-09-13 18:03:57 -07:00
}
2021-09-13 17:17:31 -07:00
}
2021-09-16 11:16:32 -07:00
let most_significant_diff = most_significant_diff_so_far;
2021-10-12 13:31:05 -07:00
let two_n_plus_msd =
(1 << chunk_bits) as u64 + most_significant_diff.to_canonical_u64();
2021-10-12 11:41:34 -07:00
let mut msd_bits: Vec<F> = (0..chunk_bits + 1)
2021-10-12 13:31:05 -07:00
.scan(two_n_plus_msd, |acc, _| {
2021-10-12 11:41:34 -07:00
let tmp = *acc % 2;
*acc /= 2;
Some(F::from_canonical_u64(tmp))
})
.collect();
v.push(first_input);
v.push(second_input);
2021-10-12 11:41:34 -07:00
v.push(result_bool);
v.push(most_significant_diff);
v.append(&mut first_input_chunks);
v.append(&mut second_input_chunks);
v.append(&mut equality_dummies);
v.append(&mut chunks_equal);
2021-09-16 11:16:32 -07:00
v.append(&mut intermediate_values);
2021-10-12 11:41:34 -07:00
v.append(&mut msd_bits);
2021-09-13 17:17:31 -07:00
v.iter().map(|&x| x.into()).collect::<Vec<_>>()
};
2021-09-13 17:51:48 -07:00
let mut rng = rand::thread_rng();
2021-11-30 17:12:13 +01:00
let max: u64 = 1 << (num_bits - 1);
let first_input_u64 = rng.gen_range(0..max);
let second_input_u64 = {
let mut val = rng.gen_range(0..max);
2021-09-17 13:09:24 -07:00
while val < first_input_u64 {
val = rng.gen_range(0..max);
}
val
};
2021-09-14 13:27:17 -07:00
let first_input = F::from_canonical_u64(first_input_u64);
let second_input = F::from_canonical_u64(second_input_u64);
2021-09-13 17:17:31 -07:00
2021-09-17 13:09:24 -07:00
let less_than_gate = ComparisonGate::<F, D> {
2021-09-13 17:17:31 -07:00
num_bits,
num_chunks,
_phantom: PhantomData,
};
2021-09-17 13:09:24 -07:00
let less_than_vars = EvaluationVars {
2021-09-13 17:17:31 -07:00
local_constants: &[],
local_wires: &get_wires(first_input, second_input),
2021-09-13 17:17:31 -07:00
public_inputs_hash: &HashOut::rand(),
};
2021-09-17 13:09:24 -07:00
assert!(
less_than_gate
.eval_unfiltered(less_than_vars)
.iter()
.all(|x| x.is_zero()),
"Gate constraints are not satisfied."
);
2021-09-13 17:17:31 -07:00
2021-09-17 13:09:24 -07:00
let equal_gate = ComparisonGate::<F, D> {
num_bits,
num_chunks,
_phantom: PhantomData,
};
let equal_vars = EvaluationVars {
local_constants: &[],
local_wires: &get_wires(first_input, first_input),
public_inputs_hash: &HashOut::rand(),
};
2021-09-13 17:17:31 -07:00
assert!(
2021-09-17 13:09:24 -07:00
equal_gate
.eval_unfiltered(equal_vars)
.iter()
.all(|x| x.is_zero()),
2021-09-13 17:17:31 -07:00
"Gate constraints are not satisfied."
);
2021-09-13 12:13:32 -07:00
}
}