Skip to main content

WitnessGenerator

Struct WitnessGenerator 

Source
pub struct WitnessGenerator<F: Field, LayoutRef = Arc<WitnessLayout<F>>> { /* private fields */ }
Expand description

Generates witness values by evaluating circuit operations with concrete field elements.

Implements CircuitBuilder with WitnessWire as the wire type. Operations like add and mul compute actual field values and populate the witness array. Captures the first constraint violation as an error for debugging.

LayoutRef is any pointer to a WitnessLayout, chosen by the caller:

  • &WitnessLayout<F> — a zero-cost borrow, tied to the borrow’s lifetime.
  • Arc<WitnessLayout<F>> — shared and 'static (the default).

A 'static generator is what lets its CircuitElems live in a 'static transparent closure. Sharing an Arc gives that without cloning the layout, so the wrapper channels use it.

Implementations§

Source§

impl<F: Field, LayoutRef: Deref<Target = WitnessLayout<F>>> WitnessGenerator<F, LayoutRef>

Source

pub fn new(layout: LayoutRef) -> Self

Source

pub fn write_inout(&mut self, wire: ConstraintWire, value: F) -> WitnessWire<F>

Source

pub fn write_precommit( &mut self, wire: ConstraintWire, value: F, ) -> WitnessWire<F>

Source

pub fn build(self) -> Result<Witness<F>, WitnessError>

Source

pub const fn error(&self) -> Option<&Backtrace>

Trait Implementations§

Source§

impl<F: Field, LayoutRef: Deref<Target = WitnessLayout<F>>> CircuitBuilder for WitnessGenerator<F, LayoutRef>

Source§

type Wire = WitnessWire<F>

Source§

type Field = F

Source§

fn assert_zero(&mut self, wire: Self::Wire)

Source§

fn assert_eq(&mut self, lhs: Self::Wire, rhs: Self::Wire)

Source§

fn constant(&mut self, val: F) -> Self::Wire

Source§

fn add(&mut self, lhs: Self::Wire, rhs: Self::Wire) -> Self::Wire

Source§

fn mul(&mut self, lhs: Self::Wire, rhs: Self::Wire) -> Self::Wire

Source§

fn hint<H: Fn([F; IN]) -> [F; OUT], const IN: usize, const OUT: usize>( &mut self, inputs: [Self::Wire; IN], f: H, ) -> [Self::Wire; OUT]

Source§

fn hint_varsize<H: FnOnce(&[F]) -> Vec<F>>( &mut self, inputs: &[Self::Wire], out_len: usize, f: H, ) -> Vec<Self::Wire>

Runtime-arity variant of hint: takes a slice of input wires and an out_len, with a closure mapping the input values to out_len output values. Emits no constraints; the outputs are public-derivable (allocated in the derived segment) iff every input is, matching hint. The closure is invoked at most once — value-generating builders run it, the symbolic builder skips it.
Source§

fn sub(&mut self, lhs: Self::Wire, rhs: Self::Wire) -> Self::Wire

Source§

impl<F: Debug + Field, LayoutRef: Debug> Debug for WitnessGenerator<F, LayoutRef>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F, LayoutRef = Arc<WitnessLayout<F>>> !Freeze for WitnessGenerator<F, LayoutRef>

§

impl<F, LayoutRef> RefUnwindSafe for WitnessGenerator<F, LayoutRef>
where LayoutRef: RefUnwindSafe, F: RefUnwindSafe,

§

impl<F, LayoutRef> Send for WitnessGenerator<F, LayoutRef>
where LayoutRef: Send,

§

impl<F, LayoutRef> Sync for WitnessGenerator<F, LayoutRef>
where LayoutRef: Sync,

§

impl<F, LayoutRef> Unpin for WitnessGenerator<F, LayoutRef>
where LayoutRef: Unpin, F: Unpin,

§

impl<F, LayoutRef> UnsafeUnpin for WitnessGenerator<F, LayoutRef>
where LayoutRef: UnsafeUnpin,

§

impl<F, LayoutRef> UnwindSafe for WitnessGenerator<F, LayoutRef>
where LayoutRef: UnwindSafe, F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.