Enum snarkvm_wasm::fields::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(F)

Constant (not an allocated variable).

Variable(AllocatedFp<F>)

Allocated variable in the constraint system.

Implementations

impl<F> FpGadget<F> where
    F: PrimeField, [src]

pub fn from_boolean<CS>(
    cs: CS,
    other: Boolean
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

Constructs Self from a Boolean: if other is false, this outputs zero, else it outputs one.

Trait Implementations

impl<F> AllocGadget<F, F> for FpGadget<F> where
    F: PrimeField, [src]

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>, [src]

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>, [src]

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>, [src]

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>, [src]

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>, [src]

impl<F> Clone for FpGadget<F> where
    F: Clone + PrimeField, [src]

pub fn clone(&self) -> FpGadget<F>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<F> CondSelectGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn conditionally_select<CS>(
    cs: CS,
    cond: &Boolean,
    first: &FpGadget<F>,
    second: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

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 cost() -> usize[src]

impl<F> ConditionalEqGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn conditional_enforce_equal<CS>(
    &self,
    cs: CS,
    other: &FpGadget<F>,
    condition: &Boolean
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn cost() -> usize[src]

impl<F> Debug for FpGadget<F> where
    F: Debug + PrimeField, [src]

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

Formats the value using the given formatter. Read more

impl<F> EqGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn is_eq<CS>(
    &self,
    cs: CS,
    other: &FpGadget<F>
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

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>, [src]

fn cost() -> usize[src]

impl<F> FieldGadget<F, F> for FpGadget<F> where
    F: PrimeField, [src]

type Variable = ConstraintVariable<F>

pub fn get_value(&self) -> Option<F>[src]

pub fn get_variable(&self) -> <FpGadget<F> as FieldGadget<F, F>>::Variable[src]

pub fn zero<CS>(_cs: CS) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn one<CS>(_cs: CS) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn conditionally_add_constant<CS>(
    &self,
    _cs: CS,
    bit: &Boolean,
    coeff: F
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn add<CS>(
    &self,
    cs: CS,
    other: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn double<CS>(&self, _cs: CS) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn double_in_place<CS>(
    &mut self,
    _cs: CS
) -> Result<&mut FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn sub<CS>(
    &self,
    cs: CS,
    other: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn negate<CS>(&self, cs: CS) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn negate_in_place<CS>(
    &mut self,
    _cs: CS
) -> Result<&mut FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn mul<CS>(
    &self,
    cs: CS,
    other: &FpGadget<F>
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn add_constant<CS>(
    &self,
    _cs: CS,
    other: &F
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn add_constant_in_place<CS>(
    &mut self,
    _cs: CS,
    other: &F
) -> Result<&mut FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn mul_by_constant<CS>(
    &self,
    cs: CS,
    other: &F
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn mul_by_constant_in_place<CS>(
    &mut self,
    _cs: CS,
    other: &F
) -> Result<&mut FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn inverse<CS>(&self, cs: CS) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn frobenius_map<CS>(
    &self,
    _cs: CS,
    _power: usize
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn frobenius_map_in_place<CS>(
    &mut self,
    _cs: CS,
    _power: usize
) -> Result<&mut FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn mul_equals<CS>(
    &self,
    cs: CS,
    other: &FpGadget<F>,
    result: &FpGadget<F>
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn square_equals<CS>(
    &self,
    cs: CS,
    result: &FpGadget<F>
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn cost_of_mul() -> usize[src]

pub fn cost_of_inv() -> usize[src]

fn add_in_place<CS>(
    &mut self,
    cs: CS,
    other: &Self
) -> Result<&mut Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

fn sub_in_place<CS>(
    &mut self,
    cs: CS,
    other: &Self
) -> Result<&mut Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

fn mul_in_place<CS>(
    &mut self,
    cs: CS,
    other: &Self
) -> Result<&mut Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

fn square<CS>(&self, cs: CS) -> Result<Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

fn square_in_place<CS>(&mut self, cs: CS) -> Result<&mut Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

fn sub_constant<CS>(&self, cs: CS, fe: &NativeF) -> Result<Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

fn sub_constant_in_place<CS>(
    &mut self,
    cs: CS,
    other: &NativeF
) -> Result<&mut Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

fn pow<CS>(&self, cs: CS, bits: &[Boolean]) -> Result<Self, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

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]>, [src]

Computes self^S, where S is interpreted as an little-endian u64-decomposition of an integer. Read more

impl<F> From<AllocatedFp<F>> for FpGadget<F> where
    F: PrimeField, [src]

pub fn from(other: AllocatedFp<F>) -> FpGadget<F>[src]

Performs the conversion.

impl<F> NEqGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn enforce_not_equal<CS>(
    &self,
    cs: CS,
    other: &FpGadget<F>
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn cost() -> usize[src]

impl<F> PartialEq<FpGadget<F>> for FpGadget<F> where
    F: PrimeField, [src]

pub fn eq(&self, other: &FpGadget<F>) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]

This method tests for !=.

impl<F> ThreeBitCondNegLookupGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

type TableConstant = F

pub 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>, [src]

pub fn cost() -> usize[src]

impl<F> ToBitsBEGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn to_bits_be<CS>(
    &self,
    cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

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>, [src]

Additionally checks if the produced list of booleans is ‘valid’.

impl<F> ToBitsLEGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn to_bits_le<CS>(
    &self,
    cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

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>, [src]

Additionally checks if the produced list of booleans is ‘valid’.

impl<F> ToBytesGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn to_bytes<CS>(&self, cs: CS) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn to_bytes_strict<CS>(
    &self,
    cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

Additionally checks if the produced list of booleans is ‘valid’.

impl<F> ToConstraintFieldGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

pub fn to_constraint_field<CS>(
    &self,
    _cs: CS
) -> Result<Vec<FpGadget<F>, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

Converts self to FpGadget<F> variables.

impl<F> TwoBitLookupGadget<F> for FpGadget<F> where
    F: PrimeField, [src]

Uses two bits to perform a lookup into a table b is little-endian: b[0] is LSB.

type TableConstant = F

pub fn two_bit_lookup<CS>(
    cs: CS,
    b: &[Boolean],
    c: &[<FpGadget<F> as TwoBitLookupGadget<F>>::TableConstant]
) -> Result<FpGadget<F>, SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn cost() -> usize[src]

impl<F> Eq for FpGadget<F> where
    F: PrimeField, [src]

Auto Trait Implementations

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

impl<F> Send for FpGadget<F>

impl<F> Sync for FpGadget<F>

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

impl<F> UnwindSafe for FpGadget<F> where
    F: UnwindSafe, 

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<F, T> ConditionalOrEqualsGadget<F> for T where
    T: ConditionalEqGadget<F> + CondSelectGadget<F>,
    F: Field, [src]

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>, [src]

pub fn cost() -> usize[src]

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized, [src]

pub fn equivalent(&self, key: &K) -> bool[src]

Compare self to key and return true if they are equal.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<F, T> OrEqualsGadget<F> for T where
    T: ConditionalOrEqualsGadget<F>,
    F: Field, [src]

pub fn enforce_equal_or<CS>(
    cs: CS,
    cond: &Boolean,
    var: &T,
    first: &T,
    second: &T
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, [src]

pub fn cost() -> usize[src]

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

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

pub fn vzip(self) -> V