Struct snarkvm_wasm::Fp384

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

Implementations

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

pub fn new(element: BigInteger384) -> Fp384<P>

pub fn is_valid(&self) -> bool

Trait Implementations

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

type Output = Fp384<P>

The resulting type after applying the + operator.

pub fn add(self, other: &&Fp384<P>) -> Fp384<P>

Performs the + operation.

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

type Output = Fp384<P>

The resulting type after applying the + operator.

pub fn add(self, other: &Fp384<P>) -> Fp384<P>

Performs the + operation.

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

type Output = Fp384<P>

The resulting type after applying the + operator.

pub fn add(self, other: &'a mut Fp384<P>) -> Fp384<P>

Performs the + operation.

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

type Output = Fp384<P>

The resulting type after applying the + operator.

pub fn add(self, other: Fp384<P>) -> Fp384<P>

Performs the + operation.

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

pub fn add_assign(&mut self, other: &&Fp384<P>)

Performs the += operation.

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

pub fn add_assign(&mut self, other: &Fp384<P>)

Performs the += operation.

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

pub fn add_assign(&mut self, other: &'a mut Fp384<P>)

Performs the += operation.

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

pub fn add_assign(&mut self, other: Fp384<P>)

Performs the += operation.

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

pub fn deserialize<R>(reader: &mut R) -> Result<Fp384<P>, SerializationError> where
    R: Read, 

Reads Self from reader.

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

Reads Self from reader without compression.

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

pub fn deserialize_with_flags<R, F>(
    reader: &mut R
) -> Result<(Fp384<P>, F), SerializationError> where
    R: Read,
    F: Flags, 

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

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

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

Serializes self into writer.

pub fn serialized_size(&self) -> usize

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

Serializes self into writer without compression.

fn uncompressed_size(&self) -> usize

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

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

Serializes self and flags into writer.

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

pub fn clone(&self) -> Fp384<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

pub const SERIALIZED_SIZE: usize

pub const UNCOMPRESSED_SIZE: usize

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

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

Formats the value using the given formatter.

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

pub fn default() -> Fp384<P>

Returns the “default value” for a type.

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

pub fn deserialize<D>(
    deserializer: D
) -> Result<Fp384<P>, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

Formats the value using the given formatter.

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

type Output = Fp384<P>

The resulting type after applying the / operator.

pub fn div(self, other: &&Fp384<P>) -> Fp384<P>

Performs the / operation.

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

type Output = Fp384<P>

The resulting type after applying the / operator.

pub fn div(self, other: &Fp384<P>) -> Fp384<P>

Performs the / operation.

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

type Output = Fp384<P>

The resulting type after applying the / operator.

pub fn div(self, other: &'a mut Fp384<P>) -> Fp384<P>

Performs the / operation.

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

type Output = Fp384<P>

The resulting type after applying the / operator.

pub fn div(self, other: Fp384<P>) -> Fp384<P>

Performs the / operation.

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

pub fn div_assign(&mut self, other: &&Fp384<P>)

Performs the /= operation.

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

pub fn div_assign(&mut self, other: &Fp384<P>)

Performs the /= operation.

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

pub fn div_assign(&mut self, other: &'a mut Fp384<P>)

Performs the /= operation.

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

pub fn div_assign(&mut self, other: Fp384<P>)

Performs the /= operation.

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

type FftParameters = P

pub fn two_adic_root_of_unity() -> Fp384<P>

Returns the 2^s root of unity.

pub fn large_subgroup_root_of_unity() -> Option<Fp384<P>>

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

pub fn multiplicative_generator() -> Fp384<P>

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> Field for Fp384<P> where
    P: Fp384Parameters, 

pub fn from_random_bytes_with_flags<F>(bytes: &[u8]) -> Option<(Fp384<P>, F)> where
    F: Flags, 

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.

pub fn double(&self) -> Fp384<P>

Returns self + self.

pub fn double_in_place(&mut self)

Doubles self in place.

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

Returns the characteristic of the field.

pub fn square(&self) -> Fp384<P>

Returns self * self.

pub fn square_in_place(&mut self) -> &mut Fp384<P>

Squares self in place.

pub fn inverse(&self) -> Option<Fp384<P>>

Computes the multiplicative inverse of self if self is nonzero.

pub fn inverse_in_place(&mut self) -> Option<&mut Fp384<P>>

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

pub fn frobenius_map(&mut self, usize)

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

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

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> From<u128> for Fp384<P> where
    P: Fp384Parameters, 

pub fn from(other: u128) -> Fp384<P>

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> From<u16> for Fp384<P> where
    P: Fp384Parameters, 

pub fn from(other: u16) -> Fp384<P>

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> From<u32> for Fp384<P> where
    P: Fp384Parameters, 

pub fn from(other: u32) -> Fp384<P>

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> From<u64> for Fp384<P> where
    P: Fp384Parameters, 

pub fn from(other: u64) -> Fp384<P>

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> From<u8> for Fp384<P> where
    P: Fp384Parameters, 

pub fn from(other: u8) -> Fp384<P>

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> FromBytes for Fp384<P> where
    P: Fp384Parameters, 

pub fn read_le<R>(reader: R) -> Result<Fp384<P>, Error> where
    R: Read, 

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> FromStr for Fp384<P> where
    P: Fp384Parameters, 

pub fn from_str(s: &str) -> Result<Fp384<P>, <Fp384<P> as FromStr>::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> Hash for Fp384<P> where
    P: Fp384Parameters, 

pub 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> Into<BigInteger384> for Fp384<P> where
    P: Fp384Parameters, 

pub fn into(self) -> BigInteger384

Performs the conversion.

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

type Output = Fp384<P>

The resulting type after applying the * operator.

pub fn mul(self, other: &&Fp384<P>) -> Fp384<P>

Performs the * operation.

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

type Output = Fp384<P>

The resulting type after applying the * operator.

pub fn mul(self, other: &Fp384<P>) -> Fp384<P>

Performs the * operation.

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

type Output = Fp384<P>

The resulting type after applying the * operator.

pub fn mul(self, other: &'a mut Fp384<P>) -> Fp384<P>

Performs the * operation.

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

type Output = Fp384<P>

The resulting type after applying the * operator.

pub fn mul(self, other: Fp384<P>) -> Fp384<P>

Performs the * operation.

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

pub fn mul_assign(&mut self, other: &&Fp384<P>)

Performs the *= operation.

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

pub fn mul_assign(&mut self, other: &Fp384<P>)

Performs the *= operation.

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

pub fn mul_assign(&mut self, other: &'a mut Fp384<P>)

Performs the *= operation.

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

pub fn mul_assign(&mut self, other: Fp384<P>)

Performs the *= operation.

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

type Output = Fp384<P>

The resulting type after applying the - operator.

pub fn neg(self) -> Fp384<P>

Performs the unary - operation.

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

pub fn one() -> Fp384<P>

pub fn is_one(&self) -> bool

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

pub fn cmp(&self, other: &Fp384<P>) -> 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

Restrict a value to a certain interval.

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

pub fn eq(&self, other: &Fp384<P>) -> 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 !=.

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

pub fn partial_cmp(&self, other: &Fp384<P>) -> 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> PoseidonMDSField for Fp384<P> where
    P: Fp384Parameters + PoseidonMDSParameters, 

pub fn poseidon_mds_matrix() -> Vec<Vec<Fp384<P>, Global>, Global>

Returns the Poseidon parameters

pub fn poseidon_alpha() -> u64

Returns the Poseidon alpha value

pub fn poseidon_number_full_rounds() -> u32

Returns the Poseidon number of full rounds

pub fn poseidon_number_partial_rounds() -> u32

Returns the Poseidon number of partial rounds

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

type BigInteger = BigInteger384

type Parameters = P

pub fn from_repr(r: BigInteger384) -> Option<Fp384<P>>

Returns a prime field element from its underlying representation.

pub fn to_repr(&self) -> BigInteger384

Returns the underlying representation of the prime field element.

pub fn from_repr_unchecked(r: BigInteger384) -> Fp384<P>

Returns a prime field element from its underlying raw representation.

pub fn to_repr_unchecked(&self) -> BigInteger384

Returns the underlying raw representation of the prime field element.

fn size_in_bits() -> usize

Returns the field size in bits.

fn trace() -> Self::BigInteger

Returns the trace.

fn trace_minus_one_div_two() -> Self::BigInteger

Returns the trace minus one divided by two.

fn modulus_minus_one_div_two() -> Self::BigInteger

Returns the modulus minus one divided by two.

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

pub fn product<I>(iter: I) -> Fp384<P> where
    I: Iterator<Item = &'a Fp384<P>>, 

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

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

pub fn product<I>(iter: I) -> Fp384<P> where
    I: Iterator<Item = Fp384<P>>, 

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

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

pub fn serialize<S>(
    &self,
    s: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

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

pub fn legendre(&self) -> LegendreSymbol

Returns the Legendre symbol.

pub fn sqrt(&self) -> Option<Fp384<P>>

Returns the square root of self, if it exists.

pub fn sqrt_in_place(&mut self) -> Option<&mut Fp384<P>>

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

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

type Output = Fp384<P>

The resulting type after applying the - operator.

pub fn sub(self, other: &&Fp384<P>) -> Fp384<P>

Performs the - operation.

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

type Output = Fp384<P>

The resulting type after applying the - operator.

pub fn sub(self, other: &Fp384<P>) -> Fp384<P>

Performs the - operation.

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

type Output = Fp384<P>

The resulting type after applying the - operator.

pub fn sub(self, other: &'a mut Fp384<P>) -> Fp384<P>

Performs the - operation.

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

type Output = Fp384<P>

The resulting type after applying the - operator.

pub fn sub(self, other: Fp384<P>) -> Fp384<P>

Performs the - operation.

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

pub fn sub_assign(&mut self, other: &&Fp384<P>)

Performs the -= operation.

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

pub fn sub_assign(&mut self, other: &Fp384<P>)

Performs the -= operation.

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

pub fn sub_assign(&mut self, other: &'a mut Fp384<P>)

Performs the -= operation.

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

pub fn sub_assign(&mut self, other: Fp384<P>)

Performs the -= operation.

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

pub fn sum<I>(iter: I) -> Fp384<P> where
    I: Iterator<Item = &'a Fp384<P>>, 

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

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

pub fn sum<I>(iter: I) -> Fp384<P> where
    I: Iterator<Item = Fp384<P>>, 

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

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

pub fn write_le<W>(&self, writer: W) -> Result<(), Error> where
    W: Write, 

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> Zero for Fp384<P> where
    P: Fp384Parameters, 

pub fn zero() -> Fp384<P>

pub fn is_zero(&self) -> bool

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

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