Merge pull request #172 from kroma-network/refac/rename-for-better-re…

…adability

refac(zk): rename for better readability

tachyon/zk/plonk/BUILD.bazel

@@ -11,9 +11,9 @@ tachyon_cc_library(
         "//tachyon/base/functional:callback",
         "//tachyon/zk/plonk/circuit:constraint",
         "//tachyon/zk/plonk/circuit:gate",
+        "//tachyon/zk/plonk/circuit:lookup_table_column",
         "//tachyon/zk/plonk/circuit:query",
         "//tachyon/zk/plonk/circuit:selector_compressor",
-        "//tachyon/zk/plonk/circuit:table_column",
         "//tachyon/zk/plonk/circuit:virtual_cells",
         "//tachyon/zk/plonk/circuit/expressions/evaluator:simple_selector_finder",
         "//tachyon/zk/plonk/lookup:lookup_argument",

tachyon/zk/plonk/circuit/BUILD.bazel

@@ -29,7 +29,7 @@ tachyon_cc_library(
     hdrs = ["assignment.h"],
     deps = [
         ":challenge",
-        ":column",
+        ":column_key",
         ":selector",
         "//tachyon/base/functional:callback",
         "//tachyon/math/base:rational_field",
@@ -42,7 +42,7 @@ tachyon_cc_library(
     name = "cell",
     hdrs = ["cell.h"],
     deps = [
-        ":column",
+        ":column_key",
         "//tachyon:export",
         "@com_google_absl//absl/strings",
     ],
@@ -73,8 +73,8 @@ tachyon_cc_library(
 )
 
 tachyon_cc_library(
-    name = "column",
-    hdrs = ["column.h"],
+    name = "column_key",
+    hdrs = ["column_key.h"],
     deps = [
         ":column_type",
         ":phase",
@@ -84,10 +84,10 @@ tachyon_cc_library(
 )
 
 tachyon_cc_library(
-    name = "column_stringifier",
-    hdrs = ["column_stringifier.h"],
+    name = "column_key_stringifier",
+    hdrs = ["column_key_stringifier.h"],
     deps = [
-        ":column",
+        ":column_key",
         ":column_type_stringifier",
     ],
 )
@@ -108,16 +108,6 @@ tachyon_cc_library(
     ],
 )
 
-tachyon_cc_library(
-    name = "columns",
-    hdrs = ["columns.h"],
-    deps = [
-        ":column",
-        "//tachyon/base:logging",
-        "//tachyon/zk/base:ref",
-    ],
-)
-
 tachyon_cc_library(
     name = "constraint",
     hdrs = ["constraint.h"],
@@ -148,14 +138,34 @@ tachyon_cc_library(
     ],
     deps = [
         ":challenge",
+        ":lookup_table",
         ":region",
-        ":table",
         "//tachyon/base/functional:callback",
         "//tachyon/zk/plonk:constraint_system",
         "//tachyon/zk/plonk:error",
     ],
 )
 
+tachyon_cc_library(
+    name = "lookup_table",
+    hdrs = ["lookup_table.h"],
+    deps = [
+        ":lookup_table_column",
+        "//tachyon/math/base:rational_field",
+        "//tachyon/zk/base:value",
+        "//tachyon/zk/plonk:error",
+    ],
+)
+
+tachyon_cc_library(
+    name = "lookup_table_column",
+    hdrs = ["lookup_table_column.h"],
+    deps = [
+        ":column_key",
+        "//tachyon:export",
+    ],
+)
+
 tachyon_cc_library(
     name = "phase",
     hdrs = ["phase.h"],
@@ -175,7 +185,7 @@ tachyon_cc_library(
     name = "query",
     hdrs = ["query.h"],
     deps = [
-        ":column",
+        ":column_key",
         ":rotation",
     ],
 )
@@ -184,7 +194,7 @@ tachyon_cc_library(
     name = "query_stringifier",
     hdrs = ["query_stringifier.h"],
     deps = [
-        ":column_stringifier",
+        ":column_key_stringifier",
         ":query",
         ":rotation_stringifier",
     ],
@@ -195,7 +205,7 @@ tachyon_cc_library(
     hdrs = ["region.h"],
     deps = [
         ":assigned_cell",
-        ":column",
+        ":column_key",
         ":selector",
         "//tachyon/base/functional:callback",
         "//tachyon/zk/plonk:error",
@@ -206,7 +216,7 @@ tachyon_cc_library(
     name = "region_column",
     hdrs = ["region_column.h"],
     deps = [
-        ":column",
+        ":column_key",
         ":selector",
     ],
 )
@@ -281,27 +291,17 @@ tachyon_cc_library(
     name = "table",
     hdrs = ["table.h"],
     deps = [
-        ":table_column",
-        "//tachyon/math/base:rational_field",
-        "//tachyon/zk/base:value",
-        "//tachyon/zk/plonk:error",
-    ],
-)
-
-tachyon_cc_library(
-    name = "table_column",
-    hdrs = ["table_column.h"],
-    deps = [
-        ":column",
-        "//tachyon:export",
+        ":column_key",
+        "//tachyon/base:logging",
+        "//tachyon/zk/base:ref",
     ],
 )
 
 tachyon_cc_library(
     name = "virtual_cell",
     hdrs = ["virtual_cell.h"],
     deps = [
-        ":column",
+        ":column_key",
         ":rotation",
         "//tachyon:export",
     ],
@@ -320,14 +320,14 @@ tachyon_cc_library(
 tachyon_cc_unittest(
     name = "circuit_unittests",
     srcs = [
-        "column_unittest.cc",
-        "columns_unittest.cc",
+        "column_key_unittest.cc",
         "rotation_unittest.cc",
+        "table_unittest.cc",
     ],
     deps = [
-        ":column",
-        ":columns",
+        ":column_key",
         ":rotation",
+        ":table",
         "//tachyon/math/elliptic_curves/bn/bn254:g1",
         "//tachyon/math/finite_fields/test:gf7",
         "//tachyon/math/polynomials/univariate:univariate_polynomial",

tachyon/zk/plonk/circuit/assembly.h

@@ -54,7 +54,7 @@ class Assembly : public Assignment<typename PCSTy::Field> {
     return Error::kNone;
   }
 
-  Error QueryInstance(const InstanceColumn& column, size_t row,
+  Error QueryInstance(const InstanceColumnKey& column, size_t row,
                       Value<F>* instance) override {
     if (!usable_rows_.Contains(row)) {
       return Error::kNotEnoughRowsAvailable;
@@ -63,7 +63,7 @@ class Assembly : public Assignment<typename PCSTy::Field> {
     return Error::kNone;
   }
 
-  Error AssignFixed(const FixedColumn& column, size_t row,
+  Error AssignFixed(const FixedColumnKey& column, size_t row,
                     AssignCallback assign) override {
     if (!usable_rows_.Contains(row)) {
       return Error::kNotEnoughRowsAvailable;
@@ -72,16 +72,16 @@ class Assembly : public Assignment<typename PCSTy::Field> {
     return Error::kNone;
   }
 
-  Error Copy(const AnyColumn& left_column, size_t left_row,
-             const AnyColumn& right_column, size_t right_row) override {
+  Error Copy(const AnyColumnKey& left_column, size_t left_row,
+             const AnyColumnKey& right_column, size_t right_row) override {
     if (!(usable_rows_.Contains(left_row) &&
           usable_rows_.Contains(right_row))) {
       return Error::kNotEnoughRowsAvailable;
     }
     return permutation_.Copy(left_column, left_row, right_column, right_row);
   }
 
-  Error FillFromRow(const FixedColumn& column, size_t from_row,
+  Error FillFromRow(const FixedColumnKey& column, size_t from_row,
                     AssignCallback assign) override {
     if (!usable_rows_.Contains(from_row)) {
       return Error::kNotEnoughRowsAvailable;

tachyon/zk/plonk/circuit/assigned_cell.h

@@ -34,7 +34,7 @@ class AssignedCell {
   // Returns an error if either this cell or the given cell are in columns
   // where equality has not been enabled.
   Error CopyAdvice(std::string_view name, Region<F>& region,
-                   const AdviceColumn& column, size_t offset,
+                   const AdviceColumnKey& column, size_t offset,
                    AssignedCell<F>* assigned_cell) const;
 
   std::string ToString() const {

tachyon/zk/plonk/circuit/assignment.h

@@ -16,7 +16,7 @@
 #include "tachyon/math/base/rational_field.h"
 #include "tachyon/zk/base/value.h"
 #include "tachyon/zk/plonk/circuit/challenge.h"
-#include "tachyon/zk/plonk/circuit/column.h"
+#include "tachyon/zk/plonk/circuit/column_key.h"
 #include "tachyon/zk/plonk/circuit/selector.h"
 #include "tachyon/zk/plonk/error.h"
 
@@ -41,7 +41,7 @@ class Assignment {
   // within a |Region|.
   //
   // This is usually useful for debugging circuit failures.
-  virtual void NameColumn(std::string_view name, const AnyColumn& column) {}
+  virtual void NameColumn(std::string_view name, const AnyColumnKey& column) {}
 
   // Exits the current region.
   //
@@ -62,31 +62,32 @@ class Assignment {
   //
   // Returns |Error::kNone| and populates |instance| with the cell's value, if
   // known.
-  virtual Error QueryInstance(const InstanceColumn& column, size_t row,
+  virtual Error QueryInstance(const InstanceColumnKey& column, size_t row,
                               Value<F>* instance) {
     return Error::kNone;
   }
 
   // Assign an advice column value (witness).
-  virtual Error AssignAdvice(std::string_view name, const AdviceColumn& column,
-                             size_t row, AssignCallback assign) {
+  virtual Error AssignAdvice(std::string_view name,
+                             const AdviceColumnKey& column, size_t row,
+                             AssignCallback assign) {
     return Error::kNone;
   }
 
   // Assign a fixed value.
-  virtual Error AssignFixed(std::string_view name, const FixedColumn& column,
+  virtual Error AssignFixed(std::string_view name, const FixedColumnKey& column,
                             size_t row, AssignCallback assign) {
     return Error::kNone;
   }
 
   // Assign two cells to have the same value
-  virtual Error Copy(const AnyColumn& left_column, size_t left_row,
-                     const AnyColumn& right_column, size_t right_row) {
+  virtual Error Copy(const AnyColumnKey& left_column, size_t left_row,
+                     const AnyColumnKey& right_column, size_t right_row) {
     return Error::kNone;
   }
 
   // Fills a fixed |column| starting from the given |row| with value |assign|.
-  virtual Error FillFromRow(const FixedColumn& column, size_t row,
+  virtual Error FillFromRow(const FixedColumnKey& column, size_t row,
                             AssignCallback assign) {
     return Error::kNone;
   }

tachyon/zk/plonk/circuit/cell.h

@@ -14,20 +14,20 @@
 #include "absl/strings/substitute.h"
 
 #include "tachyon/export.h"
-#include "tachyon/zk/plonk/circuit/column.h"
+#include "tachyon/zk/plonk/circuit/column_key.h"
 
 namespace tachyon::zk {
 
 // A pointer to a cell within a circuit.
 class TACHYON_EXPORT Cell {
  public:
   Cell() = default;
-  Cell(size_t region_index, size_t row_offset, const AnyColumn& column)
+  Cell(size_t region_index, size_t row_offset, const AnyColumnKey& column)
       : region_index_(region_index), row_offset_(row_offset), column_(column) {}
 
   size_t region_index() const { return region_index_; }
   size_t row_offset() const { return row_offset_; }
-  const AnyColumn& column() const { return column_; }
+  const AnyColumnKey& column() const { return column_; }
 
   std::string ToString() const {
     return absl::Substitute("{region_index: $0, row_offset: $1, column: $2}",
@@ -40,7 +40,7 @@ class TACHYON_EXPORT Cell {
   // The relative offset of this cell within its region.
   size_t row_offset_ = 0;
   // The column of this cell.
-  AnyColumn column_;
+  AnyColumnKey column_;
 };
 
 }  // namespace tachyon::zk