Trait snarkvm_fields::traits::Field

source · 
pub trait Field: 'static + ToBits + ToBytes + FromBytes + Copy + Clone + Debug + Display + Default + Send + Sync + Eq + One + Ord + Neg<Output = Self> + Uniform + Zero + Sized + Hash + From<u128> + From<u64> + From<u32> + From<u16> + From<u8> + Add<Self, Output = Self> + Sub<Self, Output = Self> + Mul<Self, Output = Self> + Div<Self, Output = Self> + AddAssign<Self> + SubAssign<Self> + MulAssign<Self> + DivAssign<Self> + for<'a> Add<&'a Self, Output = Self> + for<'a> Sub<&'a Self, Output = Self> + for<'a> Mul<&'a Self, Output = Self> + for<'a> Div<&'a Self, Output = Self> + for<'a> AddAssign<&'a Self> + for<'a> SubAssign<&'a Self> + for<'a> MulAssign<&'a Self> + for<'a> DivAssign<&'a Self> + Sum<Self> + for<'a> Sum<&'a Self> + Product<Self> + for<'a> Product<&'a Self> + CanonicalSerialize + CanonicalSerializeWithFlags + CanonicalDeserialize + CanonicalDeserializeWithFlags + Serialize + for<'a> Deserialize<'a> {
    type BasePrimeField: PrimeField;


Show 14 methods    // Required methods
    fn from_base_prime_field(other: Self::BasePrimeField) -> Self;
    fn characteristic<'a>() -> &'a [u64];
    fn double(&self) -> Self;
    fn double_in_place(&mut self);
    fn square(&self) -> Self;
    fn square_in_place(&mut self) -> &mut Self;
    fn inverse(&self) -> Option<Self>;
    fn inverse_in_place(&mut self) -> Option<&mut Self>;
    fn frobenius_map(&mut self, power: usize);
    fn from_random_bytes_with_flags<F: Flags>(bytes: &[u8]) -> Option<(Self, F)>;

    // Provided methods
    fn half() -> Self { ... }
    fn sum_of_products<'a>(
        a: impl Iterator<Item = &'a Self> + Clone,
        b: impl Iterator<Item = &'a Self> + Clone
    ) -> Self { ... }
    fn pow<S: AsRef<[u64]>>(&self, exp: S) -> Self { ... }
    fn from_random_bytes(bytes: &[u8]) -> Option<Self> { ... }

}
Expand description

The interface for a generic field.

Required Associated Types§

source

type BasePrimeField: PrimeField

Required Methods§

source

fn from_base_prime_field(other: Self::BasePrimeField) -> Self

Constructs an element of Self from an element of the base prime field.

source

fn characteristic<'a>() -> &'a [u64]

Returns the characteristic of the field.

source

fn double(&self) -> Self

Returns self + self.

source

fn double_in_place(&mut self)

Doubles self in place.

source

fn square(&self) -> Self

Returns self * self.

source

fn square_in_place(&mut self) -> &mut Self

Squares self in place.

source

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

Computes the multiplicative inverse of self if self is nonzero.

source

fn inverse_in_place(&mut self) -> Option<&mut Self>

Sets self to self’s inverse if it exists. Otherwise it is a no-op.

source

fn frobenius_map(&mut self, power: usize)

Exponentiates this element by a power of the base prime modulus via the Frobenius automorphism.

source

fn from_random_bytes_with_flags<F: Flags>(bytes: &[u8]) -> Option<(Self, F)>

Returns a field element with an extra sign bit used for group parsing if the set of bytes forms a valid field element, otherwise returns None. This function is primarily intended for sampling random field elements from a hash-function or RNG output.

Provided Methods§

source

fn half() -> Self

Returns the constant 2^{-1}.

source

fn sum_of_products<'a>( a: impl Iterator<Item = &'a Self> + Clone, b: impl Iterator<Item = &'a Self> + Clone ) -> Self

source

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

Exponentiates this element by a number represented with u64 limbs, least significant limb first.

source

fn from_random_bytes(bytes: &[u8]) -> Option<Self>

Returns a field element if the set of bytes forms a valid field element, otherwise returns None. This function is primarily intended for sampling random field elements from a hash-function or RNG output.

Object Safety§

This trait is not object safe.

Implementors§