Struct VarAllocator 

pub struct VarAllocator<T> { /* private fields */ }

Allocator for wire variables.

Mints a fresh wire on request and records the values of the wires that have been assigned, which are the relation’s public inputs. Handles are reference counted, so relations of different widths can share one namespace through PermutationRelation::with_allocator.

Implementations

impl<T: Unit> VarAllocator<T>

pub fn new() -> Self

An allocator holding only FieldVar::ZERO, assigned to T::ZERO.

pub fn allocate_var(&self) -> FieldVar

Allocates one wire, unassigned.

Panics

Panics when FieldVar::MAX_COUNT wires have already been allocated.

pub fn allocate_vars<const N: usize>(&self) -> [FieldVar; N]

Allocates N wires, so let [x, y] = allocator.allocate_vars() allocates two at once.

pub fn allocate_vars_vec(&self, count: usize) -> Vec<FieldVar>

Allocates count wires.

Panics

Panics, before allocating anything, if the total would exceed FieldVar::MAX_COUNT.

pub fn allocate_var_with(&self, value: T) -> FieldVar

where T: PartialEq,

Allocates one wire and assigns it value.

pub fn allocate_vars_with<const N: usize>( &self, values: &[T; N], ) -> [FieldVar; N]

where T: PartialEq,

Allocates N wires and assigns them values.

pub fn allocate_vars_vec_with(&self, values: &[T]) -> Vec<FieldVar>

where T: PartialEq,

Allocates one wire per element of values and assigns them.

pub fn vars_count(&self) -> usize

The number of wires allocated so far, FieldVar::ZERO included.

pub fn is_allocated(&self, var: FieldVar) -> bool

Whether var was allocated by this allocator.

pub fn set_var(&self, var: FieldVar, value: T)

where T: PartialEq,

Assigns value to var, making the wire public.

Panics

Panics if var was not allocated by this allocator, or if it already holds a different value.

pub fn set_vars<Var, Val>( &self, vars: impl IntoIterator<Item = Var>, values: impl IntoIterator<Item = Val>, )

where Var: Borrow<FieldVar>, Val: Borrow<T>, T: PartialEq,

Assigns each wire of vars the corresponding element of values.

Panics

Panics if the two iterators differ in length, or as Self::set_var does for any pair.

pub fn value(&self, var: FieldVar) -> Option<T>

The value of var, if it has been assigned.

pub fn public_vars(&self) -> Vec<(FieldVar, T)>

The assigned wires and their values, in index order.

Trait Implementations

impl<T> Clone for VarAllocator<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Unit> Default for VarAllocator<T>

fn default() -> Self

Returns the “default value” for a type.