Struct ConstraintSystemExt 

pub struct ConstraintSystemExt<F: Field, const ARITH_ENABLED: bool, const ASSIGNMENTS_ENABLED: bool> { /* private fields */ }

ConstraintSystemExt wraps a ConstraintSystemRef with compile-time flags that control whether constraint matrices (ARITH_ENABLED) and / or assignment vectors (ASSIGNMENTS_ENABLED) are collected during synthesis.

Implementations

impl<F: Field, const ARITH_ENABLED: bool, const ASSIGNMENTS_ENABLED: bool> ConstraintSystemExt<F, ARITH_ENABLED, ASSIGNMENTS_ENABLED>

pub fn new() -> Self

ConstraintSystemExt::new creates a new constraint system wrapper with the specified flags.

pub fn execute_synthesizer( &self, circuit: impl ConstraintSynthesizer<F>, ) -> Result<(), SynthesisError>

ConstraintSystemExt::execute_synthesizer executes a circuit inside the constraint system, where the circuit should implement the ConstraintSynthesizer trait.

pub fn execute_fn<R>( &self, circuit: impl FnOnce(ConstraintSystemRef<F>) -> Result<R, SynthesisError>, ) -> Result<R, SynthesisError>

ConstraintSystemExt::execute_fn executes a circuit inside the constraint system, where the circuit should be defined as a closure that takes as input a ConstraintSystemRef and returns a result of type R. The return value of the closure will be returned by this method.

impl<F: Field> ConstraintSystemExt<F, true, false>

pub fn arith<A: From<ConstraintSystem<F>>>(self) -> Result<A, SynthesisError>

ArithExtractor::arith extracts the constraint matrices from the circuit and returns them as an arithmetization / constraint system structure of type A.

impl<F: Field> ConstraintSystemExt<F, false, true>

pub fn assignments(self) -> Result<Assignments<F, Vec<F>>, SynthesisError>

AssignmentsExtractor::assignments extracts the assignments from the circuit and returns them as Assignments.

Methods from Deref<Target = ConstraintSystemRef<F>>

pub fn get_all_predicates_num_constraints( &self, ) -> IndexMap<String, usize, SeedableRandomState>

Returns the number of constraints in each predicate

pub fn get_predicates_num_constraints( &self, predicate_label: &str, ) -> Option<usize>

Returns the number of constraints in the predicate with the given label

pub fn get_all_predicate_arities( &self, ) -> IndexMap<String, usize, SeedableRandomState>

Returns the arity of each predicate

pub fn get_predicate_arity(&self, predicate_label: &str) -> Option<usize>

Returns the predicate type of the predicate with the given label

pub fn get_all_predicate_types(&self) -> BTreeMap<String, Predicate<F>>

Returns the predicate types of each predicate

pub fn get_predicate_type(&self, predicate_label: &str) -> Option<Predicate<F>>

Returns the predicate type of the predicate with the given label

pub fn num_constraints(&self) -> usize

Returns the number of constraints which is the sum of the number of constraints in each predicate. #[inline]

pub fn num_instance_variables(&self) -> usize

Returns the number of instance variables.

pub fn instance_assignment(&self) -> Result<Vec<F>, SynthesisError>

Returns the number of instance variables.

pub fn witness_assignment(&self) -> Result<Vec<F>, SynthesisError>

Returns the number of instance variables.

pub fn num_variables(&self) -> usize

Returns the number of instance variables.

pub fn num_predicates(&self) -> usize

Returns the number of predicates.

pub fn num_witness_variables(&self) -> usize

Returns the number of witness variables.

pub fn enforce_constraint( &self, predicate_label: &str, lc_vec: impl IntoIterator LinearCombination>, IntoIter : ExactSizeIterator>, ) -> Result<(), SynthesisError>

where <impl IntoIterator<Item = Box<dyn FnOnce() -> LinearCombination<F>>> as IntoIterator>::IntoIter: ExactSizeIterator,

Enforce a constraint in the constraint system. It takes a predicate name and enforces a vector of linear combinations of the length of the arity of the predicate enforces the constraint.

pub fn enforce_constraint_arity_2( &self, predicate_label: &str, a: impl FnOnce() -> LinearCombination<F>, b: impl FnOnce() -> LinearCombination<F>, ) -> Result<(), SynthesisError>

Enforce a constraint with arity 2.

pub fn enforce_constraint_arity_3( &self, predicate_label: &str, a: impl FnOnce() -> LinearCombination<F>, b: impl FnOnce() -> LinearCombination<F>, c: impl FnOnce() -> LinearCombination<F>, ) -> Result<(), SynthesisError>

Enforce a constraint with arity 3.

pub fn enforce_constraint_arity_4( &self, predicate_label: &str, a: impl FnOnce() -> LinearCombination<F>, b: impl FnOnce() -> LinearCombination<F>, c: impl FnOnce() -> LinearCombination<F>, d: impl FnOnce() -> LinearCombination<F>, ) -> Result<(), SynthesisError>

Enforce a constraint with arity 4.

pub fn enforce_constraint_arity_5( &self, predicate_label: &str, a: impl FnOnce() -> LinearCombination<F>, b: impl FnOnce() -> LinearCombination<F>, c: impl FnOnce() -> LinearCombination<F>, d: impl FnOnce() -> LinearCombination<F>, e: impl FnOnce() -> LinearCombination<F>, ) -> Result<(), SynthesisError>

Enforce a constraint with arity 5.

pub fn enforce_r1cs_constraint( &self, a: impl FnOnce() -> LinearCombination<F>, b: impl FnOnce() -> LinearCombination<F>, c: impl FnOnce() -> LinearCombination<F>, ) -> Result<(), SynthesisError>

Enforce an R1CS constraint in the constraint system. On input a, b, and c, this method enforces that a * b = c. If the R1CS predicate has not been already added, this method will add it.

This method is a special case of enforce_constraint and is used to provide a low-effort way to port prior code that assumed that R1CS is the only kind of predicate.

pub fn enforce_sr1cs_constraint( &self, a: impl FnOnce() -> LinearCombination<F>, b: impl FnOnce() -> LinearCombination<F>, ) -> Result<(), SynthesisError>

Enforce a SquareR1CS constraint in the constraint system. On input a and b, this method enforces that a^2 = b. If the SquareR1CS predicate has not been added to the constraint system, this method will add it. This method is a special case of enforce_constraint.

pub fn new_lc( &self, lc: impl FnOnce() -> LinearCombination<F>, ) -> Result<Variable, SynthesisError>

Obtain a new variable representing the linear combination lc.

pub fn set_mode(&self, mode: SynthesisMode)

Set self.mode to mode. Sets the mode if there exists an underlying ConstraintSystem.

pub fn is_in_setup_mode(&self) -> bool

Check whether self.mode == SynthesisMode::Setup. Returns true if

1. There is an underlying ConstraintSystem and,
2. It is in setup mode.

pub fn optimization_goal(&self) -> OptimizationGoal

Check whether this constraint system aims to optimize weight, number of constraints, or neither.

pub fn set_optimization_goal(&self, goal: OptimizationGoal)

Specify whether this constraint system should aim to optimize weight, number of constraints, or neither.

pub fn should_outline_instances(&self) -> bool

Should we outline instances according to the optimization specified in Section 3, Page 11 of Polymath By default, this flag is false.

pub fn set_instance_outliner(&self, outliner: InstanceOutliner<F>)

Specify the strategy for how the instance should be outlined. This should be compatible with the predicates in the constraint system.

pub fn should_construct_matrices(&self) -> bool

Check whether or not self will construct matrices.

pub fn new_input_variable<Func>( &self, f: Func, ) -> Result<Variable, SynthesisError>

where Func: FnOnce() -> Result<F, SynthesisError>,

Obtain a variable representing a new public instance input.

pub fn new_witness_variable<Func>( &self, f: Func, ) -> Result<Variable, SynthesisError>

where Func: FnOnce() -> Result<F, SynthesisError>,

Obtain a new variable representing a new private witness variable.

pub fn register_predicate( &self, label: &str, predicate: PredicateConstraintSystem<F>, ) -> Result<(), SynthesisError>

Register a predicate in the constraint system with a given label.

pub fn remove_predicate(&self, label: &str)

Remove a predicate with the given label from the constraint system.

pub fn has_predicate(&self, predicate_label: &str) -> bool

Checks if there is a predicate with the given label in the constraint

pub fn assigned_value(&self, v: Variable) -> Option<F>

Obtain the assignment corresponding to the Variable v.

pub fn is_satisfied(&self) -> Result<bool, SynthesisError>

If self is satisfied, outputs Ok(true). If self is unsatisfied, outputs Ok(false). If self.is_in_setup_mode() or if self == None, outputs Err(()).

pub fn which_is_unsatisfied(&self) -> Result<Option<String>, SynthesisError>

If self is satisfied, outputs Ok(None). If self is unsatisfied, outputs Some(s,i), where s is the label of the unsatisfied prediacate and i is the index of the first unsatisfied constraint in that predicate. If self.is_in_setup_mode() or self == None, outputs Err(()).

pub fn finalize(&self)

Finalize the constraint system (either by outlining or inlining, if an optimization goal is set).

pub fn inline_all_lcs(&self)

Naively inlines symbolic linear combinations into the linear combinations that use them.

Useful for standard pairing-based SNARKs where addition gates are cheap. For example, in the SNARKs such as [Groth16] and [Groth-Maller17], addition gates do not contribute to the size of the multi-scalar multiplication, which is the dominating cost.

pub fn is_none(&self) -> bool

Returns true is self == ConstraintSystemRef::None.

pub fn to_matrices( &self, ) -> Result<BTreeMap<String, Vec<Vec<Vec<(F, usize)>>>>, SynthesisError>

Get the matrices corresponding to the predicates.and the corresponding set of matrices

pub fn get_lc(&self, var: Variable) -> Option<LinearCombination<F>>

Get the linear combination corresponding to the given lc_index. TODO: This function should ideally return a reference to the linear combination and not clone it.

pub fn make_row( &self, lc: LinearCombination<F>, ) -> Result<Vec<(F, usize)>, SynthesisError>

Given a linear combination, create a row in the matrix

pub fn borrow(&self) -> Option<Ref<'_, ConstraintSystem<F>>>

Obtain an immutable reference to the underlying ConstraintSystem.

Panics

This method panics if self is already mutably borrowed.

pub fn borrow_mut(&self) -> Option<RefMut<'_, ConstraintSystem<F>>>

Obtain a mutable reference to the underlying ConstraintSystem.

Panics

This method panics if self is already mutably borrowed.

pub fn constraint_names(&self) -> Option<Vec<String>>

Get trace information about all constraints in the system

Trait Implementations

impl<F: Field, const ARITH_ENABLED: bool, const ASSIGNMENTS_ENABLED: bool> Default for ConstraintSystemExt<F, ARITH_ENABLED, ASSIGNMENTS_ENABLED>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Field, const ARITH_ENABLED: bool, const ASSIGNMENTS_ENABLED: bool> Deref for ConstraintSystemExt<F, ARITH_ENABLED, ASSIGNMENTS_ENABLED>

type Target = ConstraintSystemRef<F>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.