Struct SubAirBuilder

pub struct SubAirBuilder<'a, AB: AirBuilder, SubAir: BaseAir<T>, T> { /* private fields */ }

A builder used to eval a sub-air. This will handle enforcing constraints for a subset of a trace matrix. E.g. if a particular air needs to be enforced for a subset of the columns of the trace, then the SubAirBuilder can be used.

Implementations

impl<'a, AB: AirBuilder, SubAir: BaseAir<T>, T> SubAirBuilder<'a, AB, SubAir, T>

pub fn new(inner: &'a mut AB, column_range: Range<usize>) -> Self

Trait Implementations

impl<AB: AirBuilder, SubAir: BaseAir<F>, F> AirBuilder for SubAirBuilder<'_, AB, SubAir, F>

Implement AirBuilder for SubAirBuilder.

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 = SubMatrixRowSlices<<AB as AirBuilder>::M, <SubAirBuilder<'_, AB, SubAir, F> as AirBuilder>::Var>

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>(&mut self, condition: I) -> FilteredAirBuilder<'_, Self>

where I: Into<Self::Expr>,

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

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

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

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>(&mut self, array: [I; N])

where I: Into<Self::Expr>,

Assert that every element of a given array is 0.

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

where I: Into<Self::Expr>,

Assert that a given array consists of only boolean values.

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

where I: Into<Self::Expr>,

Assert that x element is equal to 1.

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

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

Assert that the given elements are equal.

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

where I: Into<Self::Expr>,

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