Enum ark_r1cs_std::fields::fp::FpVar

#[must_use]pub enum FpVar<F: PrimeField> {
    Constant(F),
    Var(AllocatedFp<F>),
}

Represent variables corresponding to a field element in F.

Variants

Constant(F)

Represents a constant in the constraint system, which means that it does not have a corresponding variable.

Var(AllocatedFp<F>)

Represents an allocated variable constant in the constraint system.

Implementations

impl<F: PrimeField> FpVar<F>

pub fn enforce_cmp(
    &self,
    other: &FpVar<F>,
    ordering: Ordering,
    should_also_check_equality: bool
) -> Result<(), SynthesisError>

This function enforces the ordering between self and other. The constraint system will not be satisfied otherwise. If self should also be checked for equality, e.g. self <= other instead of self < other, set should_also_check_quality to true. This variant verifies self and other are <= (p-1)/2.

pub fn enforce_cmp_unchecked(
    &self,
    other: &FpVar<F>,
    ordering: Ordering,
    should_also_check_equality: bool
) -> Result<(), SynthesisError>

This function enforces the ordering between self and other. The constraint system will not be satisfied otherwise. If self should also be checked for equality, e.g. self <= other instead of self < other, set should_also_check_quality to true. This variant assumes self and other are <= (p-1)/2 and does not generate constraints to verify that.

pub fn is_cmp(
    &self,
    other: &FpVar<F>,
    ordering: Ordering,
    should_also_check_equality: bool
) -> Result<Boolean<F>, SynthesisError>

This function checks the ordering between self and other. It outputs self Boolean that contains the result - 1 if true, 0 otherwise. The constraint system will be satisfied in any case. If self should also be checked for equality, e.g. self <= other instead of self < other, set should_also_check_quality to true. This variant verifies self and other are <= (p-1)/2.

pub fn is_cmp_unchecked(
    &self,
    other: &FpVar<F>,
    ordering: Ordering,
    should_also_check_equality: bool
) -> Result<Boolean<F>, SynthesisError>

This function checks the ordering between self and other. It outputs a Boolean that contains the result - 1 if true, 0 otherwise. The constraint system will be satisfied in any case. If self should also be checked for equality, e.g. self <= other instead of self < other, set should_also_check_quality to true. This variant assumes self and other are <= (p-1)/2 and does not generate constraints to verify that.

pub fn enforce_smaller_or_equal_than_mod_minus_one_div_two(
    &self
) -> Result<(), SynthesisError>

Helper function to enforce that self <= (p-1)/2.

Trait Implementations

impl<'a, F: PrimeField> Add<&'a FpVar<F>> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<'a, F: PrimeField> Add<&'a FpVar<F>> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the + operator.

fn add(self, other: &'a FpVar<F>) -> Self::Output

Performs the + operation.

impl<'a, F: PrimeField> Add<F> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the + operator.

fn add(self, other: F) -> Self::Output

Performs the + operation.

impl<F: PrimeField> Add<F> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the + operator.

fn add(self, other: F) -> Self::Output

Performs the + operation.

impl<'a, F: PrimeField> Add<FpVar<F>> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the + operator.

fn add(self, other: FpVar<F>) -> Self::Output

Performs the + operation.

impl<F: PrimeField> Add<FpVar<F>> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the + operator.

fn add(self, other: FpVar<F>) -> Self::Output

Performs the + operation.

impl<'a, F: PrimeField> AddAssign<&'a FpVar<F>> for FpVar<F>

fn add_assign(&mut self, other: &'a FpVar<F>)

Performs the += operation.

impl<F: PrimeField> AddAssign<F> for FpVar<F>

fn add_assign(&mut self, other: F)

Performs the += operation.

impl<F: PrimeField> AddAssign<FpVar<F>> for FpVar<F>

fn add_assign(&mut self, other: FpVar<F>)

Performs the += operation.

impl<F: PrimeField> AllocVar<F, F> for FpVar<F>

fn new_variable<T: Borrow<F>>(
    cs: impl Into<Namespace<F>>,
    f: impl FnOnce() -> Result<T, SynthesisError>,
    mode: AllocationMode
) -> Result<Self, SynthesisError>

Allocates a new variable of type Self in the ConstraintSystem cs. The mode of allocation is decided by mode.

fn new_constant(
    cs: impl Into<Namespace<F>>,
    t: impl Borrow<V>
) -> Result<Self, SynthesisError>

Allocates a new constant of type Self in the ConstraintSystem cs.

fn new_input<T: Borrow<V>>(
    cs: impl Into<Namespace<F>>,
    f: impl FnOnce() -> Result<T, SynthesisError>
) -> Result<Self, SynthesisError>

Allocates a new public input of type Self in the ConstraintSystem cs.

fn new_witness<T: Borrow<V>>(
    cs: impl Into<Namespace<F>>,
    f: impl FnOnce() -> Result<T, SynthesisError>
) -> Result<Self, SynthesisError>

Allocates a new private witness of type Self in the ConstraintSystem cs.

impl<F: Clone + PrimeField> Clone for FpVar<F>

fn clone(&self) -> FpVar<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: PrimeField> CondSelectGadget<F> for FpVar<F>

fn conditionally_select(
    cond: &Boolean<F>,
    true_value: &Self,
    false_value: &Self
) -> Result<Self, SynthesisError>

If cond == &Boolean::TRUE, then this returns true_value; else, returns false_value.

fn conditionally_select_power_of_two_vector(
    position: &[Boolean<ConstraintF>],
    values: &[Self]
) -> Result<Self, SynthesisError>

Returns an element of values whose index in represented by position. position is an array of boolean that represents an unsigned integer in big endian order.

impl<P: Fp3Parameters> CubicExtVarParams<FpVar<<P as Fp3Parameters>::Fp>> for Fp3ParamsWrapper<P>

fn mul_base_field_vars_by_frob_coeff(
    c1: &mut FpVar<P::Fp>,
    c2: &mut FpVar<P::Fp>,
    power: usize
)

Multiply the base field of the CubicExtVar by the appropriate Frobenius coefficient. This is equivalent to Self::mul_base_field_by_frob_coeff(c1, c2, power).

impl<F: Debug + PrimeField> Debug for FpVar<F>

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

Formats the value using the given formatter.

impl<F: PrimeField> EqGadget<F> for FpVar<F>

---

---

fn is_eq(&self, other: &Self) -> Result<Boolean<F>, SynthesisError>

Output a Boolean value representing whether self.value() == other.value().

fn conditional_enforce_equal(
    &self,
    other: &Self,
    should_enforce: &Boolean<F>
) -> Result<(), SynthesisError>

If should_enforce == true, enforce that self and other are equal; else, enforce a vacuously true statement.

fn conditional_enforce_not_equal(
    &self,
    other: &Self,
    should_enforce: &Boolean<F>
) -> Result<(), SynthesisError>

If should_enforce == true, enforce that self and other are not equal; else, enforce a vacuously true statement.

fn is_neq(&self, other: &Self) -> Result<Boolean<F>, SynthesisError>

Output a Boolean value representing whether self.value() != other.value().

fn enforce_equal(&self, other: &Self) -> Result<(), SynthesisError>

Enforce that self and other are equal.

fn enforce_not_equal(&self, other: &Self) -> Result<(), SynthesisError>

Enforce that self and other are not equal.

impl<'a, F: PrimeField> FieldOpsBounds<'a, F, FpVar<F>> for FpVar<F>

impl<'a, F: PrimeField> FieldOpsBounds<'a, F, FpVar<F>> for &'a FpVar<F>

impl<F: PrimeField> FieldVar<F, F> for FpVar<F>

fn constant(f: F) -> Self

Returns a constant with value v.

fn zero() -> Self

Returns the constant F::zero().

fn one() -> Self

Returns the constant F::one().

fn double(&self) -> Result<Self, SynthesisError>

Computes self + self.

fn negate(&self) -> Result<Self, SynthesisError>

Coputes -self.

fn square(&self) -> Result<Self, SynthesisError>

Computes self * self.

fn mul_equals(&self, other: &Self, result: &Self) -> Result<(), SynthesisError>

Enforce that self * other == result.

fn square_equals(&self, result: &Self) -> Result<(), SynthesisError>

Enforce that self * self == result.

fn inverse(&self) -> Result<Self, SynthesisError>

Computes result such that self * result == Self::one().

fn frobenius_map(&self, power: usize) -> Result<Self, SynthesisError>

Computes the frobenius map over self.

fn frobenius_map_in_place(
    &mut self,
    power: usize
) -> Result<&mut Self, SynthesisError>

Sets self = self.frobenius_map().

fn is_zero(&self) -> Result<Boolean<ConstraintF>, SynthesisError>

Returns a Boolean representing whether self == Self::zero().

fn is_one(&self) -> Result<Boolean<ConstraintF>, SynthesisError>

Returns a Boolean representing whether self == Self::one().

fn double_in_place(&mut self) -> Result<&mut Self, SynthesisError>

Sets self = self + self.

fn negate_in_place(&mut self) -> Result<&mut Self, SynthesisError>

Sets self = -self.

fn square_in_place(&mut self) -> Result<&mut Self, SynthesisError>

Sets self = self.square().

fn mul_by_inverse(&self, d: &Self) -> Result<Self, SynthesisError>

Returns (self / d). but requires fewer constraints than self * d.inverse(). It is up to the caller to ensure that d is non-zero, since in that case the result is unconstrained.

fn pow_le(&self, bits: &[Boolean<ConstraintF>]) -> Result<Self, SynthesisError>

Comptues self^bits, where bits is a little-endian bit-wise decomposition of the exponent.

fn pow_by_constant<S: AsRef<[u64]>>(
    &self,
    exp: S
) -> Result<Self, SynthesisError>

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

impl<F: PrimeField> From<AllocatedFp<F>> for FpVar<F>

fn from(other: AllocatedFp<F>) -> Self

Performs the conversion.

impl<F: PrimeField> From<Boolean<F>> for FpVar<F>

fn from(other: Boolean<F>) -> Self

Performs the conversion.

impl<'a, F: PrimeField> Mul<&'a FpVar<F>> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<'a, F: PrimeField> Mul<&'a FpVar<F>> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the * operator.

fn mul(self, other: &'a FpVar<F>) -> Self::Output

Performs the * operation.

impl<'a, F: PrimeField> Mul<F> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the * operator.

fn mul(self, other: F) -> Self::Output

Performs the * operation.

impl<F: PrimeField> Mul<F> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the * operator.

fn mul(self, other: F) -> Self::Output

Performs the * operation.

impl<'a, F: PrimeField> Mul<FpVar<F>> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the * operator.

fn mul(self, other: FpVar<F>) -> Self::Output

Performs the * operation.

impl<F: PrimeField> Mul<FpVar<F>> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the * operator.

fn mul(self, other: FpVar<F>) -> Self::Output

Performs the * operation.

impl<'a, F: PrimeField> MulAssign<&'a FpVar<F>> for FpVar<F>

fn mul_assign(&mut self, other: &'a FpVar<F>)

Performs the *= operation.

impl<F: PrimeField> MulAssign<F> for FpVar<F>

fn mul_assign(&mut self, other: F)

Performs the *= operation.

impl<F: PrimeField> MulAssign<FpVar<F>> for FpVar<F>

fn mul_assign(&mut self, other: FpVar<F>)

Performs the *= operation.

impl<P: Fp2Parameters> QuadExtVarParams<FpVar<<P as Fp2Parameters>::Fp>> for Fp2ParamsWrapper<P>

fn mul_base_field_var_by_frob_coeff(fe: &mut FpVar<P::Fp>, power: usize)

Multiply the base field of the QuadExtVar by the appropriate Frobenius coefficient. This is equivalent to Self::mul_base_field_by_frob_coeff(power).

impl<F: PrimeField> R1CSVar<F> for FpVar<F>

type Value = F

The type of the “native” value that Self represents in the constraint system.

fn cs(&self) -> ConstraintSystemRef<F>

Returns the underlying ConstraintSystemRef.

fn value(&self) -> Result<Self::Value, SynthesisError>

Returns the value that is assigned to self in the underlying ConstraintSystem.

fn is_constant(&self) -> bool

Returns true if self is a circuit-generation-time constant.

impl<'a, F: PrimeField> Sub<&'a FpVar<F>> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<'a, F: PrimeField> Sub<&'a FpVar<F>> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the - operator.

fn sub(self, other: &'a FpVar<F>) -> Self::Output

Performs the - operation.

impl<'a, F: PrimeField> Sub<F> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the - operator.

fn sub(self, other: F) -> Self::Output

Performs the - operation.

impl<F: PrimeField> Sub<F> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the - operator.

fn sub(self, other: F) -> Self::Output

Performs the - operation.

impl<'a, F: PrimeField> Sub<FpVar<F>> for &'a FpVar<F>

type Output = FpVar<F>

The resulting type after applying the - operator.

fn sub(self, other: FpVar<F>) -> Self::Output

Performs the - operation.

impl<F: PrimeField> Sub<FpVar<F>> for FpVar<F>

type Output = FpVar<F>

The resulting type after applying the - operator.

fn sub(self, other: FpVar<F>) -> Self::Output

Performs the - operation.

impl<'a, F: PrimeField> SubAssign<&'a FpVar<F>> for FpVar<F>

fn sub_assign(&mut self, other: &'a FpVar<F>)

Performs the -= operation.

impl<F: PrimeField> SubAssign<F> for FpVar<F>

fn sub_assign(&mut self, other: F)

Performs the -= operation.

impl<F: PrimeField> SubAssign<FpVar<F>> for FpVar<F>

fn sub_assign(&mut self, other: FpVar<F>)

Performs the -= operation.

impl<F: PrimeField> ThreeBitCondNegLookupGadget<F> for FpVar<F>

type TableConstant = F

The type of values being looked up.

fn three_bit_cond_neg_lookup(
    b: &[Boolean<F>],
    b0b1: &Boolean<F>,
    c: &[Self::TableConstant]
) -> Result<Self, SynthesisError>

Interprets the slice bits as a two-bit integer b = bits[0] + (bits[1] << 1), and then outputs constants[b] * c, where c = if bits[2] { -1 } else { 1 };.

impl<F: PrimeField> ToBitsGadget<F> for FpVar<F>

fn to_bits_le(&self) -> Result<Vec<Boolean<F>>, SynthesisError>

Outputs the canonical little-endian bit-wise representation of self.

fn to_non_unique_bits_le(&self) -> Result<Vec<Boolean<F>>, SynthesisError>

Outputs a possibly non-unique little-endian bit-wise representation of self.

fn to_bits_be(&self) -> Result<Vec<Boolean<F>>, SynthesisError>

Outputs the canonical big-endian bit-wise representation of self.

fn to_non_unique_bits_be(&self) -> Result<Vec<Boolean<F>>, SynthesisError>

Outputs a possibly non-unique big-endian bit-wise representation of self.

impl<F: PrimeField> ToBytesGadget<F> for FpVar<F>

fn to_bytes(&self) -> Result<Vec<UInt8<F>>, SynthesisError>

Outputs the unique byte decomposition of self in little-endian form.

fn to_non_unique_bytes(&self) -> Result<Vec<UInt8<F>>, SynthesisError>

Outputs a possibly non-unique byte decomposition of self.

impl<F: PrimeField> ToConstraintFieldGadget<F> for FpVar<F>

fn to_constraint_field(&self) -> Result<Vec<FpVar<F>>, SynthesisError>

Converts self to FpVar<ConstraintF> variables.

impl<F: PrimeField> TwoBitLookupGadget<F> for FpVar<F>

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

type TableConstant = F

The type of values being looked up.

fn two_bit_lookup(
    b: &[Boolean<F>],
    c: &[Self::TableConstant]
) -> Result<Self, SynthesisError>

Interprets the slice bits as a two-bit integer b = bits[0] + (bits[1] << 1), and then outputs constants[b].