Struct snarkvm_circuit_types_field::Field

pub struct Field<E: Environment> { /* private fields */ }

Trait Implementations

impl<E: Environment> Add<&Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the + operator.

fn add(self, other: &Field<E>) -> Self::Output

Performs the + operation.

impl<E: Environment> Add<&Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the + operator.

fn add(self, other: &Field<E>) -> Self::Output

Performs the + operation.

impl<E: Environment> Add<Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E: Environment> Add<Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E: Environment> AddAssign<&Field<E>> for Field<E>

fn add_assign(&mut self, other: &Field<E>)

Performs the += operation.

impl<E: Environment> AddAssign<Field<E>> for Field<E>

fn add_assign(&mut self, other: Field<E>)

Performs the += operation.

impl<E: Clone + Environment> Clone for Field<E> where
    E::BaseField: Clone, 

fn clone(&self) -> Field<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Environment> Compare<Field<E>> for Field<E>

fn is_less_than(&self, other: &Self) -> Self::Output

Returns true if self is less than other.

fn is_greater_than(&self, other: &Self) -> Self::Output

Returns true if self is greater than other.

fn is_less_than_or_equal(&self, other: &Self) -> Self::Output

Returns true if self is less than or equal to other.

fn is_greater_than_or_equal(&self, other: &Self) -> Self::Output

Returns true if self is greater than or equal to other.

type Output = Boolean<E>

impl<E: Environment> Debug for Field<E>

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

Formats the value using the given formatter.

impl<E: Environment> Display for Field<E>

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

Formats the value using the given formatter.

impl<E: Environment> Div<&Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the / operator.

fn div(self, other: &Field<E>) -> Self::Output

Performs the / operation.

impl<E: Environment> Div<&Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the / operator.

fn div(self, other: &Field<E>) -> Self::Output

Performs the / operation.

impl<E: Environment> Div<Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the / operator.

fn div(self, other: Field<E>) -> Self::Output

Performs the / operation.

impl<E: Environment> Div<Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the / operator.

fn div(self, other: Field<E>) -> Self::Output

Performs the / operation.

impl<E: Environment> DivAssign<&Field<E>> for Field<E>

fn div_assign(&mut self, other: &Self)

Performs the /= operation.

impl<E: Environment> DivAssign<Field<E>> for Field<E>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<E: Environment> Double for Field<E>

type Output = Field<E>

fn double(&self) -> Self::Output

impl<E: Environment> Eject for Field<E>

fn eject_mode(&self) -> Mode

Ejects the mode of the field circuit.

fn eject_value(&self) -> Self::Primitive

Ejects the field circuit as a console field.

type Primitive = Field<<E as Environment>::Network>

fn eject(&self) -> (Mode, Self::Primitive)

Ejects the mode and primitive value of the circuit type.

fn is_constant(&self) -> bool

Returns true if the circuit is a constant.

fn is_public(&self) -> bool

Returns true if the circuit is a public.

fn is_private(&self) -> bool

Returns true if the circuit is a private.

impl<E: Environment> Equal<Field<E>> for Field<E>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

This method costs 3 constraints.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

This method constructs a boolean that indicates if self and other are not equal to each other.

This method costs 3 constraints.

type Output = Boolean<E>

impl<E: Environment> From<&Field<E>> for LinearCombination<E::BaseField>

fn from(field: &Field<E>) -> Self

Converts to this type from the input type.

impl<E: Environment> From<&LinearCombination<<E as Environment>::BaseField>> for Field<E>

fn from(linear_combination: &LinearCombination<E::BaseField>) -> Self

Converts to this type from the input type.

impl<E: Environment> From<Field<E>> for LinearCombination<E::BaseField>

fn from(field: Field<E>) -> Self

Converts to this type from the input type.

impl<E: Environment> From<LinearCombination<<E as Environment>::BaseField>> for Field<E>

fn from(linear_combination: LinearCombination<E::BaseField>) -> Self

Converts to this type from the input type.

impl<E: Environment> FromBits for Field<E>

fn from_bits_le(bits_le: &[Self::Boolean]) -> Self

Initializes a new base field element from a list of little-endian bits.

• If bits_le is longer than E::BaseField::size_in_bits(), the excess bits are enforced to be 0s.
• If bits_le is shorter than E::BaseField::size_in_bits(), it is padded with 0s up to base field size.

fn from_bits_be(bits_be: &[Self::Boolean]) -> Self

Initializes a new base field element from a list of big-endian bits without leading zeros.

type Boolean = Boolean<E>

impl<E: Environment> FromBoolean for Field<E>

fn from_boolean(boolean: &Self::Boolean) -> Self

Initializes a base field from a boolean.

type Boolean = Boolean<E>

impl<E: Environment> FromStr for Field<E>

fn from_str(string: &str) -> Result<Self>

Parses a string into a field circuit.

type Err = Error

The associated error which can be returned from parsing.

impl<E: Environment> Inject for Field<E>

fn new(mode: Mode, field: Self::Primitive) -> Self

Initializes a field circuit from a console field.

type Primitive = Field<<E as Environment>::Network>

fn constant(value: Self::Primitive) -> Self

Initializes a constant of the given primitive value.

impl<E: Environment> Inv for &Field<E>

type Output = Field<E>

The result after applying the operator.

fn inv(self) -> Self::Output

Returns the multiplicative inverse of self.

impl<E: Environment> Inv for Field<E>

type Output = Field<E>

The result after applying the operator.

fn inv(self) -> Self::Output

Returns the multiplicative inverse of self.

impl<E: Environment> Inverse for Field<E>

type Output = Field<E>

fn inverse(&self) -> Self::Output

impl<E: Environment> Metrics<dyn Add<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (Mode, Mode)

fn count(_case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Div<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (Mode, Mode)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Double<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn count(_parameter: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Equal<Field<E>, Output = Boolean<E>> + 'static> for Field<E>

type Case = (Mode, Mode)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn FromBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = Vec<Mode, Global>

fn count(_modes: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn FromBoolean<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = ()

fn count(_case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Inverse<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Mul<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (Mode, Mode)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Neg<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn count(_case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn One<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = ()

fn count(_parameter: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Pow<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (CircuitType<Field<E>>, CircuitType<Field<E>>)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Square<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn SquareRoot<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Sub<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (Mode, Mode)

fn count(_case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Ternary<Output = Field<E>, Boolean = Boolean<E>> + 'static> for Field<E>

type Case = (Mode, Mode, Mode)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn ToBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = Mode

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn ToLowerBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = (Mode, u64)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn ToUpperBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = (Mode, u64)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Metrics<dyn Zero<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = ()

fn count(_parameter: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> Mul<&Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the * operator.

fn mul(self, other: &Field<E>) -> Self::Output

Performs the * operation.

impl<E: Environment> Mul<&Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the * operator.

fn mul(self, other: &Field<E>) -> Self::Output

Performs the * operation.

impl<E: Environment> Mul<Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<E: Environment> Mul<Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<E: Environment> MulAssign<&Field<E>> for Field<E>

fn mul_assign(&mut self, other: &Field<E>)

Performs the *= operation.

impl<E: Environment> MulAssign<Field<E>> for Field<E>

fn mul_assign(&mut self, other: Field<E>)

Performs the *= operation.

impl<E: Environment> Neg for &Field<E>

fn neg(self) -> Self::Output

Performs the unary - operation.

type Output = Field<E>

The resulting type after applying the - operator.

impl<E: Environment> Neg for Field<E>

fn neg(self) -> Self::Output

Performs the unary - operation.

type Output = Field<E>

The resulting type after applying the - operator.

impl<E: Environment> One for Field<E>

type Boolean = Boolean<E>

fn one() -> Self

Returns a new one constant.

fn is_one(&self) -> Self::Boolean

Returns true if self is one.

impl<E: Environment> OutputMode<dyn Add<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (CircuitType<Field<E>>, CircuitType<Field<E>>)

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Div<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (CircuitType<Field<E>>, CircuitType<Field<E>>)

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Double<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(input: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Equal<Field<E>, Output = Boolean<E>> + 'static> for Field<E>

type Case = (Mode, Mode)

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn FromBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = Vec<Mode, Global>

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn FromBoolean<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Inverse<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Mul<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (CircuitType<Field<E>>, CircuitType<Field<E>>)

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Neg<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn One<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = ()

fn output_mode(_input: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Pow<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (CircuitType<Field<E>>, CircuitType<Field<E>>)

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Square<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(input: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn SquareRoot<Output = Field<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Sub<Field<E>, Output = Field<E>> + 'static> for Field<E>

type Case = (CircuitType<Field<E>>, CircuitType<Field<E>>)

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Ternary<Output = Field<E>, Boolean = Boolean<E>> + 'static> for Field<E>

type Case = (CircuitType<Boolean<E>>, Mode, Mode)

fn output_mode(parameter: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn ToBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn ToLowerBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn ToUpperBits<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Zero<Boolean = Boolean<E>> + 'static> for Field<E>

type Case = ()

fn output_mode(_input: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> Parser for Field<E>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a field circuit.

impl<E: Environment> Pow<&Field<E>> for &Field<E>

type Output = Field<E>

The result after applying the operator.

fn pow(self, exponent: &Field<E>) -> Self::Output

Returns self to the power rhs.

impl<E: Environment> Pow<&Field<E>> for Field<E>

type Output = Field<E>

The result after applying the operator.

fn pow(self, exponent: &Field<E>) -> Self::Output

Returns self to the power rhs.

impl<E: Environment> Pow<Field<E>> for &Field<E>

type Output = Field<E>

The result after applying the operator.

fn pow(self, exponent: Field<E>) -> Self::Output

Returns self to the power rhs.

impl<E: Environment> Pow<Field<E>> for Field<E>

type Output = Field<E>

The result after applying the operator.

fn pow(self, exponent: Field<E>) -> Self::Output

Returns self to the power rhs.

impl<E: Environment> Square for Field<E>

type Output = Field<E>

fn square(&self) -> Self::Output

impl<E: Environment> SquareRoot for Field<E>

type Output = Field<E>

fn square_root(&self) -> Self::Output

impl<E: Environment> Sub<&Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the - operator.

fn sub(self, other: &Field<E>) -> Self::Output

Performs the - operation.

impl<E: Environment> Sub<&Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the - operator.

fn sub(self, other: &Field<E>) -> Self::Output

Performs the - operation.

impl<E: Environment> Sub<Field<E>> for &Field<E>

type Output = Field<E>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<E: Environment> Sub<Field<E>> for Field<E>

type Output = Field<E>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<E: Environment> SubAssign<&Field<E>> for Field<E>

fn sub_assign(&mut self, other: &Field<E>)

Performs the -= operation.

impl<E: Environment> SubAssign<Field<E>> for Field<E>

fn sub_assign(&mut self, other: Field<E>)

Performs the -= operation.

impl<E: Environment> Ternary for Field<E>

fn ternary(condition: &Self::Boolean, first: &Self, second: &Self) -> Self::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<E>

type Output = Field<E>

impl<E: Environment> ToBits for &Field<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Outputs the little-endian bit representation of self without trailing zeros.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Outputs the big-endian bit representation of self without leading zeros.

type Boolean = Boolean<E>

impl<E: Environment> ToBits for Field<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Outputs the little-endian bit representation of self without trailing zeros.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Outputs the big-endian bit representation of self without leading zeros.

type Boolean = Boolean<E>

impl<E: Environment> ToLowerBits for Field<E>

fn to_lower_bits_le(&self, k: usize) -> Vec<Self::Boolean>

Outputs the lower k bits of an n-bit field element in little-endian representation. Enforces that the upper n - k bits are zero.

fn to_lower_bits_be(&self, k: usize) -> Vec<Self::Boolean>

Outputs the lower k bits of an n-bit field element in big-endian representation. Enforces that the upper n - k bits are zero.

type Boolean = Boolean<E>

impl<E: Environment> ToUpperBits for Field<E>

fn to_upper_bits_le(&self, k: usize) -> Vec<Self::Boolean>

Outputs the upper k bits of an n-bit field element in little-endian representation. Enforces that the lower n - k bits are zero.

fn to_upper_bits_be(&self, k: usize) -> Vec<Self::Boolean>

Outputs the upper k bits of an n-bit field element in big-endian representation. Enforces that the lower n - k bits are zero.

type Boolean = Boolean<E>

impl<E: Environment> TypeName for Field<E>

fn type_name() -> &'static str

Returns the type name of the circuit as a string.

impl<E: Environment> Zero for Field<E>

type Boolean = Boolean<E>

fn zero() -> Self

Returns a new zero constant.

fn is_zero(&self) -> Self::Boolean

Returns true if self is zero.

impl<E: Environment> FieldTrait for Field<E>