Struct snarkvm_models::gadgets::r1cs::Namespace

pub struct Namespace<'a, F: Field, CS: ConstraintSystem<F>>(_, _);

This is a "namespaced" constraint system which borrows a constraint system (pushing a namespace context) and, when dropped, pops out of the namespace context.

Trait Implementations

impl<F: Field, CS: ConstraintSystem<F>> ConstraintSystem<F> for Namespace<'_, F, CS>

type Root = CS::Root

Represents the type of the "root" of this constraint system so that nested namespaces can minimize indirection.

pub fn one() -> Variable

Return the "one" input variable

pub fn alloc<FN, A, AR>(
    &mut self,
    annotation: A,
    f: FN
) -> Result<Variable, SynthesisError> where
    FN: FnOnce() -> Result<F, SynthesisError>,
    A: FnOnce() -> AR,
    AR: AsRef<str>, 

Allocate a private variable in the constraint system. The provided function is used to determine the assignment of the variable. The given annotation function is invoked in testing contexts in order to derive a unique name for this variable in the current namespace.

pub fn alloc_input<FN, A, AR>(
    &mut self,
    annotation: A,
    f: FN
) -> Result<Variable, SynthesisError> where
    FN: FnOnce() -> Result<F, SynthesisError>,
    A: FnOnce() -> AR,
    AR: AsRef<str>, 

Allocate a public variable in the constraint system. The provided function is used to determine the assignment of the variable.

pub fn enforce<A, AR, LA, LB, LC>(&mut self, annotation: A, a: LA, b: LB, c: LC) where
    A: FnOnce() -> AR,
    AR: AsRef<str>,
    LA: FnOnce(LinearCombination<F>) -> LinearCombination<F>,
    LB: FnOnce(LinearCombination<F>) -> LinearCombination<F>,
    LC: FnOnce(LinearCombination<F>) -> LinearCombination<F>, 

Enforce that A * B = C. The annotation function is invoked in testing contexts in order to derive a unique name for the constraint in the current namespace.

pub fn push_namespace<NR, N>(&mut self, _: N) where
    NR: AsRef<str>,
    N: FnOnce() -> NR, 

Create a new (sub)namespace and enter into it. Not intended for downstream use; use namespace instead.

pub fn pop_namespace(&mut self)

Exit out of the existing namespace. Not intended for downstream use; use namespace instead.

pub fn get_root(&mut self) -> &mut Self::Root

Gets the "root" constraint system, bypassing the namespacing. Not intended for downstream use; use namespace instead.

pub fn num_constraints(&self) -> usize

Output the number of constraints in the system.

pub fn ns<NR, N>(&mut self, name_fn: N) -> Namespace<'_, F, Self::Root> where
    NR: AsRef<str>,
    N: FnOnce() -> NR, 

Begin a namespace for this constraint system.

impl<F: Field, CS: ConstraintSystem<F>> Drop for Namespace<'_, F, CS>

pub fn drop(&mut self)

Executes the destructor for this type.