pub struct Encoder { /* private fields */ }
Expand description
Efficient encoding of circuit selectors
This encoder represents selectors as points in a k-dimensional space where each coordinate is between 0 and max_degree, and their sum doesn’t exceed max_degree. This approach allows encoding many selectors with significantly fewer columns than the traditional approach of using one boolean column per selector.
Implementations§
Source§impl Encoder
impl Encoder
Sourcepub fn new(cnt: usize, max_degree: u32, reserve_invalid: bool) -> Self
pub fn new(cnt: usize, max_degree: u32, reserve_invalid: bool) -> Self
Create a new encoder for a given number of flags and maximum degree.
The flags will correspond to points in F^k, where k is the number of variables.
The zero point is reserved for the dummy row.
max_degree
is the upper bound for the flag expressions, but the eval
function
of the encoder itself will use some constraints of degree max_degree + 1
.
reserve_invalid
indicates if the encoder should reserve the (0, …, 0) point as an
invalid/dummy flag.
Sourcepub fn get_flag_expr<AB: InteractionBuilder>(
&self,
flag_idx: usize,
vars: &[AB::Var],
) -> AB::Expr
pub fn get_flag_expr<AB: InteractionBuilder>( &self, flag_idx: usize, vars: &[AB::Var], ) -> AB::Expr
Get the polynomial expression that equals 1 when the variables encode the flag at index flag_idx
Sourcepub fn get_flag_pt(&self, flag_idx: usize) -> Vec<u32>
pub fn get_flag_pt(&self, flag_idx: usize) -> Vec<u32>
Get the point coordinates that correspond to the flag at index flag_idx
Sourcepub fn is_valid<AB: InteractionBuilder>(&self, vars: &[AB::Var]) -> AB::Expr
pub fn is_valid<AB: InteractionBuilder>(&self, vars: &[AB::Var]) -> AB::Expr
Returns an expression that is 1 if the variables encode a valid flag and 0 if they encode the invalid point
Sourcepub fn flags<AB: InteractionBuilder>(&self, vars: &[AB::Var]) -> Vec<AB::Expr>
pub fn flags<AB: InteractionBuilder>(&self, vars: &[AB::Var]) -> Vec<AB::Expr>
Returns all flag expressions for the given variables
Sourcepub fn sum_of_unused<AB: InteractionBuilder>(
&self,
vars: &[AB::Var],
) -> AB::Expr
pub fn sum_of_unused<AB: InteractionBuilder>( &self, vars: &[AB::Var], ) -> AB::Expr
Returns the sum of expressions for all unused points This is used to ensure that variables encode only valid flags
Sourcepub fn contains_flag<AB: InteractionBuilder>(
&self,
vars: &[AB::Var],
flag_idxs: &[usize],
) -> AB::Expr
pub fn contains_flag<AB: InteractionBuilder>( &self, vars: &[AB::Var], flag_idxs: &[usize], ) -> AB::Expr
Returns an expression that is 1 if flag_idxs
contains the encoded flag and 0 otherwise
Sourcepub fn contains_flag_range<AB: InteractionBuilder>(
&self,
vars: &[AB::Var],
range: RangeInclusive<usize>,
) -> AB::Expr
pub fn contains_flag_range<AB: InteractionBuilder>( &self, vars: &[AB::Var], range: RangeInclusive<usize>, ) -> AB::Expr
Returns an expression that is 1 if (l..=r) contains the encoded flag and 0 otherwise
Sourcepub fn flag_with_val<AB: InteractionBuilder>(
&self,
vars: &[AB::Var],
flag_idx_vals: &[(usize, usize)],
) -> AB::Expr
pub fn flag_with_val<AB: InteractionBuilder>( &self, vars: &[AB::Var], flag_idx_vals: &[(usize, usize)], ) -> AB::Expr
Returns an expression that is 0 if flag_idxs_vals
doesn’t contain the encoded flag
and the corresponding val if it does
flag_idxs_vals
is a list of tuples (flag_idx, val)
Trait Implementations§
Source§impl<AB: InteractionBuilder> SubAir<AB> for Encoder
impl<AB: InteractionBuilder> SubAir<AB> for Encoder
Source§type AirContext<'a> = &'a [<AB as AirBuilder>::Var]
where
AB: 'a,
AB::Var: 'a,
AB::Expr: 'a
type AirContext<'a> = &'a [<AB as AirBuilder>::Var] where AB: 'a, AB::Var: 'a, AB::Expr: 'a
AB::Expr
that are needed
to define the SubAir’s constraints.fn eval<'a>(&'a self, builder: &'a mut AB, local: &'a [AB::Var])where
AB: 'a,
AB::Expr: 'a,
Auto Trait Implementations§
impl Freeze for Encoder
impl RefUnwindSafe for Encoder
impl Send for Encoder
impl Sync for Encoder
impl Unpin for Encoder
impl UnwindSafe for Encoder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.