Enum snarkvm_wasm::FpGadget [−][src]
pub enum FpGadget<F> where
F: PrimeField, { Constant(F), Variable(AllocatedFp<F>), }
Expand description
Represent variables corresponding to a field element in F.
Variants
Constant (not an allocated variable).
Variable(AllocatedFp<F>)Allocated variable in the constraint system.
Implementations
pub fn from_boolean<CS>(
cs: CS,
other: Boolean
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn from_boolean<CS>(
cs: CS,
other: Boolean
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, Constructs Self from a Boolean: if other is false, this outputs
zero, else it outputs one.
Trait Implementations
pub fn alloc_constant<FN, T, CS>(
_cs: CS,
value_gen: FN
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>,
T: Borrow<F>,
FN: FnOnce() -> Result<T, SynthesisError>, pub fn alloc<FN, T, CS>(
cs: CS,
value_gen: FN
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>,
T: Borrow<F>,
FN: FnOnce() -> Result<T, SynthesisError>, pub fn alloc_input<FN, T, CS>(
cs: CS,
value_gen: FN
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>,
T: Borrow<F>,
FN: FnOnce() -> Result<T, SynthesisError>, fn alloc_checked<Fn, T, CS>(cs: CS, f: Fn) -> Result<Self, SynthesisError> where
Fn: FnOnce() -> Result<T, SynthesisError>,
CS: ConstraintSystem<F>,
T: Borrow<V>, fn alloc_input_checked<Fn, T, CS>(cs: CS, f: Fn) -> Result<Self, SynthesisError> where
Fn: FnOnce() -> Result<T, SynthesisError>,
CS: ConstraintSystem<F>,
T: Borrow<V>, pub fn conditionally_select<CS>(
cs: CS,
cond: &Boolean,
first: &FpGadget<F>,
second: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn conditionally_select<CS>(
cs: CS,
cond: &Boolean,
first: &FpGadget<F>,
second: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, Conditionally selects one of first and second based on the value of
self:
If cond is true, this outputs first; else, it outputs second.
pub fn conditional_enforce_equal<CS>(
&self,
cs: CS,
other: &FpGadget<F>,
condition: &Boolean
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>, pub fn is_eq<CS>(
&self,
cs: CS,
other: &FpGadget<F>
) -> Result<Boolean, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn is_eq<CS>(
&self,
cs: CS,
other: &FpGadget<F>
) -> Result<Boolean, SynthesisError> where
CS: ConstraintSystem<F>, Output a Boolean value representing whether self.value() == other.value(). Read more
fn enforce_equal<CS>(&self, cs: CS, other: &Self) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>, type Variable = ConstraintVariable<F>pub fn conditionally_add_constant<CS>(
&self,
_cs: CS,
bit: &Boolean,
coeff: F
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn add<CS>(
&self,
cs: CS,
other: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn double<CS>(&self, _cs: CS) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn double_in_place<CS>(
&mut self,
_cs: CS
) -> Result<&mut FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn sub<CS>(
&self,
cs: CS,
other: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn negate<CS>(&self, cs: CS) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn negate_in_place<CS>(
&mut self,
_cs: CS
) -> Result<&mut FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn mul<CS>(
&self,
cs: CS,
other: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn add_constant<CS>(
&self,
_cs: CS,
other: &F
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn add_constant_in_place<CS>(
&mut self,
_cs: CS,
other: &F
) -> Result<&mut FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn mul_by_constant<CS>(
&self,
cs: CS,
other: &F
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn mul_by_constant_in_place<CS>(
&mut self,
_cs: CS,
other: &F
) -> Result<&mut FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn inverse<CS>(&self, cs: CS) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn frobenius_map<CS>(
&self,
_cs: CS,
_power: usize
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn frobenius_map_in_place<CS>(
&mut self,
_cs: CS,
_power: usize
) -> Result<&mut FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn mul_equals<CS>(
&self,
cs: CS,
other: &FpGadget<F>,
result: &FpGadget<F>
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>, pub fn square_equals<CS>(
&self,
cs: CS,
result: &FpGadget<F>
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>, fn add_in_place<CS>(
&mut self,
cs: CS,
other: &Self
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>, fn sub_in_place<CS>(
&mut self,
cs: CS,
other: &Self
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>, fn mul_in_place<CS>(
&mut self,
cs: CS,
other: &Self
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>, fn square_in_place<CS>(&mut self, cs: CS) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>, fn sub_constant<CS>(&self, cs: CS, fe: &NativeF) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>, fn sub_constant_in_place<CS>(
&mut self,
cs: CS,
other: &NativeF
) -> Result<&mut Self, SynthesisError> where
CS: ConstraintSystem<F>, fn pow<CS>(&self, cs: CS, bits: &[Boolean]) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
fn pow<CS>(&self, cs: CS, bits: &[Boolean]) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>, Accepts as input a list of bits which, when interpreted in big-endian form, are a scalar. Read more
fn pow_by_constant<CS, S>(&self, cs: CS, exp: S) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
S: AsRef<[u64]>,
fn pow_by_constant<CS, S>(&self, cs: CS, exp: S) -> Result<Self, SynthesisError> where
CS: ConstraintSystem<F>,
S: AsRef<[u64]>, Computes self^S, where S is interpreted as an little-endian
u64-decomposition of an integer. Read more
Performs the conversion.
pub fn enforce_not_equal<CS>(
&self,
cs: CS,
other: &FpGadget<F>
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>, type TableConstant = Fpub fn three_bit_cond_neg_lookup<CS>(
cs: CS,
b: &[Boolean],
b0b1: &Boolean,
c: &[<FpGadget<F> as ThreeBitCondNegLookupGadget<F>>::TableConstant]
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn to_bits_be<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn to_bits_be<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>, Outputs the binary representation of the value in self in big-endian
form.
pub fn to_bits_be_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn to_bits_be_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>, Additionally checks if the produced list of booleans is ‘valid’.
pub fn to_bits_le<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn to_bits_le<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>, Outputs the binary representation of the value in self in little-endian
form.
pub fn to_bits_le_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn to_bits_le_strict<CS>(
&self,
cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
CS: ConstraintSystem<F>, Additionally checks if the produced list of booleans is ‘valid’.
pub fn to_bytes<CS>(&self, cs: CS) -> Result<Vec<UInt8, Global>, SynthesisError> where
CS: ConstraintSystem<F>, pub fn to_bytes_strict<CS>(
&self,
cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn to_bytes_strict<CS>(
&self,
cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
CS: ConstraintSystem<F>, Additionally checks if the produced list of booleans is ‘valid’.
pub fn to_constraint_field<CS>(
&self,
_cs: CS
) -> Result<Vec<FpGadget<F>, Global>, SynthesisError> where
CS: ConstraintSystem<F>,
pub fn to_constraint_field<CS>(
&self,
_cs: CS
) -> Result<Vec<FpGadget<F>, Global>, SynthesisError> where
CS: ConstraintSystem<F>, Converts self to FpGadget<F> variables.
Uses two bits to perform a lookup into a table
b is little-endian: b[0] is LSB.
type TableConstant = Fpub fn two_bit_lookup<CS>(
cs: CS,
b: &[Boolean],
c: &[<FpGadget<F> as TwoBitLookupGadget<F>>::TableConstant]
) -> Result<FpGadget<F>, SynthesisError> where
CS: ConstraintSystem<F>, Auto Trait Implementations
impl<F> RefUnwindSafe for FpGadget<F> where
F: RefUnwindSafe, impl<F> UnwindSafe for FpGadget<F> where
F: UnwindSafe, Blanket Implementations
Mutably borrows from an owned value. Read more
impl<F, T> ConditionalOrEqualsGadget<F> for T where
T: ConditionalEqGadget<F> + CondSelectGadget<F>,
F: Field,
impl<F, T> ConditionalOrEqualsGadget<F> for T where
T: ConditionalEqGadget<F> + CondSelectGadget<F>,
F: Field, pub fn conditional_enforce_equal_or<CS>(
cs: CS,
cond: &Boolean,
var: &T,
first: &T,
second: &T,
should_enforce: &Boolean
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>, Compare self to key and return true if they are equal.
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.
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
Causes 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, 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
pub fn enforce_equal_or<CS>(
cs: CS,
cond: &Boolean,
var: &T,
first: &T,
second: &T
) -> Result<(), SynthesisError> where
CS: ConstraintSystem<F>, impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized, Pipes by value. This is generally the method you want to use. Read more
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>,
R: 'a,
U: 'a + ?Sized,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
R: 'a,
U: 'a + ?Sized, 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>,
R: 'a,
U: 'a + ?Sized,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
R: 'a,
U: 'a + ?Sized, 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.
type Output = T
type Output = TShould always be Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
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,
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
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,
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
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .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)) -> SelfCalls .tap_mut() only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
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. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
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. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
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,
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
pub fn vzip(self) -> V