Skip to main content

DebugConstraintBuilder

Struct DebugConstraintBuilder 

Source
pub struct DebugConstraintBuilder<'a, SC: StarkProtocolConfig> {
    pub air_name: &'a str,
    pub row_index: usize,
    pub preprocessed: ViewPair<'a, Val<SC>>,
    pub partitioned_main: Vec<ViewPair<'a, Val<SC>>>,
    pub is_first_row: Val<SC>,
    pub is_last_row: Val<SC>,
    pub is_transition: Val<SC>,
    pub public_values: &'a [Val<SC>],
    pub has_common_main: bool,
}
Expand description

An AirBuilder which asserts that each constraint is zero, allowing any failed constraints to be detected early.

Fields§

§air_name: &'a str§row_index: usize§preprocessed: ViewPair<'a, Val<SC>>§partitioned_main: Vec<ViewPair<'a, Val<SC>>>§is_first_row: Val<SC>§is_last_row: Val<SC>§is_transition: Val<SC>§public_values: &'a [Val<SC>]§has_common_main: bool

Trait Implementations§

Source§

impl<'a, SC> AirBuilder for DebugConstraintBuilder<'a, SC>

Source§

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

It is difficult to horizontally concatenate matrices when the main trace is partitioned, so we disable this method in that case.

Source§

type F = <SC as StarkProtocolConfig>::F

Underlying field type. Read more
Source§

type Expr = <SC as StarkProtocolConfig>::F

Serves as the output type for an AIR constraint evaluation.
Source§

type Var = <SC as StarkProtocolConfig>::F

The type of the variable appearing in the trace matrix. Read more
Source§

type M = VerticalPair<DenseMatrix<<SC as StarkProtocolConfig>::F, &'a [<SC as StarkProtocolConfig>::F]>, DenseMatrix<<SC as StarkProtocolConfig>::F, &'a [<SC as StarkProtocolConfig>::F]>>

Matrix type holding variables.
Source§

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

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

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

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

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

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

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

Assert that the given element is zero. Read more
Source§

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 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. Read more
§

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_bool<I>(&mut self, x: I)
where I: Into<Self::Expr>,

Assert that x is a boolean, i.e. either 0 or 1. Read more
Source§

impl<SC> AirBuilderWithPublicValues for DebugConstraintBuilder<'_, SC>

Source§

type PublicVar = <SC as StarkProtocolConfig>::F

Type representing a public variable.
Source§

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

Return the list of public variables.
Source§

impl<SC> ExtensionBuilder for DebugConstraintBuilder<'_, SC>

Source§

type EF = <SC as StarkProtocolConfig>::EF

Extension field type.
Source§

type ExprEF = <SC as StarkProtocolConfig>::EF

Expression type over extension field elements.
Source§

type VarEF = <SC as StarkProtocolConfig>::EF

Variable type over extension field elements.
Source§

fn assert_zero_ext<I>(&mut self, x: I)
where I: Into<Self::ExprEF>,

Assert that an extension field expression is zero.
Source§

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.
Source§

impl<SC> InteractionBuilder for DebugConstraintBuilder<'_, SC>

Source§

fn push_interaction<E: Into<Self::Expr>>( &mut self, _bus_index: BusIndex, _fields: impl IntoIterator<Item = E>, _count: impl Into<Self::Expr>, _count_weight: u32, )

Stores a new interaction in the builder. Read more
Source§

fn num_interactions(&self) -> usize

Returns the current number of interactions.
Source§

fn all_interactions(&self) -> &[Interaction<Self::Expr>]

Returns all interactions stored.
Source§

fn assert_tern(&mut self, x: impl Into<Self::Expr>)

Source§

impl<SC> PairBuilder for DebugConstraintBuilder<'_, SC>

Source§

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

Return a matrix of preprocessed registers.
Source§

impl<SC> PartitionedAirBuilder for DebugConstraintBuilder<'_, SC>

Source§

fn cached_mains(&self) -> &[Self::M]

Cached main trace matrix.
Source§

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

Common main trace matrix. Panic if there is no common main trace.

Auto Trait Implementations§

§

impl<'a, SC> Freeze for DebugConstraintBuilder<'a, SC>
where <SC as StarkProtocolConfig>::F: Freeze,

§

impl<'a, SC> RefUnwindSafe for DebugConstraintBuilder<'a, SC>

§

impl<'a, SC> Send for DebugConstraintBuilder<'a, SC>

§

impl<'a, SC> Sync for DebugConstraintBuilder<'a, SC>

§

impl<'a, SC> Unpin for DebugConstraintBuilder<'a, SC>
where <SC as StarkProtocolConfig>::F: Unpin,

§

impl<'a, SC> UnsafeUnpin for DebugConstraintBuilder<'a, SC>

§

impl<'a, SC> UnwindSafe for DebugConstraintBuilder<'a, SC>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more