Enum halo2_proofs::plonk::Assigned

source ·
pub enum Assigned<F> {
    Zero,
    Trivial(F),
    Rational(F, F),
}
Expand description

A value assigned to a cell within a circuit.

Stored as a fraction, so the backend can use batch inversion.

A denominator of zero maps to an assigned value of zero.

Variants§

§

Zero

The field element zero.

§

Trivial(F)

A value that does not require inversion to evaluate.

§

Rational(F, F)

A value stored as a fraction to enable batch inversion.

Implementations§

source§

impl<F> Assigned<F>
where F: Field,

source

pub fn numerator(&self) -> F

Returns the numerator.

source

pub fn denominator(&self) -> Option<F>

Returns the denominator, if non-trivial.

source

pub fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero.

source

pub fn double(&self) -> Assigned<F>

Doubles this element.

source

pub fn square(&self) -> Assigned<F>

Squares this element.

source

pub fn cube(&self) -> Assigned<F>

Cubes this element.

source

pub fn invert(&self) -> Assigned<F>

Inverts this assigned value (taking the inverse of zero to be zero).

source

pub fn evaluate(self) -> F

Evaluates this assigned value directly, performing an unbatched inversion if necessary.

If the denominator is zero, this returns zero.

Trait Implementations§

source§

impl<F> Add<&Assigned<F>> for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<F> Add<&Assigned<F>> for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<F> Add<Assigned<F>> for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<F> Add<F> for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<F> Add<F> for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<F> Add for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<F> AddAssign<&Assigned<F>> for Assigned<F>
where F: Field,

source§

fn add_assign(&mut self, rhs: &Assigned<F>)

Performs the += operation. Read more
source§

impl<F> AddAssign for Assigned<F>
where F: Field,

source§

fn add_assign(&mut self, rhs: Assigned<F>)

Performs the += operation. Read more
source§

impl<F> Clone for Assigned<F>
where F: Clone,

source§

fn clone(&self) -> Assigned<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 for Assigned<F>
where F: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<F> From<&Assigned<F>> for Assigned<F>
where F: Field,

source§

fn from(val: &Assigned<F>) -> Assigned<F>

Converts to this type from the input type.
source§

impl<F> From<&F> for Assigned<F>
where F: Field,

source§

fn from(numerator: &F) -> Assigned<F>

Converts to this type from the input type.
source§

impl<F> From<(F, F)> for Assigned<F>
where F: Field,

source§

fn from(_: (F, F)) -> Assigned<F>

Converts to this type from the input type.
source§

impl<F> From<F> for Assigned<F>
where F: Field,

source§

fn from(numerator: F) -> Assigned<F>

Converts to this type from the input type.
source§

impl<F> Mul<&Assigned<F>> for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl<F> Mul<F> for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl<F> Mul<F> for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl<F> Mul for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl<F> MulAssign<&Assigned<F>> for Assigned<F>
where F: Field,

source§

fn mul_assign(&mut self, rhs: &Assigned<F>)

Performs the *= operation. Read more
source§

impl<F> MulAssign for Assigned<F>
where F: Field,

source§

fn mul_assign(&mut self, rhs: Assigned<F>)

Performs the *= operation. Read more
source§

impl<F> Neg for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

fn neg(self) -> <&Assigned<F> as Neg>::Output

Performs the unary - operation. Read more
source§

impl<F> Neg for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

fn neg(self) -> <Assigned<F> as Neg>::Output

Performs the unary - operation. Read more
source§

impl<F> PartialEq for Assigned<F>
where F: Field,

source§

fn eq(&self, other: &Assigned<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<F> Sub<&Assigned<F>> for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<F> Sub<&Assigned<F>> for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<F> Sub<Assigned<F>> for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<F> Sub<F> for &Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<F> Sub<F> for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<F> Sub for Assigned<F>
where F: Field,

§

type Output = Assigned<F>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<F> SubAssign<&Assigned<F>> for Assigned<F>
where F: Field,

source§

fn sub_assign(&mut self, rhs: &Assigned<F>)

Performs the -= operation. Read more
source§

impl<F> SubAssign for Assigned<F>
where F: Field,

source§

fn sub_assign(&mut self, rhs: Assigned<F>)

Performs the -= operation. Read more
source§

impl<F> Copy for Assigned<F>
where F: Copy,

source§

impl<F> Eq for Assigned<F>
where F: Field,

Auto Trait Implementations§

§

impl<F> Freeze for Assigned<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for Assigned<F>
where F: RefUnwindSafe,

§

impl<F> Send for Assigned<F>
where F: Send,

§

impl<F> Sync for Assigned<F>
where F: Sync,

§

impl<F> Unpin for Assigned<F>
where F: Unpin,

§

impl<F> UnwindSafe for Assigned<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,

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

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

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

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

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

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

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

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

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

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

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
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> Pipe for T
where T: ?Sized,

§

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

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

Mutably borrows 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
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.
§

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
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

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<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

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

Mutable access to the BorrowMut<B> 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.
§

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

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

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

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

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

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

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.
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)

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<U> for T
where U: Into<T>,

§

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

§

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
§

impl<T, Scalar> FftGroup<Scalar> for T
where Scalar: Field, T: Copy + Send + Sync + 'static + GroupOpsOwned + ScalarMulOwned<Scalar>,

§

impl<T, Rhs, Output> GroupOps<Rhs, Output> for T
where T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>,

§

impl<T, Rhs, Output> GroupOpsOwned<Rhs, Output> for T
where T: for<'r> GroupOps<&'r Rhs, Output>,

§

impl<T, Rhs, Output> ScalarMul<Rhs, Output> for T
where T: Mul<Rhs, Output = Output> + MulAssign<Rhs>,

§

impl<T, Rhs, Output> ScalarMulOwned<Rhs, Output> for T
where T: for<'r> ScalarMul<&'r Rhs, Output>,

source§

impl<T> SyncDeps for T
where T: Send + Sync,