Struct snarkvm_fields::Fp384

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

Implementations

impl<P: Fp384Parameters> Fp384<P>

pub fn new(element: BigInteger) -> Self

pub fn is_valid(&self) -> bool

Trait Implementations

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

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &Self) -> 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<P: Fp384Parameters> CanonicalDeserialize for Fp384<P>

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

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: Fp384Parameters> CanonicalDeserializeWithFlags for Fp384<P>

fn deserialize_with_flags<R: Read, F: Flags>(
    reader: &mut 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<W: Write>(&self, writer: &mut W) -> Result<(), SerializationError>

Serializes self into writer.

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: Fp384Parameters> CanonicalSerializeWithFlags for Fp384<P>

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

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> ConstantSerializedSize for Fp384<P>

const SERIALIZED_SIZE: usize

const UNCOMPRESSED_SIZE: usize

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: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

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<'a, P: Fp384Parameters> Div<&'a Fp384<P>> for Fp384<P>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: &Self) -> 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<P: Fp384Parameters> Field for Fp384<P>

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

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 double(&self) -> Self

Returns self + self.

fn double_in_place(&mut self) -> &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>

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<R: Read>(reader: R) -> IoResult<Self>

Reads Self from reader.

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

Performs the conversion.

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

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: &Self) -> 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<P: Fp384Parameters> Neg for Fp384<P>

type Output = Self

The resulting type after applying the - operator.

#[must_use]

fn neg(self) -> Self

Performs the unary - operation.

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

fn one() -> Self

fn is_one(&self) -> bool

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

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> 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 ==.

#[must_use]

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

This method tests for !=.

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.

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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> PrimeField for Fp384<P>

type BigInteger = BigInteger

type Parameters = P

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

Returns a prime field element from its underlying representation.

fn into_repr(&self) -> BigInteger

Returns the underlying representation of the prime field element.

fn from_repr_raw(r: BigInteger) -> Self

Returns a prime field element from its underlying raw representation.

fn into_repr_raw(&self) -> BigInteger

Returns the underlying raw representation of the prime field element.

fn multiplicative_generator() -> Self

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

fn root_of_unity() -> Self

Returns the 2^s root of unity.

fn qnr_to_t() -> Self

Return the a QNR^T

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<P: Fp384Parameters> Serialize for Fp384<P>

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

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<'a, P: Fp384Parameters> Sub<&'a Fp384<P>> for Fp384<P>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: &Self) -> 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<P: Fp384Parameters> ToBytes for Fp384<P>

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

Serializes self into writer.

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,