Enum ExprRef 

pub enum ExprRef<F> {
    IrVar(IrVar<F>),
    Expr(usize),
}

The AB::Expr of the constraint compiler. Note that for the constraint compiler, this is also AB::Var.

Variants

IrVar(IrVar<F>)

An IrVar, usually this comes from the chip/inputs.

Expr(usize)

An expression where its value i means this expression represents the value of the i-th assignment. For the constraint compiler, since it uses an SSA-style IR, i also means this expression represents the result of the i-th computation.

Implementations

impl<F: Field> ExprRef<F>

pub fn public(index: usize) -> Self

An expression representing a variable from public inputs.

pub fn preprocessed(index: usize) -> Self

An expression representing a variable from preprocessed trace.

pub fn main(index: usize) -> Self

An expression representing a variable from main trace.

pub fn constant(value: F) -> Self

An expression representing a constant value.

pub fn input_arg(ctx: &mut FuncCtx) -> Self

An expression representing a variable from input arguments.

pub fn input_from_struct<T>(ctx: &mut FuncCtx) -> T

where T: Copy, [Self]: Borrow<T>,

Get a struct with input arguments.

Given a sized struct that can be flattened to a slice of Self, produce a new struct of this type where all the fields are replaced with input arguments.

pub fn output_arg(ctx: &mut FuncCtx) -> Self

An expression representing a variable from output arguments.

pub fn output_from_struct<T>(ctx: &mut FuncCtx) -> T

where T: Copy, [Self]: Borrow<T>,

Get a struct with output arguments.

Given a sized struct that can be flattened to a slice of Self, produce a new struct of this type where all the fields are replaced with output arguments.

pub fn to_lean_string(&self, input_mapping: &HashMap<usize, String>) -> String

Returns the value in Lean-syntax string

pub fn expr_to_lean_string(&self) -> String

Returns the value in Lean-syntax string, except that it must be an intermediate expression.

Used for the LHS when assigning variables in steps

impl<F: Field> ExprRef<F>

pub fn to_lean( &self, is_operation: bool, input_mapping: &HashMap<usize, String>, ) -> String

Convert to Lean syntax

Trait Implementations

impl AbstractExtensionField<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

const D: usize

fn from_base(b: ExprRef<SP1Field>) -> Self

fn from_base_slice(_: &[ExprRef<SP1Field>]) -> Self

Suppose this field extension is represented by the quotient ring B[X]/(f(X)) where B is Base and f is an irreducible polynomial of degree D. This function takes a slice bs of length at most D, and constructs the field element \sum_i bs[i] * X^i.

fn from_base_fn<F: FnMut(usize) -> ExprRef<SP1Field>>(_: F) -> Self

Similar to core:array::from_fn, with the same caveats as from_base_slice.

fn as_base_slice(&self) -> &[ExprRef<SP1Field>]

Suppose this field extension is represented by the quotient ring B[X]/(f(X)) where B is Base and f is an irreducible polynomial of degree D. This function takes a field element \sum_i bs[i] * X^i and returns the coefficients as a slice bs of length at most D containing, from lowest degree to highest.

fn monomial(exponent: usize) -> Self

Suppose this field extension is represented by the quotient ring B[X]/(f(X)) where B is Base and f is an irreducible polynomial of degree D. This function returns the field element X^exponent if exponent < D and panics otherwise. (The fact that f is not known at the point that this function is defined prevents implementing exponentiation of higher powers since the reduction cannot be performed.)

impl AbstractField for ExprRef<SP1Field>

type F = KoalaBear

fn zero() -> Self

fn one() -> Self

fn two() -> Self

fn neg_one() -> Self

fn from_f(f: Self::F) -> Self

fn from_bool(b: bool) -> Self

fn from_canonical_u8(n: u8) -> Self

fn from_canonical_u16(n: u16) -> Self

fn from_canonical_u32(n: u32) -> Self

fn from_canonical_u64(n: u64) -> Self

fn from_canonical_usize(n: usize) -> Self

fn from_wrapped_u32(n: u32) -> Self

fn from_wrapped_u64(n: u64) -> Self

fn generator() -> Self

A generator of this field’s entire multiplicative group.

fn double(&self) -> Self

fn square(&self) -> Self

fn cube(&self) -> Self

fn exp_u64(&self, power: u64) -> Self

Exponentiation by a u64 power.

fn exp_const_u64<const POWER: u64>(&self) -> Self

fn exp_power_of_2(&self, power_log: usize) -> Self

fn powers(&self) -> Powers<Self>

fn shifted_powers(&self, start: Self) -> Powers<Self>

fn powers_packed<P>(&self) -> PackedPowers<Self, P>

where P: PackedField<Scalar = Self>,

fn shifted_powers_packed<P>(&self, start: Self) -> PackedPowers<Self, P>

where P: PackedField<Scalar = Self>,

fn dot_product<const N: usize>(u: &[Self; N], v: &[Self; N]) -> Self

fn try_div<Rhs>(self, rhs: Rhs) -> Option<Self::Output>

where Rhs: Field, Self: Mul<Rhs>,

impl Add<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

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

The resulting type after applying the + operator.

fn add(self, rhs: ExprRef<SP1Field>) -> Self::Output

Performs the + operation.

impl Add<KoalaBear> for ExprRef<SP1Field>

type Output = ExprRef<KoalaBear>

The resulting type after applying the + operator.

fn add(self, rhs: SP1Field) -> Self::Output

Performs the + operation.

impl Add for ExprRef<SP1Field>

type Output = ExprRef<KoalaBear>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

fn add_assign(&mut self, rhs: ExprRef<SP1Field>)

Performs the += operation.

impl AddAssign for ExprRef<SP1Field>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<F: Clone> Clone for ExprRef<F>

fn clone(&self) -> ExprRef<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for ExprRef<F>

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

Formats the value using the given formatter.

impl Default for ExprRef<SP1Field>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, F> Deserialize<'de> for ExprRef<F>

where F: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Field> Display for ExprRef<F>

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

Formats the value using the given formatter.

impl<F: Field, EF: ExtensionField<F>> From<ExprRef<F>> for Shape<ExprRef<F>, ExprExtRef<EF>>

fn from(val: ExprRef<F>) -> Self

Converts to this type from the input type.

impl From<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

fn from(e: ExprRef<SP1Field>) -> Self

Converts to this type from the input type.

impl From<KoalaBear> for ExprRef<SP1Field>

fn from(f: SP1Field) -> Self

Converts to this type from the input type.

impl Mul<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

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

The resulting type after applying the * operator.

fn mul(self, rhs: ExprRef<SP1Field>) -> Self::Output

Performs the * operation.

impl Mul<KoalaBear> for ExprRef<SP1Field>

type Output = ExprRef<KoalaBear>

The resulting type after applying the * operator.

fn mul(self, rhs: SP1Field) -> Self::Output

Performs the * operation.

impl Mul for ExprRef<SP1Field>

type Output = ExprRef<KoalaBear>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

fn mul_assign(&mut self, rhs: ExprRef<SP1Field>)

Performs the *= operation.

impl MulAssign for ExprRef<SP1Field>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for ExprRef<SP1Field>

type Output = ExprRef<KoalaBear>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Product for ExprRef<SP1Field>

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl SP1OperationOutput<ExprRef<<ConstraintCompiler as AirBuilder>::F>> for ExprRef<<ConstraintCompiler as AirBuilder>::F>

fn alloc() -> Self

Allocates space for the output and returns the allocated value.

fn to_output(&self, ctx: &mut FuncCtx) -> Self

Replace all contents with IrVar(Output…)

fn assign(&self, other: Self)

Assigns the output.

impl<F> Serialize for ExprRef<F>

where F: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

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

The resulting type after applying the - operator.

fn sub(self, rhs: ExprRef<SP1Field>) -> Self::Output

Performs the - operation.

impl Sub<KoalaBear> for ExprRef<SP1Field>

type Output = ExprRef<KoalaBear>

The resulting type after applying the - operator.

fn sub(self, rhs: SP1Field) -> Self::Output

Performs the - operation.

impl Sub for ExprRef<SP1Field>

type Output = ExprRef<KoalaBear>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<ExprRef<KoalaBear>> for ExprExtRef<BinomialExtensionField<SP1Field, 4>>

fn sub_assign(&mut self, rhs: ExprRef<SP1Field>)

Performs the -= operation.

impl SubAssign for ExprRef<SP1Field>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for ExprRef<SP1Field>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<F: Copy> Copy for ExprRef<F>