Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: rename "AssignmentError" as "AssignError"
Browse files Browse the repository at this point in the history
guorong009 committed Sep 18, 2024
1 parent 2bbf733 commit 4ffff57
Showing 4 changed files with 29 additions and 29 deletions.
8 changes: 4 additions & 4 deletions halo2_frontend/src/circuit.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Traits and structs for implementing circuit components.
use crate::plonk::{self, AssignmentError};
use crate::plonk::{self, AssignError};
use crate::plonk::{
permutation,
sealed::{self, SealedPhase},
@@ -154,7 +154,7 @@ impl<'a, F: Field> Assignment<F> for WitnessCollection<'a, F> {

fn query_instance(&self, column: Column<Instance>, row: usize) -> Result<Value<F>, Error> {
if !self.usable_rows.contains(&row) {
return Err(Error::AssignmentError(AssignmentError::QueryInstance {
return Err(Error::AssignError(AssignError::QueryInstance {
col: column.into(),
row,
usable_rows: (0, self.usable_rows.end),
@@ -189,7 +189,7 @@ impl<'a, F: Field> Assignment<F> for WitnessCollection<'a, F> {
}

if !self.usable_rows.contains(&row) {
return Err(Error::AssignmentError(AssignmentError::AssignAdvice {
return Err(Error::AssignError(AssignError::AssignAdvice {
desc: desc().into(),
col: column.into(),
row,
@@ -201,7 +201,7 @@ impl<'a, F: Field> Assignment<F> for WitnessCollection<'a, F> {
let value = match to().into_field().assign() {
Ok(v) => v,
Err(_) => {
return Err(Error::AssignmentError(AssignmentError::WitnessMissing {
return Err(Error::AssignError(AssignError::WitnessMissing {
func: "assign_advice".to_string(),
desc: desc().into(),
}))
18 changes: 9 additions & 9 deletions halo2_frontend/src/dev.rs
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ use std::ops::{Add, Mul, Neg, Range};

use blake2b_simd::blake2b;

use crate::plonk::AssignmentError;
use crate::plonk::AssignError;
use crate::{
circuit,
plonk::{
@@ -415,7 +415,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
}

if !self.usable_rows.contains(&row) {
return Err(Error::AssignmentError(AssignmentError::EnableSelector {
return Err(Error::AssignError(AssignError::EnableSelector {
desc: desc().into(),
selector: *selector,
row,
@@ -445,7 +445,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
row: usize,
) -> Result<circuit::Value<F>, Error> {
if !self.usable_rows.contains(&row) {
return Err(Error::AssignmentError(AssignmentError::QueryInstance {
return Err(Error::AssignError(AssignError::QueryInstance {
col: column.into(),
row,
usable_rows: (self.usable_rows.start, self.usable_rows.end),
@@ -476,7 +476,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
{
if self.in_phase(FirstPhase) {
if !self.usable_rows.contains(&row) {
return Err(Error::AssignmentError(AssignmentError::AssignAdvice {
return Err(Error::AssignError(AssignError::AssignAdvice {
desc: desc().into(),
col: column.into(),
row,
@@ -508,7 +508,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
// Propagate `assign` error if the column is in current phase.
let phase = self.cs.advice_column_phase[column.index];
if self.in_phase(phase) {
return Err(Error::AssignmentError(AssignmentError::WitnessMissing {
return Err(Error::AssignError(AssignError::WitnessMissing {
func: "assign_advice".to_string(),
desc: desc().into(),
}));
@@ -537,7 +537,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
}

if !self.usable_rows.contains(&row) {
return Err(Error::AssignmentError(AssignmentError::AssignFixed {
return Err(Error::AssignError(AssignError::AssignFixed {
desc: desc().into(),
col: column.into(),
row,
@@ -558,7 +558,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
let value = match to().into_field().evaluate().assign() {
Ok(v) => CellValue::Assigned(v),
Err(_) => {
return Err(Error::AssignmentError(AssignmentError::WitnessMissing {
return Err(Error::AssignError(AssignError::WitnessMissing {
func: "assign_fixed".to_string(),
desc: desc().into(),
}))
@@ -586,7 +586,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
}

if !self.usable_rows.contains(&left_row) || !self.usable_rows.contains(&right_row) {
return Err(Error::AssignmentError(AssignmentError::Copy {
return Err(Error::AssignError(AssignError::Copy {
left_col: left_column,
left_row,
right_col: right_column,
@@ -611,7 +611,7 @@ impl<F: Field> Assignment<F> for MockProver<F> {
}

if !self.usable_rows.contains(&from_row) {
return Err(Error::AssignmentError(AssignmentError::FillFromRow {
return Err(Error::AssignError(AssignError::FillFromRow {
col: col.into(),
from_row,
usable_rows: (self.usable_rows.start, self.usable_rows.end),
26 changes: 13 additions & 13 deletions halo2_frontend/src/plonk/error.rs
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ use halo2_middleware::circuit::Any;

/// This is an error that could occur during circuit synthesis.
///
/// **NOTE**: [`AssignmentError`] is introduced to provide more debugging info
/// **NOTE**: [`AssignError`] is introduced to provide more debugging info
/// to developers when assigning witnesses to circuit cells.
/// Hence, they are used for [`MockProver`] and [`WitnessCollection`].

Check warning on line 11 in halo2_frontend/src/plonk/error.rs

GitHub Actions / Intra-doc links

unresolved link to `MockProver`

Check warning on line 11 in halo2_frontend/src/plonk/error.rs

GitHub Actions / Intra-doc links

unresolved link to `WitnessCollection`
/// The [`keygen`] process use the [`NotEnoughRowsAvailable`], since it is just enough.

Check warning on line 12 in halo2_frontend/src/plonk/error.rs

GitHub Actions / Intra-doc links

unresolved link to `keygen`

Check warning on line 12 in halo2_frontend/src/plonk/error.rs

GitHub Actions / Intra-doc links

unresolved link to `NotEnoughRowsAvailable`
@@ -32,8 +32,8 @@ pub enum Error {
ColumnNotInPermutation(Column<Any>),
/// An error relating to a lookup table.
TableError(TableError),
/// An error relating to an `Assignment`.
AssignmentError(AssignmentError),
/// An error relating to a circuit assignment.
AssignError(AssignError),
/// Generic error not covered by previous cases
Other(String),
}
@@ -65,7 +65,7 @@ impl fmt::Display for Error {
"Column {column:?} must be included in the permutation. Help: try applying `meta.enable_equalty` on the column",
),
Error::TableError(error) => write!(f, "{error}"),
Error::AssignmentError(error) => write!(f, "{error}"),
Error::AssignError(error) => write!(f, "{error}"),
Error::Other(error) => write!(f, "Other: {error}"),
}
}
@@ -112,7 +112,7 @@ impl fmt::Display for TableError {

/// This is an error that could occur during `assign_advice`, `assign_fixed`, `copy`, etc.
#[derive(Debug)]
pub enum AssignmentError {
pub enum AssignError {
AssignAdvice {
desc: String,
col: Column<Any>,
@@ -160,10 +160,10 @@ pub enum AssignmentError {
},
}

impl fmt::Display for AssignmentError {
impl fmt::Display for AssignError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
AssignmentError::AssignAdvice { desc, col, row, usable_rows:(start, end), k } => write!(
AssignError::AssignAdvice { desc, col, row, usable_rows:(start, end), k } => write!(
f,
"assign_advice `{}` error: column={:?}({}), row={}, usable_rows={}..{}, k={}",
desc,
@@ -173,7 +173,7 @@ impl fmt::Display for AssignmentError {
start, end,
k,
),
AssignmentError::AssignFixed {desc, col, row, usable_rows: (start, end), k } => write!(
AssignError::AssignFixed {desc, col, row, usable_rows: (start, end), k } => write!(
f,
"assign_fixed `{}` error: column={:?}({}), row={}, usable_rows={}..{}, k={}",
desc,
@@ -183,7 +183,7 @@ impl fmt::Display for AssignmentError {
start, end,
k,
),
AssignmentError::EnableSelector { desc, selector, row, usable_rows: (start, end), k } => write!(
AssignError::EnableSelector { desc, selector, row, usable_rows: (start, end), k } => write!(
f,
"enable_selector `{}` error: column=Selector({:?}), row={}, usable_rows={}..{}, k={}",
desc,
@@ -192,7 +192,7 @@ impl fmt::Display for AssignmentError {
start, end,
k,
),
AssignmentError::QueryInstance { col, row, usable_rows:(start, end), k } => write!(
AssignError::QueryInstance { col, row, usable_rows:(start, end), k } => write!(
f,
"query_instance error: column={:?}({}), row={}, usable_rows={}..{}, k={}",
col.column_type,
@@ -202,7 +202,7 @@ impl fmt::Display for AssignmentError {
end,
k,
),
AssignmentError::Copy { left_col, left_row, right_col, right_row, usable_rows:(start, end), k } => write!(
AssignError::Copy { left_col, left_row, right_col, right_row, usable_rows:(start, end), k } => write!(
f,
"copy error: left_column={:?}({}), left_row={}, right_column={:?}({}), right_row={}, usable_rows={}..{}, k={}",
left_col.column_type(),
@@ -214,7 +214,7 @@ impl fmt::Display for AssignmentError {
start, end,
k,
),
AssignmentError::FillFromRow { col, from_row, usable_rows:(start, end), k } => write!(
AssignError::FillFromRow { col, from_row, usable_rows:(start, end), k } => write!(
f,
"fill_from_row error: column={:?}({}), from_row={}, usable_rows={}..{}, k={}",
col.column_type(),
@@ -223,7 +223,7 @@ impl fmt::Display for AssignmentError {
start, end,
k,
),
AssignmentError::WitnessMissing { func, desc } => write!(f, "witness missing/unknown when {} `{}`", func, desc),
AssignError::WitnessMissing { func, desc } => write!(f, "witness missing/unknown when {} `{}`", func, desc),
}
}
}
6 changes: 3 additions & 3 deletions halo2_frontend/src/plonk/keygen.rs
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@ use halo2_middleware::ff::Field;

use crate::circuit::Value;
use crate::plonk::{
permutation, Advice, Assigned, Assignment, AssignmentError, Challenge, Column, Error, Fixed,
permutation, Advice, AssignError, Assigned, Assignment, Challenge, Column, Error, Fixed,
Instance, Selector,
};

@@ -94,7 +94,7 @@ impl<F: Field> Assignment<F> for Assembly<F> {
let value = match to().into_field().assign() {
Ok(v) => v,
Err(_) => {
return Err(Error::AssignmentError(AssignmentError::WitnessMissing {
return Err(Error::AssignError(AssignError::WitnessMissing {
func: "assign_fixed".to_string(),
desc: desc().into(),
}))
@@ -143,7 +143,7 @@ impl<F: Field> Assignment<F> for Assembly<F> {
let filler = match to.assign() {
Ok(v) => v,
Err(_) => {
return Err(Error::AssignmentError(AssignmentError::WitnessMissing {
return Err(Error::AssignError(AssignError::WitnessMissing {
func: "fill_from_row".to_string(),
desc: "".to_string(),
}))

0 comments on commit 4ffff57

Please sign in to comment.