pub struct Fp<P: FpConfig<N>, const N: usize>(/* private fields */);
Expand description
Represents an element of the prime field F_p, where p == P::MODULUS
.
This type can represent elements in any field of size at most N * 64 bits.
Implementations§
Source§impl<T: MontConfig<N>, const N: usize> Fp<MontBackend<T, N>, N>
impl<T: MontConfig<N>, const N: usize> Fp<MontBackend<T, N>, N>
Trait Implementations§
Source§impl<'a, P: FpConfig<N>, const N: usize> AddAssign<&'a Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> AddAssign<&'a Fp<P, N>> for Fp<P, N>
Source§fn add_assign(&mut self, other: &Self)
fn add_assign(&mut self, other: &Self)
+=
operation. Read moreSource§impl<'a, P: FpConfig<N>, const N: usize> AddAssign<&'a mut Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> AddAssign<&'a mut Fp<P, N>> for Fp<P, N>
Source§fn add_assign(&mut self, other: &'a mut Self)
fn add_assign(&mut self, other: &'a mut Self)
+=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> AddAssign for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> AddAssign for Fp<P, N>
Source§fn add_assign(&mut self, other: Self)
fn add_assign(&mut self, other: Self)
+=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> CanonicalDeserialize for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> CanonicalDeserialize for Fp<P, N>
Source§fn deserialize_with_mode<R: Read>(
reader: R,
_compress: Compress,
_validate: Validate,
) -> Result<Self, SerializationError>
fn deserialize_with_mode<R: Read>( reader: R, _compress: Compress, _validate: Validate, ) -> Result<Self, SerializationError>
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,
Source§impl<P: FpConfig<N>, const N: usize> CanonicalDeserializeWithFlags for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> CanonicalDeserializeWithFlags for Fp<P, N>
Source§fn deserialize_with_flags<R: Read, F: Flags>(
reader: R,
) -> Result<(Self, F), SerializationError>
fn deserialize_with_flags<R: Read, F: Flags>( reader: R, ) -> Result<(Self, F), SerializationError>
Self
and Flags
from reader
.
Returns empty flags by default.Source§impl<P: FpConfig<N>, const N: usize> CanonicalSerialize for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> CanonicalSerialize for Fp<P, N>
Source§fn serialize_with_mode<W: Write>(
&self,
writer: W,
_compress: Compress,
) -> Result<(), SerializationError>
fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>
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
Source§impl<P: FpConfig<N>, const N: usize> CanonicalSerializeWithFlags for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> CanonicalSerializeWithFlags for Fp<P, N>
Source§fn serialize_with_flags<W: Write, F: Flags>(
&self,
writer: W,
flags: F,
) -> Result<(), SerializationError>
fn serialize_with_flags<W: Write, F: Flags>( &self, writer: W, flags: F, ) -> Result<(), SerializationError>
self
and flags
into writer
.Source§fn serialized_size_with_flags<F: Flags>(&self) -> usize
fn serialized_size_with_flags<F: Flags>(&self) -> usize
self
and flags
into writer
.Source§impl<P: FpConfig<N>, const N: usize> Display for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> Display for Fp<P, N>
Outputs a string containing the value of self
,
represented as a decimal without leading zeroes.
Source§impl<P: FpConfig<N>, const N: usize> Distribution<Fp<P, N>> for Standard
impl<P: FpConfig<N>, const N: usize> Distribution<Fp<P, N>> for Standard
Source§impl<'a, P: FpConfig<N>, const N: usize> DivAssign<&'a Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> DivAssign<&'a Fp<P, N>> for Fp<P, N>
Computes self *= other.inverse()
if other.inverse()
is Some
, and
panics otherwise.
Source§fn div_assign(&mut self, other: &Self)
fn div_assign(&mut self, other: &Self)
/=
operation. Read moreSource§impl<'a, P: FpConfig<N>, const N: usize> DivAssign<&'a mut Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> DivAssign<&'a mut Fp<P, N>> for Fp<P, N>
Source§fn div_assign(&mut self, other: &'a mut Self)
fn div_assign(&mut self, other: &'a mut Self)
/=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> DivAssign for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> DivAssign for Fp<P, N>
Source§fn div_assign(&mut self, other: Self)
fn div_assign(&mut self, other: Self)
/=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> FftField for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> FftField for Fp<P, N>
Source§const TWO_ADICITY: u32 = P::TWO_ADICITY
const TWO_ADICITY: u32 = P::TWO_ADICITY
N
be the size of the multiplicative group defined by the field.
Then TWO_ADICITY
is the two-adicity of N
, i.e. the integer s
such that N = 2^s * t
for some odd integer t
.Source§const TWO_ADIC_ROOT_OF_UNITY: Self = P::TWO_ADIC_ROOT_OF_UNITY
const TWO_ADIC_ROOT_OF_UNITY: Self = P::TWO_ADIC_ROOT_OF_UNITY
Source§const SMALL_SUBGROUP_BASE: Option<u32> = P::SMALL_SUBGROUP_BASE
const SMALL_SUBGROUP_BASE: Option<u32> = P::SMALL_SUBGROUP_BASE
b
such that there exists a multiplicative subgroup
of size b^k
for some integer k
.Source§const SMALL_SUBGROUP_BASE_ADICITY: Option<u32> = P::SMALL_SUBGROUP_BASE_ADICITY
const SMALL_SUBGROUP_BASE_ADICITY: Option<u32> = P::SMALL_SUBGROUP_BASE_ADICITY
k
such that there exists a multiplicative subgroup
of size Self::SMALL_SUBGROUP_BASE^k
.Source§const LARGE_SUBGROUP_ROOT_OF_UNITY: Option<Self> = P::LARGE_SUBGROUP_ROOT_OF_UNITY
const LARGE_SUBGROUP_ROOT_OF_UNITY: Option<Self> = P::LARGE_SUBGROUP_ROOT_OF_UNITY
Source§fn get_root_of_unity(n: u64) -> Option<Self>
fn get_root_of_unity(n: u64) -> Option<Self>
FftConfig::LARGE_SUBGROUP_ROOT_OF_UNITY
(for n = 2^i * FftConfig::SMALL_SUBGROUP_BASE^j for some i, j).Source§impl<P: FpConfig<N>, const N: usize> Field for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> Field for Fp<P, N>
Source§fn frobenius_map_in_place(&mut self, _: usize)
fn frobenius_map_in_place(&mut self, _: usize)
The Frobenius map has no effect in a prime field.
Source§fn mul_by_base_prime_field(&self, elem: &Self::BasePrimeField) -> Self
fn mul_by_base_prime_field(&self, elem: &Self::BasePrimeField) -> Self
Fp is already a “BasePrimeField”, so it’s just mul by self
Source§const SQRT_PRECOMP: Option<SqrtPrecomputation<Self>> = P::SQRT_PRECOMP
const SQRT_PRECOMP: Option<SqrtPrecomputation<Self>> = P::SQRT_PRECOMP
type BasePrimeField = Fp<P, N>
Source§fn extension_degree() -> u64
fn extension_degree() -> u64
Self::BasePrimeField
.Source§fn from_base_prime_field(elem: Self::BasePrimeField) -> Self
fn from_base_prime_field(elem: Self::BasePrimeField) -> Self
fn to_base_prime_field_elements( &self, ) -> impl Iterator<Item = Self::BasePrimeField>
Source§fn from_base_prime_field_elems(
elems: impl IntoIterator<Item = Self::BasePrimeField>,
) -> Option<Self>
fn from_base_prime_field_elems( elems: impl IntoIterator<Item = Self::BasePrimeField>, ) -> Option<Self>
Source§fn characteristic() -> &'static [u64]
fn characteristic() -> &'static [u64]
Source§fn sum_of_products<const T: usize>(a: &[Self; T], b: &[Self; T]) -> Self
fn sum_of_products<const T: usize>(a: &[Self; T], b: &[Self; T]) -> Self
sum([a_i * b_i])
.Source§fn from_random_bytes_with_flags<F: Flags>(bytes: &[u8]) -> Option<(Self, F)>
fn from_random_bytes_with_flags<F: Flags>(bytes: &[u8]) -> Option<(Self, F)>
F
specification. Returns None
if the deserialization
fails. Read moreSource§fn square_in_place(&mut self) -> &mut Self
fn square_in_place(&mut self) -> &mut Self
self
in place.Source§fn inverse(&self) -> Option<Self>
fn inverse(&self) -> Option<Self>
self
if self
is nonzero.Source§fn inverse_in_place(&mut self) -> Option<&mut Self>
fn inverse_in_place(&mut self) -> Option<&mut Self>
self.inverse().is_none()
, this just returns None
. Otherwise, it sets
self
to self.inverse().unwrap()
.Source§fn legendre(&self) -> LegendreSymbol
fn legendre(&self) -> LegendreSymbol
LegendreSymbol
, which indicates whether this field element
is 1 : a quadratic residue
0 : equal to 0
-1 : a quadratic non-residueSource§fn from_random_bytes(bytes: &[u8]) -> Option<Self>
fn from_random_bytes(bytes: &[u8]) -> Option<Self>
None
if the
deserialization fails. Read moreSource§fn sqrt_in_place(&mut self) -> Option<&mut Self>
fn sqrt_in_place(&mut self) -> Option<&mut Self>
self
to be the square root of self
, if it exists.Source§fn frobenius_map(&self, power: usize) -> Self
fn frobenius_map(&self, power: usize) -> Self
self^s
, where s = Self::BasePrimeField::MODULUS^power
.
This is also called the Frobenius automorphism.Source§fn pow<S: AsRef<[u64]>>(&self, exp: S) -> Self
fn pow<S: AsRef<[u64]>>(&self, exp: S) -> Self
self^exp
, where exp
is an integer represented with u64
limbs,
least significant limb first.Source§fn pow_with_table<S: AsRef<[u64]>>(powers_of_2: &[Self], exp: S) -> Option<Self>
fn pow_with_table<S: AsRef<[u64]>>(powers_of_2: &[Self], exp: S) -> Option<Self>
f
by a number represented with u64
limbs, using a precomputed table containing as many powers of 2 of
f
as the 1 + the floor of log2 of the exponent exp
, starting
from the 1st power. That is, powers_of_2
should equal &[p, p^2, p^4, ..., p^(2^n)]
when exp
has at most n
bits. Read moreSource§impl<'a, P: FpConfig<N>, const N: usize> MulAssign<&'a Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> MulAssign<&'a Fp<P, N>> for Fp<P, N>
Source§fn mul_assign(&mut self, other: &Self)
fn mul_assign(&mut self, other: &Self)
*=
operation. Read moreSource§impl<'a, P: FpConfig<N>, const N: usize> MulAssign<&'a mut Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> MulAssign<&'a mut Fp<P, N>> for Fp<P, N>
Source§fn mul_assign(&mut self, other: &'a mut Self)
fn mul_assign(&mut self, other: &'a mut Self)
*=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> MulAssign for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> MulAssign for Fp<P, N>
Source§fn mul_assign(&mut self, other: Self)
fn mul_assign(&mut self, other: Self)
*=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> Ord for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> Ord for Fp<P, N>
Note that this implementation of Ord
compares field elements viewing
them as integers in the range 0, 1, …, P::MODULUS - 1. However, other
implementations of PrimeField
might choose a different ordering, and
as such, users should use this Ord
for applications where
any ordering suffices (like in a BTreeMap), and not in applications
where a particular ordering is required.
Source§impl<P: FpConfig<N>, const N: usize> PartialOrd for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> PartialOrd for Fp<P, N>
Note that this implementation of PartialOrd
compares field elements
viewing them as integers in the range 0, 1, …, P::MODULUS
- 1. However,
other implementations of PrimeField
might choose a different ordering, and
as such, users should use this PartialOrd
for applications where
any ordering suffices (like in a BTreeMap), and not in applications
where a particular ordering is required.
Source§impl<P: FpConfig<N>, const N: usize> PrimeField for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> PrimeField for Fp<P, N>
Source§const MODULUS_MINUS_ONE_DIV_TWO: Self::BigInt = _
const MODULUS_MINUS_ONE_DIV_TWO: Self::BigInt = _
(p - 1)/ 2
.Source§const MODULUS_BIT_SIZE: u32 = _
const MODULUS_BIT_SIZE: u32 = _
Source§const TRACE: Self::BigInt = _
const TRACE: Self::BigInt = _
t
such that by
2^s * t = p - 1
, and t
is coprime to 2.Source§const TRACE_MINUS_ONE_DIV_TWO: Self::BigInt = _
const TRACE_MINUS_ONE_DIV_TWO: Self::BigInt = _
(t - 1)/ 2
.Source§fn from_bigint(r: BigInt<N>) -> Option<Self>
fn from_bigint(r: BigInt<N>) -> Option<Self>
Source§fn into_bigint(self) -> BigInt<N>
fn into_bigint(self) -> BigInt<N>
Source§fn from_be_bytes_mod_order(bytes: &[u8]) -> Self
fn from_be_bytes_mod_order(bytes: &[u8]) -> Self
bytes
is larger than the modulus p
, this method
performs the appropriate reduction.Source§fn from_le_bytes_mod_order(bytes: &[u8]) -> Self
fn from_le_bytes_mod_order(bytes: &[u8]) -> Self
bytes
is larger than the modulus p
, this method
performs the appropriate reduction.Source§impl<'a, P: FpConfig<N>, const N: usize> SubAssign<&'a Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> SubAssign<&'a Fp<P, N>> for Fp<P, N>
Source§fn sub_assign(&mut self, other: &Self)
fn sub_assign(&mut self, other: &Self)
-=
operation. Read moreSource§impl<'a, P: FpConfig<N>, const N: usize> SubAssign<&'a mut Fp<P, N>> for Fp<P, N>
impl<'a, P: FpConfig<N>, const N: usize> SubAssign<&'a mut Fp<P, N>> for Fp<P, N>
Source§fn sub_assign(&mut self, other: &'a mut Self)
fn sub_assign(&mut self, other: &'a mut Self)
-=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> SubAssign for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> SubAssign for Fp<P, N>
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
-=
operation. Read moreSource§impl<P: FpConfig<N>, const N: usize> Valid for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> Valid for Fp<P, N>
fn check(&self) -> Result<(), SerializationError>
fn batch_check<'a>(
batch: impl Iterator<Item = &'a Self> + Send,
) -> Result<(), SerializationError>where
Self: 'a,
impl<P: FpConfig<N>, const N: usize> Copy for Fp<P, N>
impl<P: FpConfig<N>, const N: usize> Eq for Fp<P, N>
Auto Trait Implementations§
impl<P, const N: usize> Freeze for Fp<P, N>
impl<P, const N: usize> RefUnwindSafe for Fp<P, N>where
P: RefUnwindSafe,
impl<P, const N: usize> Send for Fp<P, N>
impl<P, const N: usize> Sync for Fp<P, N>
impl<P, const N: usize> Unpin for Fp<P, N>where
P: Unpin,
impl<P, const N: usize> UnwindSafe for Fp<P, N>where
P: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CanonicalSerializeHashExt for Twhere
T: CanonicalSerialize,
impl<T> CanonicalSerializeHashExt for Twhere
T: CanonicalSerialize,
fn hash<H>(&self) -> GenericArray<u8, <H as OutputSizeUser>::OutputSize>where
H: Digest,
fn hash_uncompressed<H>(
&self,
) -> GenericArray<u8, <H as OutputSizeUser>::OutputSize>where
H: Digest,
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)