Struct FilteredAirBuilder

pub struct FilteredAirBuilder<'a, AB: AirBuilder> {
    pub inner: &'a mut AB,
    /* private fields */
}

A wrapper around an AirBuilder that enforces constraints only when a specified condition is met.

This struct allows selectively applying constraints to certain rows or under certain conditions in the AIR, without modifying the underlying logic. All constraints asserted through this filtered builder will be multiplied by the given condition, effectively disabling them when condition evaluates to zero.

Fields

inner: &'a mut AB

Reference to the underlying inner AirBuilder where constraints are ultimately recorded.

Implementations

impl<AB: AirBuilder> FilteredAirBuilder<'_, AB>

pub fn condition(&self) -> AB::Expr

Trait Implementations

impl<AB: AirBuilder> AirBuilder for FilteredAirBuilder<'_, AB>

type F = <AB as AirBuilder>::F

Underlying field type.

type Expr = <AB as AirBuilder>::Expr

Serves as the output type for an AIR constraint evaluation.

type Var = <AB as AirBuilder>::Var

The type of the variable appearing in the trace matrix.

type M = <AB as AirBuilder>::M

Matrix type holding variables.

fn main(&self) -> Self::M

Return the matrix representing the main (primary) trace registers.

fn is_first_row(&self) -> Self::Expr

Expression evaluating to 1 on the first row, 0 elsewhere.

fn is_last_row(&self) -> Self::Expr

Expression evaluating to 1 on the last row, 0 elsewhere.

fn is_transition_window(&self, size: usize) -> Self::Expr

Expression evaluating to 1 on rows except the last size - 1 rows, 0 otherwise.

fn assert_zero<I: Into<Self::Expr>>(&mut self, x: I)

Assert that the given element is zero.

fn is_transition(&self) -> Self::Expr

Expression evaluating to 1 on all transition rows (not last row), 0 on last row.

fn when<I: Into<Self::Expr>>( &mut self, condition: I, ) -> FilteredAirBuilder<'_, Self>

Returns a sub-builder whose constraints are enforced only when condition is nonzero.

fn when_ne<I1: Into<Self::Expr>, I2: Into<Self::Expr>>( &mut self, x: I1, y: I2, ) -> FilteredAirBuilder<'_, Self>

Returns a sub-builder whose constraints are enforced only when x != y.

fn when_first_row(&mut self) -> FilteredAirBuilder<'_, Self>

Returns a sub-builder whose constraints are enforced only on the first row.

fn when_last_row(&mut self) -> FilteredAirBuilder<'_, Self>

Returns a sub-builder whose constraints are enforced only on the last row.

fn when_transition(&mut self) -> FilteredAirBuilder<'_, Self>

Returns a sub-builder whose constraints are enforced on all rows except the last.

fn when_transition_window( &mut self, size: usize, ) -> FilteredAirBuilder<'_, Self>

Returns a sub-builder whose constraints are enforced on all rows except the last size - 1.

fn assert_zeros<const N: usize, I: Into<Self::Expr>>(&mut self, array: [I; N])

Assert that every element of a given array is 0.

fn assert_bools<const N: usize, I: Into<Self::Expr>>(&mut self, array: [I; N])

Assert that a given array consists of only boolean values.

fn assert_one<I: Into<Self::Expr>>(&mut self, x: I)

Assert that x element is equal to 1.

fn assert_eq<I1: Into<Self::Expr>, I2: Into<Self::Expr>>( &mut self, x: I1, y: I2, )

Assert that the given elements are equal.

fn assert_bool<I: Into<Self::Expr>>(&mut self, x: I)

Assert that x is a boolean, i.e. either 0 or 1.

impl<'a, AB: Debug + AirBuilder> Debug for FilteredAirBuilder<'a, AB>

where AB::Expr: Debug,

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

Formats the value using the given formatter.

impl<AB: ExtensionBuilder> ExtensionBuilder for FilteredAirBuilder<'_, AB>

type EF = <AB as ExtensionBuilder>::EF

Extension field type.

type ExprEF = <AB as ExtensionBuilder>::ExprEF

Expression type over extension field elements.

type VarEF = <AB as ExtensionBuilder>::VarEF

Variable type over extension field elements.

fn assert_zero_ext<I>(&mut self, x: I)

where I: Into<Self::ExprEF>,

Assert that an extension field expression is zero.

fn assert_eq_ext<I1, I2>(&mut self, x: I1, y: I2)

where I1: Into<Self::ExprEF>, I2: Into<Self::ExprEF>,

Assert that two extension field expressions are equal.

fn assert_one_ext<I>(&mut self, x: I)

where I: Into<Self::ExprEF>,

Assert that an extension field expression is equal to one.

impl<AB: PairBuilder> PairBuilder for FilteredAirBuilder<'_, AB>

fn preprocessed(&self) -> Self::M

Return a matrix of preprocessed registers.

impl<AB: PermutationAirBuilder> PermutationAirBuilder for FilteredAirBuilder<'_, AB>

type MP = <AB as PermutationAirBuilder>::MP

Matrix type over extension field variables representing a permutation.

type RandomVar = <AB as PermutationAirBuilder>::RandomVar

Randomness variable type used in permutation commitments.

fn permutation(&self) -> Self::MP

Return the matrix representing permutation registers.

fn permutation_randomness(&self) -> &[Self::RandomVar]

Return the list of randomness values for permutation argument.