Struct ConstraintCompiler 

pub struct ConstraintCompiler { /* private fields */ }

The constraint compiler that records the constraints of a chip.

Implementations

impl ConstraintCompiler

pub fn new<A: MachineAir<SP1Field>>(air: &A, num_public_values: usize) -> Self

Creates a new ConstraintCompiler

pub fn with_sizes( num_public_values: usize, preprocessed_width: usize, main_width: usize, ) -> Self

Creates a new ConstraintCompiler with specific dimensions.

pub fn ast( &self, ) -> Ast<ExprRef<SP1Field>, ExprExtRef<BinomialExtensionField<SP1Field, 4>>>

Returns the currently recorded AST.

pub fn register_module( &mut self, name: String, params: Vec<(String, Attribute, Shape<ExprRef<SP1Field>, ExprExtRef<BinomialExtensionField<SP1Field, 4>>>)>, body: impl FnOnce(&mut Self) -> Shape<ExprRef<SP1Field>, ExprExtRef<BinomialExtensionField<SP1Field, 4>>>, )

Records a module (that is usually just a function call that represents an operation).

pub fn modules( &self, ) -> &BTreeMap<String, Func<ExprRef<SP1Field>, ExprExtRef<BinomialExtensionField<SP1Field, 4>>>>

The modules that has been recorded.

pub fn num_cols(&self) -> usize

The total number of cols of the chip.

Trait Implementations

impl AirBuilder for ConstraintCompiler

type F = KoalaBear

type Expr = ExprRef<KoalaBear>

type Var = ExprRef<KoalaBear>

type M = DenseMatrix<ExprRef<KoalaBear>>

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

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

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

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

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

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

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_one<I>(&mut self, x: I)

where I: Into<Self::Expr>,

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

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

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.

impl AirBuilderWithPublicValues for ConstraintCompiler

type PublicVar = ExprRef<KoalaBear>

fn public_values(&self) -> &[Self::PublicVar]

impl Clone for ConstraintCompiler

fn clone(&self) -> ConstraintCompiler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConstraintCompiler

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

Formats the value using the given formatter.

impl Drop for ConstraintCompiler

fn drop(&mut self)

Executes the destructor for this type.

impl ExtensionBuilder for ConstraintCompiler

type EF = BinomialExtensionField<KoalaBear, 4>

type ExprEF = ExprExtRef<BinomialExtensionField<KoalaBear, 4>>

type VarEF = ExprExtRef<BinomialExtensionField<KoalaBear, 4>>

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

where I: Into<Self::ExprEF>,

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

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

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

where I: Into<Self::ExprEF>,

impl MessageBuilder<AirInteraction<ExprRef<KoalaBear>>> for ConstraintCompiler

fn send( &mut self, message: AirInteraction<ExprRef<SP1Field>>, scope: InteractionScope, )

Sends a message.

fn receive( &mut self, message: AirInteraction<ExprRef<SP1Field>>, scope: InteractionScope, )

Receives a message.

impl PairBuilder for ConstraintCompiler

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