Skip to main content

CircuitBuilder

Struct CircuitBuilder 

Source
pub struct CircuitBuilder<F>
where F: Field,
{ /* private fields */ }
Expand description

Builder for constructing arithmetic circuits

Implementations§

Source§

impl<F> CircuitBuilder<F>
where F: Field,

Source

pub fn new(witness_size: usize, public_input_size: usize) -> CircuitBuilder<F>

Create a new circuit builder

§Arguments
  • witness_size - Number of witness wires (private inputs)
  • public_input_size - Number of public input wires
§Example
use lib_q_zkp::circuit::CircuitBuilder;
use lib_q_stark_field::extension::Complex;
use lib_q_stark_mersenne31::Mersenne31;

type Val = Complex<Mersenne31>;

let mut builder = CircuitBuilder::<Val>::new(2, 1);
let a = builder.wire(0);  // witness wire 0
let b = builder.wire(1);  // witness wire 1
let sum = builder.add(a, b);
builder.assert_zero(sum);
let circuit = builder.build();
Source

pub fn alloc_wire(&mut self) -> Wire

Allocate a new intermediate wire

Source

pub fn wire(&self, index: usize) -> Wire

Get a wire by index (for public inputs and witness)

Source

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

Assert that a wire equals zero

Source

pub fn assert_eq(&mut self, left: Wire, right: Wire)

Assert that two wires are equal

Source

pub fn assert_constant(&mut self, wire: Wire, constant: F)

Assert that a wire equals a constant

Source

pub fn add(&mut self, left: Wire, right: Wire) -> Wire

Add two wires and return the result wire

Source

pub fn mul(&mut self, left: Wire, right: Wire) -> Wire

Multiply two wires and return the result wire

Source

pub fn build(self) -> ArithmeticCircuit<F>

Build the circuit

Auto Trait Implementations§

§

impl<F> Freeze for CircuitBuilder<F>

§

impl<F> RefUnwindSafe for CircuitBuilder<F>
where F: RefUnwindSafe,

§

impl<F> Send for CircuitBuilder<F>

§

impl<F> Sync for CircuitBuilder<F>

§

impl<F> Unpin for CircuitBuilder<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for CircuitBuilder<F>

§

impl<F> UnwindSafe for CircuitBuilder<F>
where 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more