Struct darkfi::zk::halo2::plonk::ConstraintSystem

pub struct ConstraintSystem<F>
where
    F: Field,
{

    pub(crate) num_fixed_columns: usize,
    pub(crate) num_advice_columns: usize,
    pub(crate) num_instance_columns: usize,
    pub(crate) num_selectors: usize,
    pub(crate) selector_map: Vec<Column<Fixed>>,
    pub(crate) gates: Vec<Gate<F>>,
    pub(crate) advice_queries: Vec<(Column<Advice>, Rotation)>,
    num_advice_queries: Vec<usize>,
    pub(crate) instance_queries: Vec<(Column<Instance>, Rotation)>,
    pub(crate) fixed_queries: Vec<(Column<Fixed>, Rotation)>,
    pub(crate) permutation: Argument,
    pub(crate) lookups: Vec<Argument<F>>,
    pub(crate) constants: Vec<Column<Fixed>>,
    pub(crate) minimum_degree: Option<usize>,
}

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

Fields

num_fixed_columns: usize

num_advice_columns: usize

num_instance_columns: usize

num_selectors: usize

selector_map: Vec<Column<Fixed>>

gates: Vec<Gate<F>>

advice_queries: Vec<(Column<Advice>, Rotation)>

num_advice_queries: Vec<usize>

instance_queries: Vec<(Column<Instance>, Rotation)>

fixed_queries: Vec<(Column<Fixed>, Rotation)>

permutation: Argument

lookups: Vec<Argument<F>>

constants: Vec<Column<Fixed>>

minimum_degree: Option<usize>

Implementations

impl<F> ConstraintSystem<F>

where F: Field,

pub fn pinned(&self) -> PinnedConstraintSystem<'_, F>

Obtain a pinned version of this constraint system; a structure with the minimal parameters needed to determine the rest of the constraint system.

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( &mut self, table_map: impl FnOnce(&mut VirtualCells<'_, F>) -> Vec<(Expression<F>, TableColumn)>, ) -> usize

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 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>( &mut self, name: &'static str, constraints: impl FnOnce(&mut VirtualCells<'_, F>) -> Iter, )

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

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 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 fixed_column(&mut self) -> Column<Fixed>

Allocate a new fixed column

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

Allocate a new advice column

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

Allocate a new instance column

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 get_num_fixed_columns(&self) -> usize

Return self.num_fixed_columns

pub fn get_num_advice_columns(&self) -> usize

Return self.num_advice_columns

pub fn get_num_instance_columns(&self) -> usize

Return self.num_instance_columns

pub fn get_num_selectors(&self) -> usize

Return self.num_selectors

pub fn get_selector_map(&self) -> &[Column<Fixed>]

Return self.selector_map

pub fn get_gates(&self) -> &[Gate<F>]

Return self.gates

pub fn get_advice_queries(&self) -> &[(Column<Advice>, Rotation)]

Return self.advice_queries

pub fn get_num_advice_queries(&self) -> &[usize]

Return self.num_advice_queries

pub fn get_instance_queries(&self) -> &[(Column<Instance>, Rotation)]

Return self.instance_queries

pub fn get_fixed_queries(&self) -> &[(Column<Fixed>, Rotation)]

Return self.fixed_queries

pub fn get_permutation(&self) -> &Argument

Return self.permutation

pub fn get_lookups(&self) -> &[Argument<F>]

Return self.lookups

pub fn get_constants(&self) -> &[Column<Fixed>]

Return self.constants

pub fn get_minimum_degree(&self) -> &Option<usize>

Return self.minimum_degree

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.