Enum halo2_proofs::plonk::Expression
source · pub enum Expression<F> {
Constant(F),
Selector(Selector),
Fixed(FixedQuery),
Advice(AdviceQuery),
Instance(InstanceQuery),
Challenge(Challenge),
Negated(Box<Expression<F>>),
Sum(Box<Expression<F>>, Box<Expression<F>>),
Product(Box<Expression<F>>, Box<Expression<F>>),
Scaled(Box<Expression<F>>, F),
}
Expand description
Low-degree expression representing an identity that must hold over the committed columns.
Variants§
Constant(F)
This is a constant polynomial
Selector(Selector)
This is a virtual selector
Fixed(FixedQuery)
This is a fixed column queried at a certain relative location
Advice(AdviceQuery)
This is an advice (witness) column queried at a certain relative location
Instance(InstanceQuery)
This is an instance (external) column queried at a certain relative location
Challenge(Challenge)
This is a challenge
Negated(Box<Expression<F>>)
This is a negated polynomial
Sum(Box<Expression<F>>, Box<Expression<F>>)
This is the sum of two polynomials
Product(Box<Expression<F>>, Box<Expression<F>>)
This is the product of two polynomials
Scaled(Box<Expression<F>>, F)
This is a scaled polynomial
Implementations§
source§impl<F> Expression<F>where
F: Field,
impl<F> Expression<F>where
F: Field,
sourcepub fn query_cells(&mut self, cells: &mut VirtualCells<'_, F>)
pub fn query_cells(&mut self, cells: &mut VirtualCells<'_, F>)
Make side effects
sourcepub fn evaluate<T>(
&self,
constant: &impl Fn(F) -> T,
selector_column: &impl Fn(Selector) -> T,
fixed_column: &impl Fn(FixedQuery) -> T,
advice_column: &impl Fn(AdviceQuery) -> T,
instance_column: &impl Fn(InstanceQuery) -> T,
challenge: &impl Fn(Challenge) -> T,
negated: &impl Fn(T) -> T,
sum: &impl Fn(T, T) -> T,
product: &impl Fn(T, T) -> T,
scaled: &impl Fn(T, F) -> T
) -> T
pub fn evaluate<T>( &self, constant: &impl Fn(F) -> T, selector_column: &impl Fn(Selector) -> T, fixed_column: &impl Fn(FixedQuery) -> T, advice_column: &impl Fn(AdviceQuery) -> T, instance_column: &impl Fn(InstanceQuery) -> T, challenge: &impl Fn(Challenge) -> T, negated: &impl Fn(T) -> T, sum: &impl Fn(T, T) -> T, product: &impl Fn(T, T) -> T, scaled: &impl Fn(T, F) -> T ) -> T
Evaluate the polynomial using the provided closures to perform the operations.
sourcepub fn evaluate_lazy<T>(
&self,
constant: &impl Fn(F) -> T,
selector_column: &impl Fn(Selector) -> T,
fixed_column: &impl Fn(FixedQuery) -> T,
advice_column: &impl Fn(AdviceQuery) -> T,
instance_column: &impl Fn(InstanceQuery) -> T,
challenge: &impl Fn(Challenge) -> T,
negated: &impl Fn(T) -> T,
sum: &impl Fn(T, T) -> T,
product: &impl Fn(T, T) -> T,
scaled: &impl Fn(T, F) -> T,
zero: &T
) -> Twhere
T: PartialEq,
pub fn evaluate_lazy<T>(
&self,
constant: &impl Fn(F) -> T,
selector_column: &impl Fn(Selector) -> T,
fixed_column: &impl Fn(FixedQuery) -> T,
advice_column: &impl Fn(AdviceQuery) -> T,
instance_column: &impl Fn(InstanceQuery) -> T,
challenge: &impl Fn(Challenge) -> T,
negated: &impl Fn(T) -> T,
sum: &impl Fn(T, T) -> T,
product: &impl Fn(T, T) -> T,
scaled: &impl Fn(T, F) -> T,
zero: &T
) -> Twhere
T: PartialEq,
Evaluate the polynomial lazily using the provided closures to perform the operations.
sourcepub fn identifier(&self) -> String
pub fn identifier(&self) -> String
Identifier for this expression. Expressions with identical identifiers
do the same calculation (but the expressions don’t need to be exactly equal
in how they are composed e.g. 1 + 2
and 2 + 1
can have the same identifier).
sourcepub fn complexity(&self) -> usize
pub fn complexity(&self) -> usize
Approximate the computational complexity of this expression.
sourcepub fn square(self) -> Expression<F>
pub fn square(self) -> Expression<F>
Square this expression.
Trait Implementations§
source§impl<F> Add for Expression<F>where
F: Field,
impl<F> Add for Expression<F>where
F: Field,
§type Output = Expression<F>
type Output = Expression<F>
+
operator.source§fn add(self, rhs: Expression<F>) -> Expression<F>
fn add(self, rhs: Expression<F>) -> Expression<F>
+
operation. Read moresource§impl<F> Clone for Expression<F>where
F: Clone,
impl<F> Clone for Expression<F>where
F: Clone,
source§fn clone(&self) -> Expression<F>
fn clone(&self) -> Expression<F>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<F> Debug for Expression<F>where
F: Debug,
impl<F> Debug for Expression<F>where
F: Debug,
source§impl<F> Mul<F> for Expression<F>where
F: Field,
impl<F> Mul<F> for Expression<F>where
F: Field,
§type Output = Expression<F>
type Output = Expression<F>
*
operator.source§fn mul(self, rhs: F) -> Expression<F>
fn mul(self, rhs: F) -> Expression<F>
*
operation. Read moresource§impl<F> Mul for Expression<F>where
F: Field,
impl<F> Mul for Expression<F>where
F: Field,
§type Output = Expression<F>
type Output = Expression<F>
*
operator.source§fn mul(self, rhs: Expression<F>) -> Expression<F>
fn mul(self, rhs: Expression<F>) -> Expression<F>
*
operation. Read moresource§impl<F> Neg for Expression<F>where
F: Field,
impl<F> Neg for Expression<F>where
F: Field,
§type Output = Expression<F>
type Output = Expression<F>
-
operator.source§impl<F> PartialEq for Expression<F>where
F: PartialEq,
impl<F> PartialEq for Expression<F>where
F: PartialEq,
source§fn eq(&self, other: &Expression<F>) -> bool
fn eq(&self, other: &Expression<F>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<F> Product for Expression<F>where
F: Field,
impl<F> Product for Expression<F>where
F: Field,
source§fn product<I>(iter: I) -> Expression<F>where
I: Iterator<Item = Expression<F>>,
fn product<I>(iter: I) -> Expression<F>where
I: Iterator<Item = Expression<F>>,
Self
from the elements by
multiplying the items.source§impl<F> Sub for Expression<F>where
F: Field,
impl<F> Sub for Expression<F>where
F: Field,
§type Output = Expression<F>
type Output = Expression<F>
-
operator.source§fn sub(self, rhs: Expression<F>) -> Expression<F>
fn sub(self, rhs: Expression<F>) -> Expression<F>
-
operation. Read moresource§impl<F> Sum for Expression<F>where
F: Field,
impl<F> Sum for Expression<F>where
F: Field,
source§fn sum<I>(iter: I) -> Expression<F>where
I: Iterator<Item = Expression<F>>,
fn sum<I>(iter: I) -> Expression<F>where
I: Iterator<Item = Expression<F>>,
Self
from the elements by
“summing up” the items.impl<F> Eq for Expression<F>where
F: Eq,
impl<F> StructuralPartialEq for Expression<F>
Auto Trait Implementations§
impl<F> Freeze for Expression<F>where
F: Freeze,
impl<F> RefUnwindSafe for Expression<F>where
F: RefUnwindSafe,
impl<F> Send for Expression<F>where
F: Send,
impl<F> Sync for Expression<F>where
F: Sync,
impl<F> Unpin for Expression<F>where
F: Unpin,
impl<F> UnwindSafe for Expression<F>where
F: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.