Enum ark_nonnative_field::NonNativeFieldVar

#[must_use]pub enum NonNativeFieldVar<TargetField: PrimeField, BaseField: PrimeField> {
    Constant(TargetField),
    Var(AllocatedNonNativeFieldVar<TargetField, BaseField>),
}

A gadget for representing non-native (TargetField) field elements over the constraint field (BaseField).

Variants

Constant(TargetField)

Constant

Var(AllocatedNonNativeFieldVar<TargetField, BaseField>)

Allocated gadget

Implementations

impl<TargetField: PrimeField, BaseField: PrimeField> NonNativeFieldVar<TargetField, BaseField>

pub fn mul_without_reduce(
    &self,
    other: &Self
) -> R1CSResult<NonNativeFieldMulResultVar<TargetField, BaseField>>

The mul_without_reduce for NonNativeFieldVar

Trait Implementations

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Add<&'a NonNativeFieldVar<TargetField, BaseField>> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Add<&'a NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the + operator.

fn add(
    self,
    other: &'a NonNativeFieldVar<TargetField, BaseField>
) -> Self::Output

Performs the + operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Add<NonNativeFieldVar<TargetField, BaseField>> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the + operator.

fn add(self, other: NonNativeFieldVar<TargetField, BaseField>) -> Self::Output

Performs the + operation.

impl<TargetField: PrimeField, BaseField: PrimeField> Add<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the + operator.

fn add(self, other: NonNativeFieldVar<TargetField, BaseField>) -> Self::Output

Performs the + operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Add<TargetField> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<TargetField: PrimeField, BaseField: PrimeField> Add<TargetField> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> AddAssign<&'a NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn add_assign(&mut self, other: &'a NonNativeFieldVar<TargetField, BaseField>)

Performs the += operation.

impl<TargetField: PrimeField, BaseField: PrimeField> AddAssign<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn add_assign(&mut self, other: NonNativeFieldVar<TargetField, BaseField>)

Performs the += operation.

impl<TargetField: PrimeField, BaseField: PrimeField> AddAssign<TargetField> for NonNativeFieldVar<TargetField, BaseField>

fn add_assign(&mut self, other: TargetField)

Performs the += operation.

impl<TargetField: PrimeField, BaseField: PrimeField> AllocVar<TargetField, BaseField> for NonNativeFieldVar<TargetField, BaseField>

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

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

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

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

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

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

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

impl<TargetField: Clone + PrimeField, BaseField: Clone + PrimeField> Clone for NonNativeFieldVar<TargetField, BaseField>

fn clone(&self) -> NonNativeFieldVar<TargetField, BaseField>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TargetField: PrimeField, BaseField: PrimeField> CondSelectGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField>

fn conditionally_select(
    cond: &Boolean<BaseField>,
    true_value: &Self,
    false_value: &Self
) -> R1CSResult<Self>

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

pub 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<TargetField: Debug + PrimeField, BaseField: Debug + PrimeField> Debug for NonNativeFieldVar<TargetField, BaseField>

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

Formats the value using the given formatter.

impl<TargetField: PrimeField, BaseField: PrimeField> Eq for NonNativeFieldVar<TargetField, BaseField>

impl<TargetField: PrimeField, BaseField: PrimeField> EqGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField>

fn is_eq(&self, other: &Self) -> R1CSResult<Boolean<BaseField>>

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

fn conditional_enforce_equal(
    &self,
    other: &Self,
    should_enforce: &Boolean<BaseField>
) -> R1CSResult<()>

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<BaseField>
) -> R1CSResult<()>

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

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

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

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

Enforce that self and other are equal.

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

Enforce that self and other are not equal.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> FieldOpsBounds<'a, TargetField, NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

impl<'a, TargetField: PrimeField, BaseField: PrimeField> FieldOpsBounds<'a, TargetField, NonNativeFieldVar<TargetField, BaseField>> for &'a NonNativeFieldVar<TargetField, BaseField>

impl<TargetField: PrimeField, BaseField: PrimeField> FieldVar<TargetField, BaseField> for NonNativeFieldVar<TargetField, BaseField>

fn zero() -> Self

Returns the constant F::zero().

fn one() -> Self

Returns the constant F::one().

fn constant(v: TargetField) -> Self

Returns a constant with value v.

fn negate(&self) -> R1CSResult<Self>

Coputes -self.

fn inverse(&self) -> R1CSResult<Self>

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

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

Computes the frobenius map over self.

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

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

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

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

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

Computes self + self.

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

Sets self = self + self.

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

Sets self = -self.

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

Computes self * self.

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

Sets self = self.square().

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

Enforces that self * other == result.

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

Enforces that self * self == result.

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

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

Sets self = self.frobenius_map().

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

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

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

impl<TargetField: PrimeField, BaseField: PrimeField> From<&'_ NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldMulResultVar<TargetField, BaseField>

fn from(src: &NonNativeFieldVar<TargetField, BaseField>) -> Self

Performs the conversion.

impl<TargetField: PrimeField, BaseField: PrimeField> From<AllocatedNonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn from(other: AllocatedNonNativeFieldVar<TargetField, BaseField>) -> Self

Performs the conversion.

impl<TargetField: PrimeField, BaseField: PrimeField> From<Boolean<BaseField>> for NonNativeFieldVar<TargetField, BaseField>

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

Performs the conversion.

impl<TargetField: PrimeField, BaseField: PrimeField> Hash for NonNativeFieldVar<TargetField, BaseField>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Mul<&'a NonNativeFieldVar<TargetField, BaseField>> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Mul<&'a NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the * operator.

fn mul(
    self,
    other: &'a NonNativeFieldVar<TargetField, BaseField>
) -> Self::Output

Performs the * operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Mul<NonNativeFieldVar<TargetField, BaseField>> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the * operator.

fn mul(self, other: NonNativeFieldVar<TargetField, BaseField>) -> Self::Output

Performs the * operation.

impl<TargetField: PrimeField, BaseField: PrimeField> Mul<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the * operator.

fn mul(self, other: NonNativeFieldVar<TargetField, BaseField>) -> Self::Output

Performs the * operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Mul<TargetField> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<TargetField: PrimeField, BaseField: PrimeField> Mul<TargetField> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> MulAssign<&'a NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn mul_assign(&mut self, other: &'a NonNativeFieldVar<TargetField, BaseField>)

Performs the *= operation.

impl<TargetField: PrimeField, BaseField: PrimeField> MulAssign<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn mul_assign(&mut self, other: NonNativeFieldVar<TargetField, BaseField>)

Performs the *= operation.

impl<TargetField: PrimeField, BaseField: PrimeField> MulAssign<TargetField> for NonNativeFieldVar<TargetField, BaseField>

fn mul_assign(&mut self, other: TargetField)

Performs the *= operation.

impl<TargetField: PrimeField, BaseField: PrimeField> PartialEq<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn eq(&self, other: &Self) -> 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<TargetField: PrimeField, BaseField: PrimeField> R1CSVar<BaseField> for NonNativeFieldVar<TargetField, BaseField>

type Value = TargetField

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

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

Returns the underlying ConstraintSystemRef.

fn value(&self) -> R1CSResult<Self::Value>

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

pub fn is_constant(&self) -> bool

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

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Sub<&'a NonNativeFieldVar<TargetField, BaseField>> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Sub<&'a NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the - operator.

fn sub(
    self,
    other: &'a NonNativeFieldVar<TargetField, BaseField>
) -> Self::Output

Performs the - operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Sub<NonNativeFieldVar<TargetField, BaseField>> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the - operator.

fn sub(self, other: NonNativeFieldVar<TargetField, BaseField>) -> Self::Output

Performs the - operation.

impl<TargetField: PrimeField, BaseField: PrimeField> Sub<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the - operator.

fn sub(self, other: NonNativeFieldVar<TargetField, BaseField>) -> Self::Output

Performs the - operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> Sub<TargetField> for &'a NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<TargetField: PrimeField, BaseField: PrimeField> Sub<TargetField> for NonNativeFieldVar<TargetField, BaseField>

type Output = NonNativeFieldVar<TargetField, BaseField>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, TargetField: PrimeField, BaseField: PrimeField> SubAssign<&'a NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn sub_assign(&mut self, other: &'a NonNativeFieldVar<TargetField, BaseField>)

Performs the -= operation.

impl<TargetField: PrimeField, BaseField: PrimeField> SubAssign<NonNativeFieldVar<TargetField, BaseField>> for NonNativeFieldVar<TargetField, BaseField>

fn sub_assign(&mut self, other: NonNativeFieldVar<TargetField, BaseField>)

Performs the -= operation.

impl<TargetField: PrimeField, BaseField: PrimeField> SubAssign<TargetField> for NonNativeFieldVar<TargetField, BaseField>

fn sub_assign(&mut self, other: TargetField)

Performs the -= operation.

impl<TargetField: PrimeField, BaseField: PrimeField> ThreeBitCondNegLookupGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField>

type TableConstant = TargetField

The type of values being looked up.

fn three_bit_cond_neg_lookup(
    b: &[Boolean<BaseField>],
    b0b1: &Boolean<BaseField>,
    c: &[Self::TableConstant]
) -> R1CSResult<Self>

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<TargetField: PrimeField, BaseField: PrimeField> ToBitsGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField>

fn to_bits_le(&self) -> R1CSResult<Vec<Boolean<BaseField>>>

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

fn to_non_unique_bits_le(&self) -> R1CSResult<Vec<Boolean<BaseField>>>

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

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

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

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

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

impl<TargetField: PrimeField, BaseField: PrimeField> ToBytesGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField>

fn to_bytes(&self) -> R1CSResult<Vec<UInt8<BaseField>>>

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

fn to_non_unique_bytes(&self) -> R1CSResult<Vec<UInt8<BaseField>>>

Outputs a possibly non-unique byte decomposition of self.

impl<TargetField: PrimeField, BaseField: PrimeField> ToConstraintFieldGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField>

fn to_constraint_field(&self) -> R1CSResult<Vec<FpVar<BaseField>>>

Converts self to FpVar<ConstraintF> variables.

impl<TargetField: PrimeField, BaseField: PrimeField> TwoBitLookupGadget<BaseField> for NonNativeFieldVar<TargetField, BaseField>

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

type TableConstant = TargetField

The type of values being looked up.

fn two_bit_lookup(
    b: &[Boolean<BaseField>],
    c: &[Self::TableConstant]
) -> R1CSResult<Self>

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