Struct snarkvm_wasm::Fp3

pub struct Fp3<P> where
    P: Fp3Parameters,  {
    pub c0: <P as Fp3Parameters>::Fp,
    pub c1: <P as Fp3Parameters>::Fp,
    pub c2: <P as Fp3Parameters>::Fp,
    // some fields omitted
}

Fields

c0: <P as Fp3Parameters>::Fp

c1: <P as Fp3Parameters>::Fp

c2: <P as Fp3Parameters>::Fp

Implementations

impl<P> Fp3<P> where
    P: Fp3Parameters, 

pub fn new(
    c0: <P as Fp3Parameters>::Fp,
    c1: <P as Fp3Parameters>::Fp,
    c2: <P as Fp3Parameters>::Fp
) -> Fp3<P>

pub fn mul_assign_by_fp(&mut self, value: &<P as Fp3Parameters>::Fp)

pub fn norm(&self) -> <P as Fp3Parameters>::Fp

pub fn qnr_to_t() -> Fp3<P>

Trait Implementations

impl<'a, P> Add<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

type Output = Fp3<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P> AddAssign<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the += operation.

impl<P> CanonicalDeserialize for Fp3<P> where
    P: Fp3Parameters, 

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

Reads Self from reader.

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

Reads Self from reader without compression.

impl<P> CanonicalDeserializeWithFlags for Fp3<P> where
    P: Fp3Parameters, 

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

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

impl<P> CanonicalSerialize for Fp3<P> where
    P: Fp3Parameters, 

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

Serializes self into writer.

pub fn serialized_size(&self) -> usize

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

Serializes self into writer without compression.

pub fn uncompressed_size(&self) -> usize

impl<P> CanonicalSerializeWithFlags for Fp3<P> where
    P: Fp3Parameters, 

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 Fp3<P> where
    P: Fp3Parameters, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> ConstantSerializedSize for Fp3<P> where
    P: Fp3Parameters, 

pub const SERIALIZED_SIZE: usize

pub const UNCOMPRESSED_SIZE: usize

impl<P> Copy for Fp3<P> where
    P: Fp3Parameters, 

impl<P> Debug for Fp3<P> where
    P: Fp3Parameters, 

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

Formats the value using the given formatter.

impl<P> Default for Fp3<P> where
    P: Fp3Parameters, 

pub fn default() -> Fp3<P>

Returns the “default value” for a type.

impl<'de, P> Deserialize<'de> for Fp3<P> where
    P: Fp3Parameters,
    <P as Fp3Parameters>::Fp: Deserialize<'de>, 

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Fp3<P>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<P> Display for Fp3<P> where
    P: Fp3Parameters, 

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

Formats the value using the given formatter.

impl<'a, P> Div<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

type Output = Fp3<P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, P> DivAssign<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the /= operation.

impl<P> Eq for Fp3<P> where
    P: Fp3Parameters, 

impl<P> Field for Fp3<P> where
    P: Fp3Parameters, 

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

Returns the characteristic of the field.

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

Returns self + self.

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

Doubles self in place.

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

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.

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

Returns self * self.

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

Squares self in place.

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

Computes the multiplicative inverse of self if self is nonzero.

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

pub fn frobenius_map(&mut self, power: usize)

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

pub 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.

impl<P> From<u128> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the conversion.

impl<P> From<u16> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the conversion.

impl<P> From<u32> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the conversion.

impl<P> From<u64> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the conversion.

impl<P> From<u8> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the conversion.

impl<P> FromBytes for Fp3<P> where
    P: Fp3Parameters, 

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

Reads Self from reader.

impl<P> FromStr for Fp3<P> where
    P: Fp3Parameters, 

type Err = ()

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Fp3<P>, <Fp3<P> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<P> Hash for Fp3<P> where
    P: Fp3Parameters, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a, P> Mul<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

type Output = Fp3<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P> MulAssign<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the *= operation.

impl<P> Neg for Fp3<P> where
    P: Fp3Parameters, 

type Output = Fp3<P>

The resulting type after applying the - operator.

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

Performs the unary - operation.

impl<P> One for Fp3<P> where
    P: Fp3Parameters, 

pub fn one() -> Fp3<P>

pub fn is_one(&self) -> bool

impl<P> Ord for Fp3<P> where
    P: Fp3Parameters, 

Fp3 elements are ordered lexicographically.

pub fn cmp(&self, other: &Fp3<P>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<P> PartialEq<Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

pub fn eq(&self, other: &Fp3<P>) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<P> PartialOrd<Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

pub fn partial_cmp(&self, other: &Fp3<P>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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> Serialize for Fp3<P> where
    P: Fp3Parameters,
    <P as Fp3Parameters>::Fp: Serialize, 

pub fn serialize<__S>(
    &self,
    __serializer: __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 Fp3<P> where
    P: Fp3Parameters, 

pub fn legendre(&self) -> LegendreSymbol

Returns the Legendre symbol.

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

Returns the square root of self, if it exists.

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

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

impl<'a, P> Sub<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

type Output = Fp3<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P> SubAssign<&'a Fp3<P>> for Fp3<P> where
    P: Fp3Parameters, 

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

Performs the -= operation.

impl<P> ToBytes for Fp3<P> where
    P: Fp3Parameters, 

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

Serializes self into writer.

impl<P> Zero for Fp3<P> where
    P: Fp3Parameters, 

pub fn zero() -> Fp3<P>

pub fn is_zero(&self) -> bool