Struct crypto_bigint::modular::constant_mod::Residue
source · pub struct Residue<MOD, const LIMBS: usize>where
MOD: ResidueParams<LIMBS>,{ /* private fields */ }
Expand description
A residue mod MOD
, represented using LIMBS
limbs. The modulus of this residue is constant, so it cannot be set at runtime.
Internally, the value is stored in Montgomery form (multiplied by MOD::R) until it is retrieved.
Implementations§
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
sourcepub const fn invert(&self) -> (Self, CtChoice)
pub const fn invert(&self) -> (Self, CtChoice)
Computes the residue self^-1
representing the multiplicative inverse of self
.
I.e. self * self^-1 = 1
.
If the number was invertible, the second element of the tuple is the truthy value,
otherwise it is the falsy value (in which case the first element’s value is unspecified).
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
sourcepub const fn pow<const RHS_LIMBS: usize>(
&self,
exponent: &Uint<RHS_LIMBS>
) -> Residue<MOD, LIMBS>
pub const fn pow<const RHS_LIMBS: usize>( &self, exponent: &Uint<RHS_LIMBS> ) -> Residue<MOD, LIMBS>
Raises to the exponent
power.
sourcepub const fn pow_bounded_exp<const RHS_LIMBS: usize>(
&self,
exponent: &Uint<RHS_LIMBS>,
exponent_bits: usize
) -> Residue<MOD, LIMBS>
pub const fn pow_bounded_exp<const RHS_LIMBS: usize>( &self, exponent: &Uint<RHS_LIMBS>, exponent_bits: usize ) -> Residue<MOD, LIMBS>
Raises to the exponent
power,
with exponent_bits
representing the number of (least significant) bits
to take into account for the exponent.
NOTE: exponent_bits
may be leaked in the time pattern.
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Residue<MOD, LIMBS>
sourcepub const fn new(integer: &Uint<LIMBS>) -> Self
pub const fn new(integer: &Uint<LIMBS>) -> Self
Instantiates a new Residue
that represents this integer
mod MOD
.
If the modulus represented by MOD
is not odd, this function will panic; use new_checked
if you want to be able to detect an invalid modulus.
sourcepub fn new_checked(integer: &Uint<LIMBS>) -> CtOption<Self>
pub fn new_checked(integer: &Uint<LIMBS>) -> CtOption<Self>
Instantiates a new Residue
that represents this integer
mod MOD
if the modulus is odd.
Returns a CtOption
that is None
if the provided modulus is not odd; this is a safer version of new
, which can panic.
sourcepub const fn retrieve(&self) -> Uint<LIMBS>
pub const fn retrieve(&self) -> Uint<LIMBS>
Retrieves the integer currently encoded in this Residue
, guaranteed to be reduced.
sourcepub const fn as_montgomery(&self) -> &Uint<LIMBS>
pub const fn as_montgomery(&self) -> &Uint<LIMBS>
Access the Residue
value in Montgomery form.
sourcepub fn as_montgomery_mut(&mut self) -> &mut Uint<LIMBS>
pub fn as_montgomery_mut(&mut self) -> &mut Uint<LIMBS>
Mutably access the Residue
value in Montgomery form.
sourcepub const fn from_montgomery(integer: Uint<LIMBS>) -> Self
pub const fn from_montgomery(integer: Uint<LIMBS>) -> Self
Create a Residue
from a value in Montgomery form.
sourcepub const fn to_montgomery(&self) -> Uint<LIMBS>
pub const fn to_montgomery(&self) -> Uint<LIMBS>
Extract the value from the Residue
in Montgomery form.
Trait Implementations§
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Add<&Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Add<&Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Add<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Add<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Add<Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Add<Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> AddAssign<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> AddAssign<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
source§fn add_assign(&mut self, rhs: &Self)
fn add_assign(&mut self, rhs: &Self)
+=
operation. Read moresource§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> AddAssign for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> AddAssign for Residue<MOD, LIMBS>
source§fn add_assign(&mut self, rhs: Self)
fn add_assign(&mut self, rhs: Self)
+=
operation. Read moresource§impl<MOD, const LIMBS: usize> Clone for Residue<MOD, LIMBS>where
MOD: ResidueParams<LIMBS> + Clone,
impl<MOD, const LIMBS: usize> Clone for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS> + Clone,
source§impl<MOD: ResidueParams<LIMBS> + Copy, const LIMBS: usize> ConditionallySelectable for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS> + Copy, const LIMBS: usize> ConditionallySelectable for Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> ConstantTimeEq for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> ConstantTimeEq for Residue<MOD, LIMBS>
source§impl<MOD, const LIMBS: usize> Debug for Residue<MOD, LIMBS>where
MOD: ResidueParams<LIMBS> + Debug,
impl<MOD, const LIMBS: usize> Debug for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS> + Debug,
source§impl<'de, MOD, const LIMBS: usize> Deserialize<'de> for Residue<MOD, LIMBS>where
MOD: ResidueParams<LIMBS>,
Uint<LIMBS>: Encoding,
Available on crate feature serde
only.
impl<'de, MOD, const LIMBS: usize> Deserialize<'de> for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS>, Uint<LIMBS>: Encoding,
serde
only.source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,
source§impl<const LIMBS: usize, P: ResidueParams<LIMBS>> From<&Residue<P, LIMBS>> for DynResidue<LIMBS>
impl<const LIMBS: usize, P: ResidueParams<LIMBS>> From<&Residue<P, LIMBS>> for DynResidue<LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Mul<&Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Mul<&Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Mul<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Mul<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Mul<Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Mul<Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> MulAssign<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> MulAssign<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
source§fn mul_assign(&mut self, rhs: &Residue<MOD, LIMBS>)
fn mul_assign(&mut self, rhs: &Residue<MOD, LIMBS>)
*=
operation. Read moresource§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> MulAssign for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> MulAssign for Residue<MOD, LIMBS>
source§fn mul_assign(&mut self, rhs: Self)
fn mul_assign(&mut self, rhs: Self)
*=
operation. Read moresource§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize, const RHS_LIMBS: usize> MultiExponentiateBoundedExp<Uint<RHS_LIMBS>, [(Residue<MOD, LIMBS>, Uint<RHS_LIMBS>)]> for Residue<MOD, LIMBS>
Available on crate feature alloc
only.
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize, const RHS_LIMBS: usize> MultiExponentiateBoundedExp<Uint<RHS_LIMBS>, [(Residue<MOD, LIMBS>, Uint<RHS_LIMBS>)]> for Residue<MOD, LIMBS>
alloc
only.source§fn multi_exponentiate_bounded_exp(
bases_and_exponents: &[(Self, Uint<RHS_LIMBS>)],
exponent_bits: usize
) -> Self
fn multi_exponentiate_bounded_exp( bases_and_exponents: &[(Self, Uint<RHS_LIMBS>)], exponent_bits: usize ) -> Self
x1 ^ k1 * ... * xn ^ kn
.source§impl<const N: usize, MOD: ResidueParams<LIMBS>, const LIMBS: usize, const RHS_LIMBS: usize> MultiExponentiateBoundedExp<Uint<RHS_LIMBS>, [(Residue<MOD, LIMBS>, Uint<RHS_LIMBS>); N]> for Residue<MOD, LIMBS>
impl<const N: usize, MOD: ResidueParams<LIMBS>, const LIMBS: usize, const RHS_LIMBS: usize> MultiExponentiateBoundedExp<Uint<RHS_LIMBS>, [(Residue<MOD, LIMBS>, Uint<RHS_LIMBS>); N]> for Residue<MOD, LIMBS>
source§impl<MOD, const LIMBS: usize> PartialEq for Residue<MOD, LIMBS>where
MOD: ResidueParams<LIMBS> + PartialEq,
impl<MOD, const LIMBS: usize> PartialEq for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS> + PartialEq,
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize, const RHS_LIMBS: usize> PowBoundedExp<Uint<RHS_LIMBS>> for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize, const RHS_LIMBS: usize> PowBoundedExp<Uint<RHS_LIMBS>> for Residue<MOD, LIMBS>
source§impl<MOD, const LIMBS: usize> Random for Residue<MOD, LIMBS>where
MOD: ResidueParams<LIMBS>,
Available on crate feature rand_core
only.
impl<MOD, const LIMBS: usize> Random for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS>,
rand_core
only.source§fn random(rng: &mut impl CryptoRngCore) -> Self
fn random(rng: &mut impl CryptoRngCore) -> Self
source§impl<MOD, const LIMBS: usize> Serialize for Residue<MOD, LIMBS>where
MOD: ResidueParams<LIMBS>,
Uint<LIMBS>: Encoding,
Available on crate feature serde
only.
impl<MOD, const LIMBS: usize> Serialize for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS>, Uint<LIMBS>: Encoding,
serde
only.source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Sub<&Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Sub<&Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Sub<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Sub<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Sub<Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Sub<Residue<MOD, LIMBS>> for &Residue<MOD, LIMBS>
source§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> SubAssign<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> SubAssign<&Residue<MOD, LIMBS>> for Residue<MOD, LIMBS>
source§fn sub_assign(&mut self, rhs: &Self)
fn sub_assign(&mut self, rhs: &Self)
-=
operation. Read moresource§impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> SubAssign for Residue<MOD, LIMBS>
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> SubAssign for Residue<MOD, LIMBS>
source§fn sub_assign(&mut self, rhs: Self)
fn sub_assign(&mut self, rhs: Self)
-=
operation. Read moreimpl<MOD, const LIMBS: usize> Copy for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS> + Copy,
impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> DefaultIsZeroes for Residue<MOD, LIMBS>
zeroize
only.impl<MOD, const LIMBS: usize> Eq for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS> + Eq,
impl<MOD, const LIMBS: usize> StructuralEq for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS>,
impl<MOD, const LIMBS: usize> StructuralPartialEq for Residue<MOD, LIMBS>where MOD: ResidueParams<LIMBS>,
Auto Trait Implementations§
impl<MOD, const LIMBS: usize> RefUnwindSafe for Residue<MOD, LIMBS>where MOD: RefUnwindSafe,
impl<MOD, const LIMBS: usize> Send for Residue<MOD, LIMBS>
impl<MOD, const LIMBS: usize> Sync for Residue<MOD, LIMBS>
impl<MOD, const LIMBS: usize> Unpin for Residue<MOD, LIMBS>where MOD: Unpin,
impl<MOD, const LIMBS: usize> UnwindSafe for Residue<MOD, LIMBS>where MOD: 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> ConditionallyNegatable for Twhere
T: ConditionallySelectable,
&'a T: for<'a> Neg<Output = T>,
impl<T> ConditionallyNegatable for Twhere T: ConditionallySelectable, &'a T: for<'a> Neg<Output = T>,
source§fn conditional_negate(&mut self, choice: Choice)
fn conditional_negate(&mut self, choice: Choice)
source§impl<T, Exponent, BasesAndExponents> MultiExponentiate<Exponent, BasesAndExponents> for Twhere
T: MultiExponentiateBoundedExp<Exponent, BasesAndExponents>,
Exponent: Bounded,
BasesAndExponents: AsRef<[(T, Exponent)]> + ?Sized,
impl<T, Exponent, BasesAndExponents> MultiExponentiate<Exponent, BasesAndExponents> for Twhere T: MultiExponentiateBoundedExp<Exponent, BasesAndExponents>, Exponent: Bounded, BasesAndExponents: AsRef<[(T, Exponent)]> + ?Sized,
source§fn multi_exponentiate(bases_and_exponents: &BasesAndExponents) -> T
fn multi_exponentiate(bases_and_exponents: &BasesAndExponents) -> T
x1 ^ k1 * ... * xn ^ kn
.