Struct halo2_proofs::circuit::Value
source · [−]pub struct Value<V> { /* private fields */ }
Expand description
A value that might exist within a circuit.
This behaves like Option<V>
but differs in two key ways:
- It does not expose the enum cases, or provide an
Option::unwrap
equivalent. This helps to ensure that unwitnessed values correctly propagate. - It provides pass-through implementations of common traits such as
Add
andMul
, for improved usability.
Implementations
sourceimpl<V> Value<V>
impl<V> Value<V>
sourcepub fn assert_if_known<F: FnOnce(&V) -> bool>(&self, f: F)
pub fn assert_if_known<F: FnOnce(&V) -> bool>(&self, f: F)
Enforces an assertion on the contained value, if known.
The assertion is ignored if self
is Value::unknown()
. Do not try to enforce
circuit constraints with this method!
Panics
Panics if f
returns false
.
sourcepub fn error_if_known_and<F: FnOnce(&V) -> bool>(
&self,
f: F
) -> Result<(), Error>
pub fn error_if_known_and<F: FnOnce(&V) -> bool>(
&self,
f: F
) -> Result<(), Error>
Checks the contained value for an error condition, if known.
The error check is ignored if self
is Value::unknown()
. Do not try to
enforce circuit constraints with this method!
sourcepub fn map<W, F: FnOnce(V) -> W>(self, f: F) -> Value<W>
pub fn map<W, F: FnOnce(V) -> W>(self, f: F) -> Value<W>
Maps a Value<V>
to Value<W>
by applying a function to the contained value.
sourcepub fn and_then<W, F: FnOnce(V) -> Value<W>>(self, f: F) -> Value<W>
pub fn and_then<W, F: FnOnce(V) -> Value<W>>(self, f: F) -> Value<W>
Returns Value::unknown()
if the value is Value::unknown()
, otherwise calls
f
with the wrapped value and returns the result.
sourceimpl<V: Copy, const LEN: usize> Value<[V; LEN]>
impl<V: Copy, const LEN: usize> Value<[V; LEN]>
sourcepub fn transpose_array(self) -> [Value<V>; LEN]
pub fn transpose_array(self) -> [Value<V>; LEN]
Transposes a Value<[V; LEN]>
into a [Value<V>; LEN]
.
Value::unknown()
will be mapped to [Value::unknown(); LEN]
.
sourceimpl<V, I> Value<I> where
I: IntoIterator<Item = V>,
I::IntoIter: ExactSizeIterator,
impl<V, I> Value<I> where
I: IntoIterator<Item = V>,
I::IntoIter: ExactSizeIterator,
sourcepub fn transpose_vec(self, length: usize) -> Vec<Value<V>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
pub fn transpose_vec(self, length: usize) -> Vec<Value<V>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Transposes a Value<impl IntoIterator<Item = V>>
into a Vec<Value<V>>
.
Value::unknown()
will be mapped to vec![Value::unknown(); length]
.
Panics
Panics if self
is Value::known(values)
and values.len() != length
.
sourceimpl<V> Value<V>
impl<V> Value<V>
sourcepub fn to_field<F: Field>(&self) -> Value<Assigned<F>> where
for<'v> Assigned<F>: From<&'v V>,
pub fn to_field<F: Field>(&self) -> Value<Assigned<F>> where
for<'v> Assigned<F>: From<&'v V>,
Returns the field element corresponding to this value.
sourcepub fn into_field<F: Field>(self) -> Value<Assigned<F>> where
V: Into<Assigned<F>>,
pub fn into_field<F: Field>(self) -> Value<Assigned<F>> where
V: Into<Assigned<F>>,
Returns the field element corresponding to this value.
sourcepub fn double<F: Field>(&self) -> Value<Assigned<F>> where
V: Borrow<Assigned<F>>,
pub fn double<F: Field>(&self) -> Value<Assigned<F>> where
V: Borrow<Assigned<F>>,
Doubles this field element.
Examples
If you have a Value<F: Field>
, convert it to Value<Assigned<F>>
first:
use halo2_proofs::{circuit::Value, plonk::Assigned};
let v = Value::known(F::from(2));
let v: Value<Assigned<F>> = v.into();
v.double();
sourcepub fn square<F: Field>(&self) -> Value<Assigned<F>> where
V: Borrow<Assigned<F>>,
pub fn square<F: Field>(&self) -> Value<Assigned<F>> where
V: Borrow<Assigned<F>>,
Squares this field element.
Trait Implementations
sourceimpl<A, V: FromIterator<A>> FromIterator<Value<A>> for Value<V>
impl<A, V: FromIterator<A>> FromIterator<Value<A>> for Value<V>
sourcefn from_iter<I: IntoIterator<Item = Value<A>>>(iter: I) -> Self
fn from_iter<I: IntoIterator<Item = Value<A>>>(iter: I) -> Self
Takes each element in the Iterator
: if it is Value::unknown()
, no further
elements are taken, and the Value::unknown()
is returned. Should no
Value::unknown()
occur, a container of type V
containing the values of each
Value
is returned.
impl<V: Copy> Copy for Value<V>
Auto Trait Implementations
impl<V> RefUnwindSafe for Value<V> where
V: RefUnwindSafe,
impl<V> Send for Value<V> where
V: Send,
impl<V> Sync for Value<V> where
V: Sync,
impl<V> Unpin for Value<V> where
V: Unpin,
impl<V> UnwindSafe for Value<V> where
V: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
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,
Causes self
to use its Binary
implementation when Debug
-formatted. Read more
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
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,
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,
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,
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Causes self
to use its Octal
implementation when Debug
-formatted. Read more
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
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,
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,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
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,
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,
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,
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,
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,
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,
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. 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,
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.
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 for<'_> FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl for<'_> 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 for<'_> FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl for<'_> 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 for<'_> FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl for<'_> 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 for<'_> FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl for<'_> 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 for<'_> FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl for<'_> 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 for<'_> FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl for<'_> 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 for<'_> FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl for<'_> FnOnce(&Self)) -> Self
Calls .tap()
only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl for<'_> FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl for<'_> FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl for<'_> FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl for<'_> FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl for<'_> FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl for<'_> FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
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 for<'_> FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl for<'_> 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 for<'_> FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl for<'_> 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