chore: revert .cell() and constrain_equal to standard API (#11)

* chore: revert `.cell()` and `constrain_equal` to standard API * feat: public Cell
axiom-crypto · Aug 27, 2023 · 5946707 · 5946707
1 parent bce1523
commit 5946707
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 27 deletions.
diff --git a/halo2_proofs/benches/plonk.rs b/halo2_proofs/benches/plonk.rs
@@ -104,7 +104,7 @@ fn criterion_benchmark(c: &mut Criterion) {
                     region.assign_fixed(self.config.sb, 0, FF::ZERO);
                     region.assign_fixed(self.config.sc, 0, FF::ONE);
                     region.assign_fixed(self.config.sm, 0, FF::ONE);
-                    Ok((*lhs.cell(), *rhs.cell(), *out.cell()))
+                    Ok((lhs.cell(), rhs.cell(), out.cell()))
                 },
             )
         }
@@ -131,7 +131,7 @@ fn criterion_benchmark(c: &mut Criterion) {
                     region.assign_fixed(self.config.sb, 0, FF::ONE);
                     region.assign_fixed(self.config.sc, 0, FF::ONE);
                     region.assign_fixed(self.config.sm, 0, FF::ZERO);
-                    Ok((*lhs.cell(), *rhs.cell(), *out.cell()))
+                    Ok((lhs.cell(), rhs.cell(), out.cell()))
                 },
             )
         }
@@ -144,7 +144,7 @@ fn criterion_benchmark(c: &mut Criterion) {
             layouter.assign_region(
                 || "copy",
                 |mut region| {
-                    region.constrain_equal(&left, &right);
+                    region.constrain_equal(left, right);
                     Ok(())
                 },
             )

diff --git a/halo2_proofs/src/circuit.rs b/halo2_proofs/src/circuit.rs
@@ -89,20 +89,9 @@ pub struct Cell {
     /// Identifies the region in which this cell resides.
     // region_index: RegionIndex,
     /// The relative offset of this cell within its region.
-    row_offset: usize,
+    pub row_offset: usize,
     /// The column of this cell.
-    column: Column<Any>,
-}
-
-impl Cell {
-    /// Returns row offset
-    pub fn row_offset(&self) -> usize {
-        self.row_offset
-    }
-    /// Returns reference to column
-    pub fn column(&self) -> &Column<Any> {
-        &self.column
-    }
+    pub column: Column<Any>,
 }
 
 /// An assigned cell.
@@ -120,8 +109,8 @@ impl<V, F: Field> AssignedCell<V, F> {
     }
 
     /// Returns the cell.
-    pub fn cell(&self) -> &Cell {
-        &self.cell
+    pub fn cell(&self) -> Cell {
+        self.cell
     }
 
     pub fn row_offset(&self) -> usize {
@@ -169,7 +158,7 @@ impl<'v, F: Field> AssignedCell<&'v Assigned<F>, F> {
         offset: usize,
     ) -> AssignedCell<&'_ Assigned<F>, F> {
         let assigned_cell = region.assign_advice(column, offset, self.value.map(|v| *v));
-        region.constrain_equal(&assigned_cell.cell, &self.cell);
+        region.constrain_equal(assigned_cell.cell, self.cell);
         assigned_cell
     }
 }
@@ -352,7 +341,7 @@ impl<'r, F: Field> Region<'r, F> {
     ///
     /// Returns an error if either of the cells are in columns where equality
     /// has not been enabled.
-    pub fn constrain_equal(&mut self, left: &Cell, right: &Cell) {
+    pub fn constrain_equal(&mut self, left: Cell, right: Cell) {
         self.region.constrain_equal(left, right);
     }
 

diff --git a/halo2_proofs/src/circuit/floor_planner/single_pass.rs b/halo2_proofs/src/circuit/floor_planner/single_pass.rs
@@ -377,7 +377,7 @@ impl<'r, 'a, F: Field, CS: Assignment<F> + 'a + SyncDeps> RegionLayouter<F>
         Ok(())
     }
 
-    fn constrain_equal(&mut self, left: &Cell, right: &Cell) {
+    fn constrain_equal(&mut self, left: Cell, right: Cell) {
         self.layouter.cs.copy(
             left.column,
             left.row_offset, // *self.layouter.regions[*left.region_index] + left.row_offset,

diff --git a/halo2_proofs/src/circuit/layouter.rs b/halo2_proofs/src/circuit/layouter.rs
@@ -121,7 +121,7 @@ pub trait RegionLayouter<F: Field>: fmt::Debug + SyncDeps {
     /// Constraint two cells to have the same value.
     ///
     /// Returns an error if either of the cells is not within the given permutation.
-    fn constrain_equal(&mut self, left: &Cell, right: &Cell);
+    fn constrain_equal(&mut self, left: Cell, right: Cell);
 
     /// Queries the value of the given challenge.
     ///

diff --git a/halo2_proofs/tests/plonk_api.rs b/halo2_proofs/tests/plonk_api.rs
@@ -130,7 +130,7 @@ fn plonk_api() {
                     region.assign_fixed(self.config.sb, 0, FF::ZERO);
                     region.assign_fixed(self.config.sc, 0, FF::ONE);
                     region.assign_fixed(self.config.sm, 0, FF::ONE);
-                    Ok((*lhs.cell(), *rhs.cell(), *out.cell()))
+                    Ok((lhs.cell(), rhs.cell(), out.cell()))
                 },
             )
         }
@@ -167,7 +167,7 @@ fn plonk_api() {
                     region.assign_fixed(self.config.sb, 0, FF::ONE);
                     region.assign_fixed(self.config.sc, 0, FF::ONE);
                     region.assign_fixed(self.config.sm, 0, FF::ZERO);
-                    Ok((*lhs.cell(), *rhs.cell(), *out.cell()))
+                    Ok((lhs.cell(), rhs.cell(), out.cell()))
                 },
             )
         }
@@ -180,8 +180,8 @@ fn plonk_api() {
             layouter.assign_region(
                 || "copy",
                 |mut region| {
-                    region.constrain_equal(&left, &right);
-                    region.constrain_equal(&left, &right);
+                    region.constrain_equal(left, right);
+                    region.constrain_equal(left, right);
                     Ok(())
                 },
             )
@@ -196,7 +196,7 @@ fn plonk_api() {
                     let value = region.assign_advice(self.config.a, 0, f());
                     region.assign_fixed(self.config.sp, 0, FF::ONE);
 
-                    Ok(*value.cell())
+                    Ok(value.cell())
                 },
             )
         }