[−][src]Trait ysbell::ConstraintSystem

pub trait ConstraintSystem<E: ScalarEngine>: Sized + Send {
    type Root: ConstraintSystem<E>;
    pub 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>;

    pub 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>;

    pub 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>;

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

    pub fn pop_namespace(&mut self);

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

    pub fn new() -> Self { ... }

    pub fn one() -> Variable { ... }

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

    pub fn is_extensible() -> bool { ... }

    pub fn extend(&mut self, _other: Self) { ... }
}

Represents a constraint system which can have new variables allocated and constrains between them formed.

Associated Types

type Root: ConstraintSystem<E>[src]

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

Loading content...

Required methods

pub 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>, [src]

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<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>, [src]

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: Into<String>,
    LA: FnOnce(LinearCombination<E>) -> LinearCombination<E>,
    LB: FnOnce(LinearCombination<E>) -> LinearCombination<E>,
    LC: FnOnce(LinearCombination<E>) -> LinearCombination<E>, [src]

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, name_fn: N) where
    NR: Into<String>,
    N: FnOnce() -> NR, [src]

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

pub fn pop_namespace(&mut self)[src]

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

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

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

Loading content...

Provided methods

pub fn new() -> Self[src]

pub fn one() -> Variable[src]

Return the "one" input variable

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

Begin a namespace for this constraint system.

pub fn is_extensible() -> bool[src]

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.

pub fn extend(&mut self, _other: Self)[src]

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.

Loading content...

Implementations on Foreign Types

impl<'cs, E: ScalarEngine, CS: ConstraintSystem<E>> ConstraintSystem<E> for &'cs mut CS[src]

Convenience implementation of ConstraintSystem for mutable references to constraint systems.

type Root = CS::Root

Loading content...

Implementors

impl<'cs, E: ScalarEngine, CS: ConstraintSystem<E>> ConstraintSystem<E> for Namespace<'cs, E, CS>[src]

type Root = CS::Root

impl<E: ScalarEngine> ConstraintSystem<E> for ysbell::gadgets::test::TestConstraintSystem<E>[src]

type Root = Self

impl<E: ScalarEngine, CS: ConstraintSystem<E>> ConstraintSystem<E> for MultiEq<E, CS>[src]

type Root = Self

impl<E: Engine> ConstraintSystem<E> for BenchCS<E>[src]

type Root = Self

impl<E: Engine> ConstraintSystem<E> for MetricCS<E>[src]

type Root = Self

impl<E: Engine> ConstraintSystem<E> for ysbell::util_cs::test_cs::TestConstraintSystem<E>[src]

type Root = Self

Loading content...