Struct halo2_proofs::plonk::ConstraintSystem

pub struct ConstraintSystem<F>
where
    F: Field,
{ /* private fields */ }

This is a description of the circuit environment, such as the gate, column and permutation arrangements.

Implementations

impl<F> ConstraintSystem<F>

where F: Field,

pub fn enable_constant(&mut self, column: Column<Fixed>)

Enables this fixed column to be used for global constant assignments.

Side-effects

The column will be equality-enabled.

pub fn enable_equality<C>(&mut self, column: C)

where C: Into<Column<Any>>,

Enable the ability to enforce equality over cells in this column

pub fn lookup<S>( &mut self, name: S, table_map: impl FnOnce(&mut VirtualCells<'_, F>) -> Vec<(Expression<F>, TableColumn)> ) -> usize

where S: AsRef<str>,

Add a lookup argument for some input expressions and table columns.

table_map returns a map between input expressions and the table columns they need to match.

pub fn lookup_any<S>( &mut self, name: S, table_map: impl FnOnce(&mut VirtualCells<'_, F>) -> Vec<(Expression<F>, Expression<F>)> ) -> usize

where S: AsRef<str>,

Add a lookup argument for some input expressions and table expressions.

table_map returns a map between input expressions and the table expressions they need to match.

NOTE:
We should use extra Fixed column or Selector for tagging the table rows.
Also, it is needed to include a pair of tagging expressions([lookup_activator, table_activator]) in the table_map. Otherwise, we have soundness error.(See here)
For correct use, please reference here and here.

pub fn shuffle<S>( &mut self, name: S, shuffle_map: impl FnOnce(&mut VirtualCells<'_, F>) -> Vec<(Expression<F>, Expression<F>)> ) -> usize

where S: AsRef<str>,

Add a shuffle argument for some input expressions and table expressions.

pub fn get_any_query_index(&self, column: Column<Any>, at: Rotation) -> usize

pub fn set_minimum_degree(&mut self, degree: usize)

Sets the minimum degree required by the circuit, which can be set to a larger amount than actually needed. This can be used, for example, to force the permutation argument to involve more columns in the same set.

pub fn create_gate<C, Iter, S>( &mut self, name: S, constraints: impl FnOnce(&mut VirtualCells<'_, F>) -> Iter )

where C: Into<Constraint<F>>, Iter: IntoIterator<Item = C>, S: AsRef<str>,

Creates a new gate.

Panics

A gate is required to contain polynomial constraints. This method will panic if constraints returns an empty iterator.

pub fn compress_selectors( self, selectors: Vec<Vec<bool>> ) -> (ConstraintSystem<F>, Vec<Vec<F>>)

This will compress selectors together depending on their provided assignments. This ConstraintSystem will then be modified to add new fixed columns (representing the actual selectors) and will return the polynomials for those columns. Finally, an internal map is updated to find which fixed column corresponds with a given Selector.

Do not call this twice. Yes, this should be a builder pattern instead.

pub fn directly_convert_selectors_to_fixed( self, selectors: Vec<Vec<bool>> ) -> (ConstraintSystem<F>, Vec<Vec<F>>)

Does not combine selectors and directly replaces them everywhere with fixed columns.

pub fn selector(&mut self) -> Selector

Allocate a new (simple) selector. Simple selectors cannot be added to expressions nor multiplied by other expressions containing simple selectors. Also, simple selectors may not appear in lookup argument inputs.

pub fn complex_selector(&mut self) -> Selector

Allocate a new complex selector that can appear anywhere within expressions.

pub fn lookup_table_column(&mut self) -> TableColumn

Allocates a new fixed column that can be used in a lookup table.

pub fn annotate_lookup_column<A, AR>( &mut self, column: TableColumn, annotation: A )

where A: Fn() -> AR, AR: Into<String>,

Annotate a Lookup column.

pub fn annotate_lookup_any_column<A, AR, T>(&mut self, column: T, annotation: A)

where A: Fn() -> AR, AR: Into<String>, T: Into<Column<Any>>,

Annotate an Instance column.

pub fn annotate_column<A, AR, T>(&mut self, column: T, annotation: A)

where A: Fn() -> AR, AR: Into<String>, T: Into<Column<Any>>,

Annotate a column.

pub fn fixed_column(&mut self) -> Column<Fixed>

Allocate a new fixed column

pub fn unblinded_advice_column(&mut self) -> Column<Advice>

Allocate a new unblinded advice column at FirstPhase

pub fn advice_column(&mut self) -> Column<Advice>

Allocate a new advice column at FirstPhase

pub fn unblinded_advice_column_in<P>(&mut self, phase: P) -> Column<Advice>

where P: Phase,

Allocate a new unblinded advice column in given phase. This allows for the generation of deterministic commitments to advice columns which can be used to split large circuits into smaller ones, whose proofs can then be “joined” together by their common witness commitments.

pub fn advice_column_in<P>(&mut self, phase: P) -> Column<Advice>

where P: Phase,

Allocate a new advice column in given phase

Panics

It panics if previous phase before the given one doesn’t have advice column allocated.

pub fn instance_column(&mut self) -> Column<Instance>

Allocate a new instance column

pub fn challenge_usable_after<P>(&mut self, phase: P) -> Challenge

where P: Phase,

Requests a challenge that is usable after the given phase.

Panics

It panics if the given phase doesn’t have advice column allocated.

pub fn phases(&self) -> impl Iterator<Item = Phase>

Returns the list of phases

pub fn degree(&self) -> usize

Compute the degree of the constraint system (the maximum degree of all constraints).

pub fn blinding_factors(&self) -> usize

Compute the number of blinding factors necessary to perfectly blind each of the prover’s witness polynomials.

pub fn minimum_rows(&self) -> usize

Returns the minimum necessary rows that need to exist in order to account for e.g. blinding factors.

pub fn num_fixed_columns(&self) -> usize

Returns number of fixed columns

pub fn num_advice_columns(&self) -> usize

Returns number of advice columns

pub fn num_instance_columns(&self) -> usize

Returns number of instance columns

pub fn num_selectors(&self) -> usize

Returns number of selectors

pub fn num_challenges(&self) -> usize

Returns number of challenges

pub fn advice_column_phase(&self) -> Vec<u8>

Returns phase of advice columns

pub fn challenge_phase(&self) -> Vec<u8>

Returns phase of challenges

pub fn gates(&self) -> &Vec<Gate<F>>

Returns gates

pub fn general_column_annotations(&self) -> &HashMap<ColumnMid, String>

Returns general column annotations

pub fn advice_queries(&self) -> &Vec<(Column<Advice>, Rotation)>

Returns advice queries

pub fn instance_queries(&self) -> &Vec<(Column<Instance>, Rotation)>

Returns instance queries

pub fn fixed_queries(&self) -> &Vec<(Column<Fixed>, Rotation)>

Returns fixed queries

pub fn permutation(&self) -> &Argument

Returns permutation argument

pub fn lookups(&self) -> &Vec<Argument<F>>

Returns lookup arguments

pub fn shuffles(&self) -> &Vec<Argument<F>>

Returns shuffle arguments

pub fn constants(&self) -> &Vec<Column<Fixed>>

Returns constants

Trait Implementations

impl<F> Clone for ConstraintSystem<F>

where F: Clone + Field,

fn clone(&self) -> ConstraintSystem<F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F> Debug for ConstraintSystem<F>

where F: Debug + Field,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<F> Default for ConstraintSystem<F>

where F: Field,

fn default() -> ConstraintSystem<F>

Returns the “default value” for a type.

impl<F> From<ConstraintSystem<F>> for ConstraintSystemMid<F>

where F: Field,

fn from(cs: ConstraintSystem<F>) -> ConstraintSystemMid<F>

Converts to this type from the input type.