Struct Field

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

Implementations

impl<E: Environment> Field<E>

pub fn even_square_root(&self) -> Result<Self>

Returns the square_root of self, where the least significant bit of the square root is zero.

impl<E: Environment> Field<E>

pub const SIZE_IN_BITS: usize = <E::Field>::SIZE_IN_BITS

The field size in bits.

pub const SIZE_IN_BYTES: usize = _

The field size in bytes.

pub const SIZE_IN_DATA_BITS: usize = <E::Field>::SIZE_IN_DATA_BITS

The field capacity for data bits.

pub const fn new(field: E::Field) -> Self

Initializes a new field.

pub fn new_domain_separator(domain: &str) -> Self

Initializes a new field as a domain separator.

pub fn from_u8(value: u8) -> Self

Initializes a new field from a u8.

pub fn from_u16(value: u16) -> Self

Initializes a new field from a u16.

pub fn from_u32(value: u32) -> Self

Initializes a new field from a u32.

pub fn from_u64(value: u64) -> Self

Initializes a new field from a u64.

pub fn from_u128(value: u128) -> Self

Initializes a new field from a u128.

pub fn half() -> Self

Returns 1 * 2^{-1}.

Trait Implementations

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

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

Returns the sum of self and other.

type Output = Field<E>

The resulting type after applying the + operator.

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

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

Returns the sum of self and other.

type Output = Field<E>

The resulting type after applying the + operator.

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

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

Adds other to self.

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

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

Adds other to self.

impl<E: Clone + Environment> Clone for Field<E>

where E::Field: 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 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> Default for Field<E>

fn default() -> Self

Returns the default field element.

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

type Target = <E as Environment>::Field

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, E: Environment> Deserialize<'de> for Field<E>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes the field from a string or bytes.

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

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

Formats the value using the given formatter.

impl<E: Environment> Distribution<Field<E>> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Field<E>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

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

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

Returns the quotient of self and other.

type Output = Field<E>

The resulting type after applying the / operator.

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

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

Returns the quotient of self and other.

type Output = Field<E>

The resulting type after applying the / operator.

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

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

Divides self by other.

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

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

Divides self by other.

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

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

Returns the double of self.

type Output = Field<E>

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

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

Returns true if self and other are equal.

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

Returns true if self and other are not equal.

type Output = Boolean<E>

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

fn from_bits_le(bits_le: &[bool]) -> Result<Self>

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

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

fn from_bits_be(bits_be: &[bool]) -> Result<Self>

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

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

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the field from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

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

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

Parses a string into a field.

type Err = Error

The associated error which can be returned from parsing.

impl<E: Hash + Environment> Hash for Field<E>

where E::Field: Hash,

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

Returns the inverse of self.

type Output = Field<E>

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

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

Returns the product of self and other.

type Output = Field<E>

The resulting type after applying the * operator.

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

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

Returns the product of self and other.

type Output = Field<E>

The resulting type after applying the * operator.

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

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

Multiplies self by other.

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

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

Multiplies self by other.

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

fn neg(self) -> Self::Output

Returns the negation of self.

type Output = Field<E>

The resulting type after applying the - operator.

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

fn one() -> Self

Returns the 1 element of the field.

fn is_one(&self) -> bool

Returns true if the element is one.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

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

fn cmp(&self, other: &Self) -> Ordering

Returns the lexicographic ordering of self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Parses a string into a field circuit.

impl<E: PartialEq + Environment> PartialEq for Field<E>

where E::Field: PartialEq,

fn eq(&self, other: &Field<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Returns the lexicographic ordering of self and other.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

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

Returns the power of self to the power of other.

type Output = Field<E>

The result after applying the operator.

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

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

Returns the power of self to the power of other.

type Output = Field<E>

The result after applying the operator.

impl<'a, E: Environment> Product<&'a Field<E>> for Field<E>

fn product<I: Iterator<Item = &'a Field<E>>>(iter: I) -> Self

Returns the product of self and other.

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

fn product<I: Iterator<Item = Field<E>>>(iter: I) -> Self

Returns the product of self and other.

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes the field into a string or as bytes.

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

fn size_in_bits() -> usize

Returns the field size in bits.

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

fn size_in_bytes() -> usize

Returns the field size in bytes.

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

fn size_in_data_bits() -> usize

Returns the field capacity for data bits.

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

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

Returns the square of self.

type Output = Field<E>

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

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

Returns the square_root of self. If there are two square roots, the bitwise lesser one is returned.

type Output = Field<E>

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

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

Returns the difference of self and other.

type Output = Field<E>

The resulting type after applying the - operator.

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

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

Returns the difference of self and other.

type Output = Field<E>

The resulting type after applying the - operator.

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

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

Subtracts other from self.

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

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

Subtracts other from self.

impl<'a, E: Environment> Sum<&'a Field<E>> for Field<E>

fn sum<I: Iterator<Item = &'a Field<E>>>(iter: I) -> Self

Returns the sum of self and other.

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

fn sum<I: Iterator<Item = Field<E>>>(iter: I) -> Self

Returns the sum of self and other.

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 write_bits_le(&self, vec: &mut Vec<bool>)

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

fn write_bits_be(&self, vec: &mut Vec<bool>)

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

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

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

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the field to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

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

fn type_name() -> &'static str

Returns the type name as a string.

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

fn zero() -> Self

Returns the 0 element of the field.

fn is_zero(&self) -> bool

Returns true if the element is zero.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

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

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<E: Copy + Environment> Copy for Field<E>

where E::Field: Copy,

impl<E: Eq + Environment> Eq for Field<E>

where E::Field: Eq,

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

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