Struct snarkvm_fields::Fp384

pub struct Fp384<P: Fp384Parameters>(pub BigInteger, _);

Tuple Fields

0: BigInteger

Implementations

impl<P: Fp384Parameters> Fp384<P>

pub fn new(element: BigInteger) -> Self

pub fn is_valid(&self) -> bool

Trait Implementations

impl<P: Fp384Parameters> Add<&&Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P: Fp384Parameters> Add<&'a Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P: Fp384Parameters> Add<&'a mut Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the + operator.

fn add(self, other: &'a mut Self) -> Self

Performs the + operation.

impl<P: Fp384Parameters> Add<Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P: Fp384Parameters> AddAssign<&&Fp384<P>> for Fp384<P>

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

Performs the += operation.

impl<'a, P: Fp384Parameters> AddAssign<&'a Fp384<P>> for Fp384<P>

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

Performs the += operation.

impl<'a, P: Fp384Parameters> AddAssign<&'a mut Fp384<P>> for Fp384<P>

fn add_assign(&mut self, other: &'a mut Self)

Performs the += operation.

impl<P: Fp384Parameters> AddAssign<Fp384<P>> for Fp384<P>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<P: Fp384Parameters> CanonicalDeserialize for Fp384<P>

fn deserialize_with_mode<R: Read>(
    reader: R,
    _compress: Compress,
    _validate: Validate
) -> Result<Self, SerializationError>

fn deserialize_compressed<R>(reader: R) -> Result<Self, SerializationError> where
    R: Read, 

fn deserialize_compressed_unchecked<R>(
    reader: R
) -> Result<Self, SerializationError> where
    R: Read, 

fn deserialize_uncompressed<R>(reader: R) -> Result<Self, SerializationError> where
    R: Read, 

fn deserialize_uncompressed_unchecked<R>(
    reader: R
) -> Result<Self, SerializationError> where
    R: Read, 

impl<P: Fp384Parameters> CanonicalDeserializeWithFlags for Fp384<P>

fn deserialize_with_flags<R: Read, F: Flags>(
    reader: R
) -> Result<(Self, F), SerializationError>

Reads Self and Flags from reader. Returns empty flags by default.

impl<P: Fp384Parameters> CanonicalSerialize for Fp384<P>

fn serialize_with_mode<W: Write>(
    &self,
    writer: W,
    _compress: Compress
) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

fn serialize_compressed<W>(&self, writer: W) -> Result<(), SerializationError> where
    W: Write, 

fn compressed_size(&self) -> usize

fn serialize_uncompressed<W>(&self, writer: W) -> Result<(), SerializationError> where
    W: Write, 

fn uncompressed_size(&self) -> usize

impl<P: Fp384Parameters> CanonicalSerializeWithFlags for Fp384<P>

fn serialize_with_flags<W: Write, F: Flags>(
    &self,
    writer: W,
    flags: F
) -> Result<(), SerializationError>

Serializes self and flags into writer.

fn serialized_size_with_flags<F: Flags>(&self) -> usize

Serializes self and flags into writer.

impl<P: Fp384Parameters> Clone for Fp384<P> where
    P: Fp384Parameters, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Fp384Parameters> Debug for Fp384<P>

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

Formats the value using the given formatter.

impl<P: Fp384Parameters> Default for Fp384<P> where
    P: Fp384Parameters, 

fn default() -> Self

Returns the “default value” for a type.

impl<'de, P: Fp384Parameters> Deserialize<'de> for Fp384<P>

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

Deserialize this value from the given Serde deserializer.

impl<P: Fp384Parameters> Display for Fp384<P>

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

Formats the value using the given formatter.

impl<P: Fp384Parameters> Distribution<Fp384<P>> for Standard

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

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, 

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, 

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

impl<P: Fp384Parameters> Div<&&Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the / operator.

fn div(self, other: &&Self) -> Self

Performs the / operation.

impl<'a, P: Fp384Parameters> Div<&'a Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the / operator.

fn div(self, other: &Self) -> Self

Performs the / operation.

impl<'a, P: Fp384Parameters> Div<&'a mut Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the / operator.

fn div(self, other: &'a mut Self) -> Self

Performs the / operation.

impl<P: Fp384Parameters> Div<Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<P: Fp384Parameters> DivAssign<&&Fp384<P>> for Fp384<P>

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

Performs the /= operation.

impl<'a, P: Fp384Parameters> DivAssign<&'a Fp384<P>> for Fp384<P>

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

Performs the /= operation.

impl<'a, P: Fp384Parameters> DivAssign<&'a mut Fp384<P>> for Fp384<P>

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

Performs the /= operation.

impl<P: Fp384Parameters> DivAssign<Fp384<P>> for Fp384<P>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<P: Fp384Parameters> FftField for Fp384<P>

type FftParameters = P

fn two_adic_root_of_unity() -> Self

Returns the 2^s root of unity.

fn large_subgroup_root_of_unity() -> Option<Self>

Returns the 2^s * small_subgroup_base^small_subgroup_base_adicity root of unity if a small subgroup is defined.

fn multiplicative_generator() -> Self

Returns the multiplicative generator of char() - 1 order.

fn get_root_of_unity(n: usize) -> Option<Self>

Returns the root of unity of order n, if one exists. If no small multiplicative subgroup is defined, this is the 2-adic root of unity of order n (for n a power of 2). If a small multiplicative subgroup is defined, this is the root of unity of order n for the larger subgroup generated by FftParams::LARGE_SUBGROUP_ROOT_OF_UNITY (for n = 2^i * FftParams::SMALL_SUBGROUP_BASE^j for some i, j).

fn k_adicity(k: usize, n: usize) -> u32

Calculates the k-adicity of n, i.e., the number of trailing 0s in a base-k representation.

impl<P: Fp384Parameters> Field for Fp384<P>

type BasePrimeField = Fp384<P>

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.

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

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

fn half() -> Self

Returns the constant 2^{-1}.

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

fn double(&self) -> Self

Returns self + self.

fn double_in_place(&mut self)

Doubles self in place.

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

Returns the characteristic of the field.

fn square(&self) -> Self

Returns self * self.

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

Squares self in place.

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

Computes the multiplicative inverse of self if self is nonzero.

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

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

fn frobenius_map(&mut self, _: usize)

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

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

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

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.

impl<P: Fp384Parameters> From<u128> for Fp384<P>

fn from(other: u128) -> Self

Attempts to convert an integer into a field element. Panics if the provided integer is invalid (e.g. larger than the field modulus).

impl<P: Fp384Parameters> From<u16> for Fp384<P>

fn from(other: u16) -> Self

Attempts to convert an integer into a field element. Panics if the provided integer is invalid (e.g. larger than the field modulus).

impl<P: Fp384Parameters> From<u32> for Fp384<P>

fn from(other: u32) -> Self

Attempts to convert an integer into a field element. Panics if the provided integer is invalid (e.g. larger than the field modulus).

impl<P: Fp384Parameters> From<u64> for Fp384<P>

fn from(other: u64) -> Self

Attempts to convert an integer into a field element. Panics if the provided integer is invalid (e.g. larger than the field modulus).

impl<P: Fp384Parameters> From<u8> for Fp384<P>

fn from(other: u8) -> Self

Attempts to convert an integer into a field element. Panics if the provided integer is invalid (e.g. larger than the field modulus).

impl<P: Fp384Parameters> FromBytes for Fp384<P>

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

Reads Self from reader as little-endian bytes.

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

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

impl<P: Fp384Parameters> FromStr for Fp384<P>

fn from_str(s: &str) -> Result<Self, Self::Err>

Interpret a string of numbers as a (congruent) prime field element. Does not accept unnecessary leading zeroes or a blank string.

type Err = FieldError

The associated error which can be returned from parsing.

impl<P: Fp384Parameters> Hash for Fp384<P> where
    P: Fp384Parameters, 

fn hash<__HP>(&self, __state: &mut __HP) where
    __HP: Hasher, 

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<P: Fp384Parameters> Into<BigInteger384> for Fp384<P>

fn into(self) -> BigInteger384

Converts this type into the (usually inferred) input type.

impl<P: Fp384Parameters> Mul<&&Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P: Fp384Parameters> Mul<&'a Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P: Fp384Parameters> Mul<&'a mut Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the * operator.

fn mul(self, other: &'a mut Self) -> Self

Performs the * operation.

impl<P: Fp384Parameters> Mul<Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<P: Fp384Parameters> MulAssign<&&Fp384<P>> for Fp384<P>

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

Performs the *= operation.

impl<'a, P: Fp384Parameters> MulAssign<&'a Fp384<P>> for Fp384<P>

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

Performs the *= operation.

impl<'a, P: Fp384Parameters> MulAssign<&'a mut Fp384<P>> for Fp384<P>

fn mul_assign(&mut self, other: &'a mut Self)

Performs the *= operation.

impl<P: Fp384Parameters> MulAssign<Fp384<P>> for Fp384<P>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<P: Fp384Parameters> Neg for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<P: Fp384Parameters> One for Fp384<P>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

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

impl<P: Fp384Parameters> Ord for Fp384<P>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<P: Fp384Parameters> PartialEq<Fp384<P>> for Fp384<P> where
    P: Fp384Parameters, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<P: Fp384Parameters> PartialOrd<Fp384<P>> for Fp384<P>

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<P: Fp384Parameters + PoseidonDefaultParameters> PoseidonDefaultField for Fp384<P>

fn default_poseidon_parameters<const RATE: usize>(
) -> Result<PoseidonParameters<Self, RATE, 1>> where
    Self: PrimeField, 

Obtain the default Poseidon parameters for this rate and for this prime field, with a specific optimization goal.

impl<P: Fp384Parameters> PrimeField for Fp384<P>

type BigInteger = BigInteger384

type Parameters = P

fn from_repr(r: BigInteger) -> Option<Self>

Returns a prime field element from its underlying representation.

fn to_repr(&self) -> BigInteger

Returns the underlying representation of the prime field element.

fn to_repr_unchecked(&self) -> BigInteger

Returns the underlying raw representation of the prime field element.

const SIZE_IN_BITS: usize = _

Returns the field size in bits.

const SIZE_IN_DATA_BITS: usize = _

Returns the field capacity for data bits.

fn size_in_bits() -> usize

Returns the field size in bits.

fn size_in_data_bits() -> usize

Returns the capacity size for data bits.

fn modulus() -> Self::BigInteger

Returns the modulus.

fn modulus_minus_one_div_two() -> Self::BigInteger

Returns the modulus minus one divided by two.

fn trace() -> Self::BigInteger

Returns the trace.

fn trace_minus_one_div_two() -> Self::BigInteger

Returns the trace minus one divided by two.

fn from_bytes_be_mod_order(bytes: &[u8]) -> Self

Reads bytes in big-endian, and converts them to a field element. If the bytes are larger than the modulus, it will reduce them.

fn from_bytes_le_mod_order(bytes: &[u8]) -> Self

Reads bytes in little-endian, and converts them to a field element. If the bytes are larger than the modulus, it will reduce them.

impl<'a, P: Fp384Parameters> Product<&'a Fp384<P>> for Fp384<P>

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

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<P: Fp384Parameters> Product<Fp384<P>> for Fp384<P>

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

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<P: Fp384Parameters> Serialize for Fp384<P>

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

Serialize this value into the given Serde serializer.

impl<P: Fp384Parameters> SquareRootField for Fp384<P>

fn legendre(&self) -> LegendreSymbol

Returns the Legendre symbol.

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

Returns the square root of self, if it exists.

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

Sets self to be the square root of self, if it exists.

impl<P: Fp384Parameters> Sub<&&Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P: Fp384Parameters> Sub<&'a Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P: Fp384Parameters> Sub<&'a mut Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the - operator.

fn sub(self, other: &'a mut Self) -> Self

Performs the - operation.

impl<P: Fp384Parameters> Sub<Fp384<P>> for Fp384<P>

type Output = Fp384<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P: Fp384Parameters> SubAssign<&&Fp384<P>> for Fp384<P>

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

Performs the -= operation.

impl<'a, P: Fp384Parameters> SubAssign<&'a Fp384<P>> for Fp384<P>

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

Performs the -= operation.

impl<'a, P: Fp384Parameters> SubAssign<&'a mut Fp384<P>> for Fp384<P>

fn sub_assign(&mut self, other: &'a mut Self)

Performs the -= operation.

impl<P: Fp384Parameters> SubAssign<Fp384<P>> for Fp384<P>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a, P: Fp384Parameters> Sum<&'a Fp384<P>> for Fp384<P>

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<P: Fp384Parameters> Sum<Fp384<P>> for Fp384<P>

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<P: Fp384Parameters> ToBits for Fp384<P>

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.

impl<P: Fp384Parameters> ToBytes for Fp384<P>

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

Writes self into writer as little-endian bytes.

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

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

impl<P: Fp384Parameters> Valid for Fp384<P>

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>(
    _batch: impl Iterator<Item = &'a Self> + Send
) -> Result<(), SerializationError> where
    Self: 'a, 

impl<P: Fp384Parameters> Zero for Fp384<P>

fn zero() -> Self

fn is_zero(&self) -> bool

impl<P: Fp384Parameters> Copy for Fp384<P> where
    P: Fp384Parameters, 

impl<P: Fp384Parameters> Eq for Fp384<P> where
    P: Fp384Parameters,