Struct snarkvm_wasm::Fp256

pub struct Fp256<P>(pub BigInteger256, _);

Implementations

impl<P> Fp256<P> where
    P: Fp256Parameters, 

pub fn new(element: BigInteger256) -> Fp256<P>

Trait Implementations

impl<'a, P> Add<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

type Output = Fp256<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P> AddAssign<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

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

Performs the += operation.

impl<P> CanonicalDeserialize for Fp256<P> where
    P: Fp256Parameters, 

pub fn deserialize<R>(reader: &mut R) -> Result<Fp256<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 Fp256<P> where
    P: Fp256Parameters, 

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

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

impl<P> CanonicalSerialize for Fp256<P> where
    P: Fp256Parameters, 

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 Fp256<P> where
    P: Fp256Parameters, 

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 Fp256<P>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> ConstantSerializedSize for Fp256<P> where
    P: Fp256Parameters, 

pub const SERIALIZED_SIZE: usize

pub const UNCOMPRESSED_SIZE: usize

impl<P> Debug for Fp256<P> where
    P: Fp256Parameters, 

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

Formats the value using the given formatter.

impl<P> Default for Fp256<P>

pub fn default() -> Fp256<P>

Returns the “default value” for a type.

impl<'de, P> Deserialize<'de> for Fp256<P> where
    P: Fp256Parameters, 

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

Deserialize this value from the given Serde deserializer.

impl<P> Display for Fp256<P> where
    P: Fp256Parameters, 

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

Formats the value using the given formatter.

impl<'a, P> Div<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

type Output = Fp256<P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, P> DivAssign<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

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

Performs the /= operation.

impl<P> Field for Fp256<P> where
    P: Fp256Parameters, 

pub fn from_random_bytes_with_flags(bytes: &[u8]) -> Option<(Fp256<P>, 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.

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

Returns self + self.

pub fn double_in_place(&mut self) -> &mut Fp256<P>

Doubles self in place.

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

Returns the characteristic of the field.

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

Returns self * self.

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

Squares self in place.

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

Computes the multiplicative inverse of self if self is nonzero.

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

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 Fp256<P> where
    P: Fp256Parameters, 

pub fn from(other: u128) -> Fp256<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 Fp256<P> where
    P: Fp256Parameters, 

pub fn from(other: u16) -> Fp256<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 Fp256<P> where
    P: Fp256Parameters, 

pub fn from(other: u32) -> Fp256<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 Fp256<P> where
    P: Fp256Parameters, 

pub fn from(other: u64) -> Fp256<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 Fp256<P> where
    P: Fp256Parameters, 

pub fn from(other: u8) -> Fp256<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 Fp256<P> where
    P: Fp256Parameters, 

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

Reads Self from reader.

impl<P> FromStr for Fp256<P> where
    P: Fp256Parameters, 

pub fn from_str(s: &str) -> Result<Fp256<P>, <Fp256<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 Fp256<P>

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<BigInteger256> for Fp256<P> where
    P: Fp256Parameters, 

pub fn into(self) -> BigInteger256

Performs the conversion.

impl<'a, P> Mul<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

type Output = Fp256<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P> MulAssign<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

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

Performs the *= operation.

impl<P> Neg for Fp256<P> where
    P: Fp256Parameters, 

type Output = Fp256<P>

The resulting type after applying the - operator.

#[must_use]

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

Performs the unary - operation.

impl<P> One for Fp256<P> where
    P: Fp256Parameters, 

pub fn one() -> Fp256<P>

pub fn is_one(&self) -> bool

impl<P> Ord for Fp256<P> where
    P: Fp256Parameters, 

Fp elements are ordered lexicographically.

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

pub fn eq(&self, other: &Fp256<P>) -> 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> PartialOrd<Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

pub fn partial_cmp(&self, other: &Fp256<P>) -> 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> PrimeField for Fp256<P> where
    P: Fp256Parameters, 

type BigInteger = BigInteger256

type Parameters = P

pub fn from_repr(r: BigInteger256) -> Option<Fp256<P>>

Returns a prime field element from its underlying representation.

pub fn into_repr(&self) -> BigInteger256

Returns the underlying representation of the prime field element.

pub fn from_repr_raw(r: BigInteger256) -> Fp256<P>

Returns a prime field element from its underlying raw representation.

pub fn into_repr_raw(&self) -> BigInteger256

Returns the underlying raw representation of the prime field element.

pub fn multiplicative_generator() -> Fp256<P>

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

pub fn root_of_unity() -> Fp256<P>

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> Serialize for Fp256<P> where
    P: Fp256Parameters, 

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 Fp256<P> where
    P: Fp256Parameters, 

pub fn legendre(&self) -> LegendreSymbol

Returns the Legendre symbol.

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

Returns the square root of self, if it exists.

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

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

impl<'a, P> Sub<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

type Output = Fp256<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P> SubAssign<&'a Fp256<P>> for Fp256<P> where
    P: Fp256Parameters, 

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

Performs the -= operation.

impl<P> ToBytes for Fp256<P> where
    P: Fp256Parameters, 

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

Serializes self into writer.

impl<P> Zero for Fp256<P> where
    P: Fp256Parameters, 

pub fn zero() -> Fp256<P>

pub fn is_zero(&self) -> bool

impl<P> Copy for Fp256<P>

impl<P> Eq for Fp256<P>