Enum halo2_proofs::plonk::Expression

source · [−]

pub enum Expression<F> {
    Constant(F),
    Selector(Selector),
    Fixed {
        query_index: usize,
        column_index: usize,
        rotation: Rotation,
    },
    Advice {
        query_index: usize,
        column_index: usize,
        rotation: Rotation,
    },
    Instance {
        query_index: usize,
        column_index: usize,
        rotation: Rotation,
    },
    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`

Fields

query_index: usize

Query index

column_index: usize

Column index

rotation: Rotation

Rotation of this query

This is a fixed column queried at a certain relative location

`Advice`

Fields

query_index: usize

Query index

column_index: usize

Column index

rotation: Rotation

Rotation of this query

This is an advice (witness) column queried at a certain relative location

`Instance`

Fields

query_index: usize

Query index

column_index: usize

Column index

rotation: Rotation

Rotation of this query

This is an instance (external) column queried at a certain relative location

`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: Field> Expression<F>

source

pub fn evaluate<T>(
 &self,
 constant: &impl Fn(F) -> T,
 selector_column: &impl Fn(Selector) -> T,
 fixed_column: &impl Fn(usize, usize, Rotation) -> T,
 advice_column: &impl Fn(usize, usize, Rotation) -> T,
 instance_column: &impl Fn(usize, usize, Rotation) -> 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.

source

pub fn degree(&self) -> usize

Compute the degree of this polynomial

source

pub fn square(self) -> Self

Square this expression.

Trait Implementations

source

impl<F: Field> Add<Expression<F>> for Expression<F>

type Output = Expression<F>

The resulting type after applying the + operator.

source

fn add(self, rhs: Expression<F>) -> Expression<F>

Performs the + operation. Read more

source

impl<F: Clone> Clone for Expression<F>

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<F: Debug> Debug for Expression<F>

source

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

Formats the value using the given formatter. Read more

source

impl<F: Field> From<Expression<F>> for Constraint<F>

source

fn from(poly: Expression<F>) -> Self

Converts to this type from the input type.

source

impl<F: Field> From<Expression<F>> for Vec<Constraint<F>>

source

fn from(poly: Expression<F>) -> Self

Converts to this type from the input type.

source

impl<F: Field> Mul<Expression<F>> for Expression<F>

type Output = Expression<F>

The resulting type after applying the * operator.

source

fn mul(self, rhs: Expression<F>) -> Expression<F>

Performs the * operation. Read more

source

impl<F: Field> Mul<F> for Expression<F>

type Output = Expression<F>

The resulting type after applying the * operator.

source

fn mul(self, rhs: F) -> Expression<F>

Performs the * operation. Read more

source

impl<F: Field> Neg for Expression<F>

type Output = Expression<F>

The resulting type after applying the - operator.

source

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

source

impl<F: Field> Sub<Expression<F>> for Expression<F>

type Output = Expression<F>

The resulting type after applying the - operator.

source

fn sub(self, rhs: Expression<F>) -> Expression<F>

Performs the - operation. Read more

Auto Trait Implementations

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> 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

Borrows 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) -> R where
R: 'a,

Mutably borrows 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 where
 Self: Borrow,
 B: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut B) -> R
) -> R where
 Self: BorrowMut,
 B: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
 Self: AsRef,
 U: 'a + ?Sized,
 R: 'a,

Borrows 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 where
 Self: AsMut,
 U: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: Deref<Target = T>,
 T: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut T) -> R
) -> R where
 Self: DerefMut<Target = T> + Deref,
 T: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

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> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Enum halo2_proofs::plonk::Expression

Variants

Constant(F)

Selector(Selector)

Fixed

Fields

Advice

Fields

Instance

Fields

Negated(Box<Expression<F>>)

Sum(Box<Expression<F>>, Box<Expression<F>>)

Product(Box<Expression<F>>, Box<Expression<F>>)

Scaled(Box<Expression<F>>, F)

Implementations

impl<F: Field> Expression<F>

pub fn degree(&self) -> usize

pub fn square(self) -> Self

Trait Implementations

impl<F: Field> Add<Expression<F>> for Expression<F>

type Output = Expression<F>

fn add(self, rhs: Expression<F>) -> Expression<F>

impl<F: Clone> Clone for Expression<F>

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

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

impl<F: Debug> Debug for Expression<F>

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

impl<F: Field> From<Expression<F>> for Constraint<F>

fn from(poly: Expression<F>) -> Self

impl<F: Field> From<Expression<F>> for Vec<Constraint<F>>

fn from(poly: Expression<F>) -> Self

impl<F: Field> Mul<Expression<F>> for Expression<F>

type Output = Expression<F>

fn mul(self, rhs: Expression<F>) -> Expression<F>

impl<F: Field> Mul<F> for Expression<F>

type Output = Expression<F>

fn mul(self, rhs: F) -> Expression<F>

impl<F: Field> Neg for Expression<F>

type Output = Expression<F>

fn neg(self) -> Self::Output

impl<F: Field> Sub<Expression<F>> for Expression<F>

type Output = Expression<F>

fn sub(self, rhs: Expression<F>) -> Expression<F>

Auto Trait Implementations

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where Self: UpperHex,

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R) -> R where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

`Constant(F)`

`Selector(Selector)`

`Fixed`

`Advice`

`Instance`

`Negated(Box<Expression<F>>)`

`Sum(Box<Expression<F>>, Box<Expression<F>>)`

`Product(Box<Expression<F>>, Box<Expression<F>>)`

`Scaled(Box<Expression<F>>, F)`

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,

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

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

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

fn conv<T>(self) -> T where
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

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

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

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,

fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

impl<T> ToOwned for T where
T: Clone,

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

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

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

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