Struct snarkvm_wasm::fields::AllocatedFp

pub struct AllocatedFp<F> where
    F: PrimeField,  {
    pub value: Option<F>,
    pub variable: ConstraintVariable<F>,
}

Represents a variable in the constraint system whose value can be an arbitrary field element.

Fields

value: Option<F>

variable: ConstraintVariable<F>

Implementations

impl<F> AllocatedFp<F> where
    F: PrimeField, 

pub fn from<CS>(cs: CS, value: &F) -> AllocatedFp<F> where
    CS: ConstraintSystem<F>, 

impl<F> AllocatedFp<F> where
    F: PrimeField, 

pub fn from_boolean<CS>(
    cs: CS,
    other: Boolean
) -> Result<AllocatedFp<F>, SynthesisError> where
    CS: ConstraintSystem<F>, 

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

Trait Implementations

impl<F> AllocGadget<F, F> for AllocatedFp<F> where
    F: PrimeField, 

pub fn alloc_constant<FN, T, CS>(
    cs: CS,
    value_gen: FN
) -> Result<AllocatedFp<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<AllocatedFp<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<AllocatedFp<F>, SynthesisError> where
    CS: ConstraintSystem<F>,
    T: Borrow<F>,
    FN: FnOnce() -> Result<T, SynthesisError>, 

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

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

impl<F> Clone for AllocatedFp<F> where
    F: PrimeField, 

pub fn clone(&self) -> AllocatedFp<F>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F> CondSelectGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

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

pub fn cost() -> usize

impl<F> ConditionalEqGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

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

pub fn cost() -> usize

impl<F> Debug for AllocatedFp<F> where
    F: Debug + PrimeField, 

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

Formats the value using the given formatter.

impl<F> Eq for AllocatedFp<F> where
    F: PrimeField, 

impl<F> EqGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

pub fn enforce_equal<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

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

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

Performs the conversion.

impl<F> NEqGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

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

pub fn cost() -> usize

impl<F> PartialEq<AllocatedFp<F>> for AllocatedFp<F> where
    F: PrimeField, 

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<F> ThreeBitCondNegLookupGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

type TableConstant = F

pub fn three_bit_cond_neg_lookup<CS>(
    cs: CS,
    b: &[Boolean],
    b0b1: &Boolean,
    c: &[<AllocatedFp<F> as ThreeBitCondNegLookupGadget<F>>::TableConstant]
) -> Result<AllocatedFp<F>, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

impl<F> ToBitsGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

pub fn to_bits<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_strict<CS>(
    &self,
    cs: CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, 

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

impl<F> ToBytesGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

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

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

impl<F> TwoBitLookupGadget<F> for AllocatedFp<F> where
    F: PrimeField, 

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: &[<AllocatedFp<F> as TwoBitLookupGadget<F>>::TableConstant]
) -> Result<AllocatedFp<F>, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize