Struct halo2_proofs :: circuit :: Value Copy item path

impl<V> Value<V>

pub const fn unknown() -> Value<V>

Constructs an unwitnessed value.

pub const fn known(value: V) -> Value<V>

Constructs a known value.

§Examples

use halo2_frontend::circuit::Value;

let v = Value::known(37);

pub fn assign(self) -> Result<V, Error>

Obtains the inner value for assigning into the circuit.

Returns Error::Synthesis if this is Value::unknown().

pub fn as_ref(&self) -> Value<&V>

Converts from &Value<V> to Value<&V>.

pub fn as_mut(&mut self) -> Value<&mut V>

Converts from &mut Value<V> to Value<&mut V>.

pub fn assert_if_known<F>(&self, f: F)
where F: FnOnce(&V) -> bool,

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.

pub fn error_if_known_and<F>(&self, f: F) -> Result<(), Error>
where F: FnOnce(&V) -> bool,

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!

pub fn map<W, F>(self, f: F) -> Value<W>
where F: FnOnce(V) -> W,

Maps a Value<V> to Value<W> by applying a function to the contained value.

pub fn and_then<W, F>(self, f: F) -> Value<W>
where F: FnOnce(V) -> Value<W>,

Returns Value::unknown() if the value is Value::unknown(), otherwise calls f with the wrapped value and returns the result.

pub fn zip<W>(self, other: Value<W>) -> Value<(V, W)>

Zips self with another Value.

If self is Value::known(s) and other is Value::known(o), this method returns Value::known((s, o)). Otherwise, Value::unknown() is returned.

impl<V, W> Value<(V, W)>

pub fn unzip(self) -> (Value<V>, Value<W>)

Unzips a value containing a tuple of two values.

If self is Value::known((a, b)), this method returns (Value::known(a), Value::known(b)). Otherwise, (Value::unknown(), Value::unknown())` is returned.

impl<V> Value<&V>

pub fn copied(self) -> Value<V>
where V: Copy,

Maps a Value<&V> to a Value<V> by copying the contents of the value.

pub fn cloned(self) -> Value<V>
where V: Clone,

Maps a Value<&V> to a Value<V> by cloning the contents of the value.

impl<V> Value<&mut V>

pub fn copied(self) -> Value<V>
where V: Copy,

Maps a Value<&mut V> to a Value<V> by copying the contents of the value.

pub fn cloned(self) -> Value<V>
where V: Clone,

Maps a Value<&mut V> to a Value<V> by cloning the contents of the value.

impl<V, const LEN: usize> Value<[V; LEN]>
where V: Copy,

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

impl<V, I> Value
where I: IntoIterator<Item = V>, ::IntoIter: ExactSizeIterator,

pub fn transpose_vec(self, length: usize) -> Vec<Value<V>>

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.

impl<V> Value<V>

pub fn to_field<F>(&self) -> Value<Assigned<F>>
where F: Field, Assigned<F>: for<'v> From<&'v V>,

Returns the field element corresponding to this value.

pub fn into_field<F>(self) -> Value<Assigned<F>>
where F: Field, V: Into<Assigned<F>>,

Returns the field element corresponding to this value.

pub fn double<F>(&self) -> Value<Assigned<F>>
where F: Field, 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_frontend::circuit::Value;
use halo2_frontend::plonk::Assigned;

let v = Value::known(F::from(2));
let v: Value<Assigned<F>> = v.into();
let _ = v.double();

pub fn square<F>(&self) -> Value<Assigned<F>>
where F: Field, V: Borrow<Assigned<F>>,

Squares this field element.

pub fn cube<F>(&self) -> Value<Assigned<F>>
where F: Field, V: Borrow<Assigned<F>>,

Cubes this field element.

pub fn invert<F>(&self) -> Value<Assigned<F>>
where F: Field, V: Borrow<Assigned<F>>,

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

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

pub fn evaluate(self) -> Value<F>

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

If the denominator is zero, the returned value is zero.

Trait Implementations§

impl<V, O> Add<&Value<V>> for Value<V>
where V: for<'v> Add<&'v V, Output = O>,

type Output = Value<O>

The resulting type after applying the + operator.

fn add(self, rhs: &Value<V>) -> <Value<V> as Add<&Value<V>>>::Output

Performs the + operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.

fn add(self, rhs: F) -> <Value<&Assigned<F>> as Add<F>>::Output

Performs the + operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.

fn add(self, rhs: F) -> <Value<Assigned<F>> as Add<F>>::Output

Performs the + operation. Read more

impl<V, O> Add<Value<&V>> for Value<V>
where V: for<'v> Add<&'v V, Output = O>,

type Output = Value<O>

The resulting type after applying the + operator.

fn add(self, rhs: Value<&V>) -> <Value<V> as Add<Value<&V>>>::Output

Performs the + operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.

fn add(self, rhs: Value<F>) -> <Value<&Assigned<F>> as Add<Value<F>>>::Output

Performs the + operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the + operator.

fn add(self, rhs: Value<F>) -> <Value<Assigned<F>> as Add<Value<F>>>::Output

Performs the + operation. Read more

impl<V, O> Add<Value<V>> for &Value<V>
where &'v V: for<'v> Add<V, Output = O>,

type Output = Value<O>

The resulting type after applying the + operator.

fn add(self, rhs: Value<V>) -> <&Value<V> as Add<Value<V>>>::Output

Performs the + operation. Read more

impl<V, O> Add<Value<V>> for Value<&V>
where &'v V: for<'v> Add<V, Output = O>,

type Output = Value<O>

The resulting type after applying the + operator.

fn add(self, rhs: Value<V>) -> <Value<&V> as Add<Value<V>>>::Output

Performs the + operation. Read more

impl<V, O> Add for &Value<V>
where &'v V: for<'v> Add<Output = O>,

type Output = Value<O>

The resulting type after applying the + operator.

fn add(self, rhs: &Value<V>) -> <&Value<V> as Add>::Output

Performs the + operation. Read more

impl<V, O> Add for Value<V>
where V: Add<Output = O>,

type Output = Value<O>

The resulting type after applying the + operator.

fn add(self, rhs: Value<V>) -> <Value<V> as Add>::Output

Performs the + operation. Read more

impl<V> Clone for Value<V>
where V: Clone,

fn clone(&self) -> Value<V>

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

impl<V> Debug for Value<V>
where V: Debug,

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

Formats the value using the given formatter. Read more

impl<V> Default for Value<V>

fn default() -> Value<V>

Returns the “default value” for a type. Read more

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

fn from(value: Value<F>) -> Value<Assigned<F>>

Converts to this type from the input type.

impl<A, V> FromIterator<Value<A>> for Value<V>
where V: FromIterator<A>,

fn from_iter(iter: I) -> Value<V>
where I: IntoIterator<Item = Value<A>>,

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, O> Mul<&Value<V>> for Value<V>
where V: for<'v> Mul<&'v V, Output = O>,

type Output = Value<O>

The resulting type after applying the * operator.

fn mul(self, rhs: &Value<V>) -> <Value<V> as Mul<&Value<V>>>::Output

Performs the * operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.

fn mul(self, rhs: F) -> <Value<&Assigned<F>> as Mul<F>>::Output

Performs the * operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.

fn mul(self, rhs: F) -> <Value<Assigned<F>> as Mul<F>>::Output

Performs the * operation. Read more

impl<V, O> Mul<Value<&V>> for Value<V>
where V: for<'v> Mul<&'v V, Output = O>,

type Output = Value<O>

The resulting type after applying the * operator.

fn mul(self, rhs: Value<&V>) -> <Value<V> as Mul<Value<&V>>>::Output

Performs the * operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.

fn mul(self, rhs: Value<F>) -> <Value<&Assigned<F>> as Mul<Value<F>>>::Output

Performs the * operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the * operator.

fn mul(self, rhs: Value<F>) -> <Value<Assigned<F>> as Mul<Value<F>>>::Output

Performs the * operation. Read more

impl<V, O> Mul<Value<V>> for &Value<V>
where &'v V: for<'v> Mul<V, Output = O>,

type Output = Value<O>

The resulting type after applying the * operator.

fn mul(self, rhs: Value<V>) -> <&Value<V> as Mul<Value<V>>>::Output

Performs the * operation. Read more

impl<V, O> Mul<Value<V>> for Value<&V>
where &'v V: for<'v> Mul<V, Output = O>,

type Output = Value<O>

The resulting type after applying the * operator.

fn mul(self, rhs: Value<V>) -> <Value<&V> as Mul<Value<V>>>::Output

Performs the * operation. Read more

impl<V, O> Mul for &Value<V>
where &'v V: for<'v> Mul<Output = O>,

type Output = Value<O>

The resulting type after applying the * operator.

fn mul(self, rhs: &Value<V>) -> <&Value<V> as Mul>::Output

Performs the * operation. Read more

impl<V, O> Mul for Value<V>
where V: Mul<Output = O>,

type Output = Value<O>

The resulting type after applying the * operator.

fn mul(self, rhs: Value<V>) -> <Value<V> as Mul>::Output

Performs the * operation. Read more

impl<V> Neg for Value<V>
where V: Neg,

type Output = Value<<V as Neg>::Output>

The resulting type after applying the - operator.

fn neg(self) -> <Value<V> as Neg>::Output

Performs the unary - operation. Read more

impl<V, O> Sub<&Value<V>> for Value<V>
where V: for<'v> Sub<&'v V, Output = O>,

type Output = Value<O>

The resulting type after applying the - operator.

fn sub(self, rhs: &Value<V>) -> <Value<V> as Sub<&Value<V>>>::Output

Performs the - operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.

fn sub(self, rhs: F) -> <Value<&Assigned<F>> as Sub<F>>::Output

Performs the - operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.

fn sub(self, rhs: F) -> <Value<Assigned<F>> as Sub<F>>::Output

Performs the - operation. Read more

impl<V, O> Sub<Value<&V>> for Value<V>
where V: for<'v> Sub<&'v V, Output = O>,

type Output = Value<O>

The resulting type after applying the - operator.

fn sub(self, rhs: Value<&V>) -> <Value<V> as Sub<Value<&V>>>::Output

Performs the - operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.

fn sub(self, rhs: Value<F>) -> <Value<&Assigned<F>> as Sub<Value<F>>>::Output

Performs the - operation. Read more

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

type Output = Value<Assigned<F>>

The resulting type after applying the - operator.

fn sub(self, rhs: Value<F>) -> <Value<Assigned<F>> as Sub<Value<F>>>::Output

Performs the - operation. Read more

impl<V, O> Sub<Value<V>> for &Value<V>
where &'v V: for<'v> Sub<V, Output = O>,

type Output = Value<O>

The resulting type after applying the - operator.

fn sub(self, rhs: Value<V>) -> <&Value<V> as Sub<Value<V>>>::Output

Performs the - operation. Read more

impl<V, O> Sub<Value<V>> for Value<&V>
where &'v V: for<'v> Sub<V, Output = O>,

type Output = Value<O>

The resulting type after applying the - operator.

fn sub(self, rhs: Value<V>) -> <Value<&V> as Sub<Value<V>>>::Output

Performs the - operation. Read more

impl<V, O> Sub for &Value<V>
where &'v V: for<'v> Sub<Output = O>,

type Output = Value<O>

The resulting type after applying the - operator.

fn sub(self, rhs: &Value<V>) -> <&Value<V> as Sub>::Output

Performs the - operation. Read more

impl<V, O> Sub for Value<V>
where V: Sub<Output = O>,

type Output = Value<O>

The resulting type after applying the - operator.

fn sub(self, rhs: Value<V>) -> <Value<V> as Sub>::Output

Performs the - operation. Read more

impl<V> Copy for Value<V>
where V: Copy,

Auto Trait Implementations§

impl<V> UnwindSafe for Value<V>
where V: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

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

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

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

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

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