Struct bellperson::Namespace

pub struct Namespace<'a, E: ScalarEngine, CS: ConstraintSystem<E>>(_, _);

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<'cs, E: ScalarEngine, CS: ConstraintSystem<E>> ConstraintSystem<E> for Namespace<'cs, E, CS>

type Root = CS::Root

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

fn one() -> Variable

Return the “one” input variable

fn alloc<F, A, AR>(
    &mut self,
    annotation: A,
    f: F
) -> Result<Variable, SynthesisError> where
    F: FnOnce() -> Result<E::Fr, SynthesisError>,
    A: FnOnce() -> AR,
    AR: Into<String>, 

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.

fn alloc_input<F, A, AR>(
    &mut self,
    annotation: A,
    f: F
) -> Result<Variable, SynthesisError> where
    F: FnOnce() -> Result<E::Fr, SynthesisError>,
    A: FnOnce() -> AR,
    AR: Into<String>, 

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

fn enforce<A, AR, LA, LB, LC>(&mut self, annotation: A, a: LA, b: LB, c: LC) where
    A: FnOnce() -> AR,
    AR: Into<String>,
    LA: FnOnce(LinearCombination<E>) -> LinearCombination<E>,
    LB: FnOnce(LinearCombination<E>) -> LinearCombination<E>,
    LC: FnOnce(LinearCombination<E>) -> LinearCombination<E>, 

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.

fn push_namespace<NR, N>(&mut self, _: N) where
    NR: Into<String>,
    N: FnOnce() -> NR, 

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

fn pop_namespace(&mut self)

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

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

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

fn new() -> Self

fn namespace<NR, N>(&mut self, name_fn: N) -> Namespace<'_, E, Self::Root> where
    NR: Into<String>,
    N: FnOnce() -> NR, 

Begin a namespace for this constraint system.

fn is_extensible() -> bool

Most implementations of ConstraintSystem are not ‘extensible’: they won’t implement a specialized version of extend and should therefore also keep the default implementation of is_extensible so callers which optionally make use of extend can know to avoid relying on it when unimplemented.

fn extend(&mut self, _other: Self)

Extend concatenates thew other constraint systems to the receiver, modifying the receiver, whose inputs, allocated variables, and constraints will precede those of the other constraint system. The primary use case for this is parallel synthesis of circuits which can be decomposed into entirely independent sub-circuits. Each can be synthesized in its own thread, then the original ConstraintSystem can be extended with each, in the same order they would have been synthesized sequentially.

impl<'a, E: ScalarEngine, CS: ConstraintSystem<E>> Drop for Namespace<'a, E, CS>

fn drop(&mut self)

Executes the destructor for this type.