Struct Fp2

pub struct Fp2<P>
where
    P: Fp2Parameters,
{
    pub c0: <P as Fp2Parameters>::Fp,
    pub c1: <P as Fp2Parameters>::Fp,
}

Fields

c0: <P as Fp2Parameters>::Fp

c1: <P as Fp2Parameters>::Fp

Implementations

impl<P> Fp2<P>

where P: Fp2Parameters,

pub const fn new( c0: <P as Fp2Parameters>::Fp, c1: <P as Fp2Parameters>::Fp, ) -> Fp2<P>

Initializes a Fp2 element from two Fp elements.

impl<P> Fp2<P>

where P: Fp2Parameters,

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

Norm of Fp2 over Fp: Norm(a) = a.x^2 - beta * a.y^2

pub fn mul_by_fp(&mut self, element: &<P as Fp2Parameters>::Fp)

Trait Implementations

impl<P> Add<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P> Add<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P> Add<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P> Add for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P> AddAssign<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the += operation.

impl<P> AddAssign<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the += operation.

impl<'a, P> AddAssign<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the += operation.

impl<P> AddAssign for Fp2<P>

where P: Fp2Parameters,

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

Performs the += operation.

impl<P> CanonicalDeserialize for Fp2<P>

where P: Fp2Parameters,

fn deserialize_with_mode<R>( reader: R, compress: Compress, validate: Validate, ) -> Result<Fp2<P>, SerializationError>

where R: Read,

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> CanonicalDeserializeWithFlags for Fp2<P>

where P: Fp2Parameters,

fn deserialize_with_flags<R, F>( reader: R, ) -> Result<(Fp2<P>, F), SerializationError>

where R: Read, F: Flags,

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

impl<P> CanonicalSerialize for Fp2<P>

where P: Fp2Parameters,

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

where W: Write,

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> CanonicalSerializeWithFlags for Fp2<P>

where P: Fp2Parameters,

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

where W: Write, F: Flags,

Serializes self and flags into writer.

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

where F: Flags,

Serializes self and flags into writer.

impl<P> Clone for Fp2<P>

where P: Clone + Fp2Parameters, <P as Fp2Parameters>::Fp: Clone,

fn clone(&self) -> Fp2<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Debug for Fp2<P>

where P: Debug + Fp2Parameters, <P as Fp2Parameters>::Fp: Debug,

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

Formats the value using the given formatter.

impl<P> Default for Fp2<P>

where P: Default + Fp2Parameters, <P as Fp2Parameters>::Fp: Default,

fn default() -> Fp2<P>

Returns the “default value” for a type.

impl<'de, P> Deserialize<'de> for Fp2<P>

where P: Fp2Parameters, <P as Fp2Parameters>::Fp: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P> Display for Fp2<P>

where P: Fp2Parameters,

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

Formats the value using the given formatter.

impl<P> Div<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<P> Div<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, P> Div<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<P> Div for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<P> DivAssign<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the /= operation.

impl<P> DivAssign<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the /= operation.

impl<'a, P> DivAssign<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the /= operation.

impl<P> DivAssign for Fp2<P>

where P: Fp2Parameters,

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

Performs the /= operation.

impl<P> Field for Fp2<P>

where P: Fp2Parameters,

type BasePrimeField = <P as Fp2Parameters>::Fp

fn from_base_prime_field(other: <Fp2<P> as Field>::BasePrimeField) -> Fp2<P>

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

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

Returns the characteristic of the field.

fn double(&self) -> Fp2<P>

Returns self + self.

fn double_in_place(&mut self)

Doubles self in place.

fn square(&self) -> Fp2<P>

Returns self * self.

fn from_random_bytes_with_flags<F>(bytes: &[u8]) -> Option<(Fp2<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.

fn from_random_bytes(bytes: &[u8]) -> Option<Fp2<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.

fn square_in_place(&mut self) -> &mut Fp2<P>

Squares self in place.

fn inverse(&self) -> Option<Fp2<P>>

Computes the multiplicative inverse of self if self is nonzero.

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

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

fn frobenius_map(&mut self, power: usize)

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

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

where P: Fp2Parameters,

fn from(other: u128) -> Fp2<P>

Converts to this type from the input type.

impl<P> From<u16> for Fp2<P>

where P: Fp2Parameters,

fn from(other: u16) -> Fp2<P>

Converts to this type from the input type.

impl<P> From<u32> for Fp2<P>

where P: Fp2Parameters,

fn from(other: u32) -> Fp2<P>

Converts to this type from the input type.

impl<P> From<u64> for Fp2<P>

where P: Fp2Parameters,

fn from(other: u64) -> Fp2<P>

Converts to this type from the input type.

impl<P> From<u8> for Fp2<P>

where P: Fp2Parameters,

fn from(other: u8) -> Fp2<P>

Converts to this type from the input type.

impl<P> FromBytes for Fp2<P>

where P: Fp2Parameters,

fn read_le<R>(reader: R) -> Result<Fp2<P>, Error>

where R: Read,

Reads Self from reader as little-endian bytes.

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

where Self: Sized,

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

impl<P> Hash for Fp2<P>

where P: Hash + Fp2Parameters, <P as Fp2Parameters>::Fp: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P> Mul<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<P> Mul<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P> Mul<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<P> Mul for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<P> MulAssign<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the *= operation.

impl<P> MulAssign<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the *= operation.

impl<'a, P> MulAssign<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the *= operation.

impl<P> MulAssign for Fp2<P>

where P: Fp2Parameters,

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

Performs the *= operation.

impl<P> Neg for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the - operator.

fn neg(self) -> Fp2<P>

Performs the unary - operation.

impl<P> One for Fp2<P>

where P: Fp2Parameters,

fn one() -> Fp2<P>

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> Ord for Fp2<P>

where P: Fp2Parameters,

Fp2 elements are ordered lexicographically.

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<P> PartialEq for Fp2<P>

where P: PartialEq + Fp2Parameters, <P as Fp2Parameters>::Fp: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<P> PartialOrd for Fp2<P>

where P: Fp2Parameters,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, P> Product<&'a Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

fn product<I>(iter: I) -> Fp2<P>

where I: Iterator<Item = &'a Fp2<P>>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl<P> Product for Fp2<P>

where P: Fp2Parameters,

fn product<I>(iter: I) -> Fp2<P>

where I: Iterator<Item = Fp2<P>>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl<P> Serialize for Fp2<P>

where P: Fp2Parameters, <P as Fp2Parameters>::Fp: Serialize,

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

where P: Fp2Parameters, <P as Fp2Parameters>::Fp: SquareRootField,

fn legendre(&self) -> LegendreSymbol

Returns the Legendre symbol.

fn sqrt(&self) -> Option<Fp2<P>>

Returns the square root of self, if it exists.

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

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

impl<P> Sub<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P> Sub<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P> Sub<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P> Sub for Fp2<P>

where P: Fp2Parameters,

type Output = Fp2<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P> SubAssign<&&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the -= operation.

impl<P> SubAssign<&Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the -= operation.

impl<'a, P> SubAssign<&'a mut Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

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

Performs the -= operation.

impl<P> SubAssign for Fp2<P>

where P: Fp2Parameters,

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

Performs the -= operation.

impl<'a, P> Sum<&'a Fp2<P>> for Fp2<P>

where P: Fp2Parameters,

fn sum<I>(iter: I) -> Fp2<P>

where I: Iterator<Item = &'a Fp2<P>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<P> Sum for Fp2<P>

where P: Fp2Parameters,

fn sum<I>(iter: I) -> Fp2<P>

where I: Iterator<Item = Fp2<P>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<P> ToBits for Fp2<P>

where P: Fp2Parameters,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Writes self into the given vector as a boolean array in little-endian order.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Writes self into the given vector as a boolean array in big-endian order.

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.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<P> ToBytes for Fp2<P>

where P: Fp2Parameters,

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>, Error>

where Self: Sized,

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

impl<P> ToConstraintField<<P as Fp2Parameters>::Fp> for Fp2<P>

where P: Fp2Parameters,

fn to_field_elements( &self, ) -> Result<Vec<<P as Fp2Parameters>::Fp>, ConstraintFieldError>

impl<P> Valid for Fp2<P>

where P: Fp2Parameters,

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

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

where Fp2<P>: 'a,

impl<P> Zero for Fp2<P>

where P: Fp2Parameters,

fn zero() -> Fp2<P>

fn is_zero(&self) -> bool

impl<P> Copy for Fp2<P>

where P: Copy + Fp2Parameters, <P as Fp2Parameters>::Fp: Copy,

impl<P> Eq for Fp2<P>

where P: Eq + Fp2Parameters, <P as Fp2Parameters>::Fp: Eq,

impl<P> StructuralPartialEq for Fp2<P>

where P: Fp2Parameters,