Struct oberon::inner_types::elliptic_curve::bigint::modular::runtime_mod::DynResidue

pub struct DynResidue<const LIMBS: usize> { /* private fields */ }
Expand description

A residue represented using LIMBS limbs. The odd modulus of this residue is set at runtime.

Implementations§

§

impl<const LIMBS: usize> DynResidue<LIMBS>

pub const fn add(&self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Adds rhs.

§

impl<const LIMBS: usize> DynResidue<LIMBS>

pub const fn invert(&self) -> (DynResidue<LIMBS>, 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).

§

impl<const LIMBS: usize> DynResidue<LIMBS>

pub const fn mul(&self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Multiplies by rhs.

pub const fn square(&self) -> DynResidue<LIMBS>

Computes the (reduced) square of a residue.

§

impl<const LIMBS: usize> DynResidue<LIMBS>

pub const fn neg(&self) -> DynResidue<LIMBS>

Negates the number.

§

impl<const LIMBS: usize> DynResidue<LIMBS>

pub const fn pow(&self, exponent: &Uint<LIMBS>) -> DynResidue<LIMBS>

Raises to the exponent power.

pub const fn pow_bounded_exp( &self, exponent: &Uint<LIMBS>, exponent_bits: usize ) -> DynResidue<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.

§

impl<const LIMBS: usize> DynResidue<LIMBS>

pub const fn sub(&self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Subtracts rhs.

§

impl<const LIMBS: usize> DynResidue<LIMBS>

pub const fn new( integer: &Uint<LIMBS>, residue_params: DynResidueParams<LIMBS> ) -> DynResidue<LIMBS>

Instantiates a new Residue that represents this integer mod MOD.

pub const fn retrieve(&self) -> Uint<LIMBS>

Retrieves the integer currently encoded in this Residue, guaranteed to be reduced.

pub const fn zero(residue_params: DynResidueParams<LIMBS>) -> DynResidue<LIMBS>

Instantiates a new Residue that represents zero.

pub const fn one(residue_params: DynResidueParams<LIMBS>) -> DynResidue<LIMBS>

Instantiates a new Residue that represents 1.

pub const fn params(&self) -> &DynResidueParams<LIMBS>

Returns the parameter struct used to initialize this residue.

pub fn div_by_2(&self) -> DynResidue<LIMBS>

Performs the modular division by 2, that is for given x returns y such that y * 2 = x mod p. This means:

  • if x is even, returns x / 2,
  • if x is odd, returns (x + p) / 2 (since the modulus p in Montgomery form is always odd, this divides entirely).

Trait Implementations§

§

impl<const LIMBS: usize> Add<&DynResidue<LIMBS>> for &DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the + operator.
§

fn add(self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the + operation. Read more
§

impl<const LIMBS: usize> Add<&DynResidue<LIMBS>> for DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the + operator.
§

fn add(self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the + operation. Read more
§

impl<const LIMBS: usize> Add<DynResidue<LIMBS>> for &DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the + operator.
§

fn add(self, rhs: DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the + operation. Read more
§

impl<const LIMBS: usize> Add<DynResidue<LIMBS>> for DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the + operator.
§

fn add(self, rhs: DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the + operation. Read more
§

impl<const LIMBS: usize> AddAssign<&DynResidue<LIMBS>> for DynResidue<LIMBS>

§

fn add_assign(&mut self, rhs: &DynResidue<LIMBS>)

Performs the += operation. Read more
§

impl<const LIMBS: usize> AddAssign<DynResidue<LIMBS>> for DynResidue<LIMBS>

§

fn add_assign(&mut self, rhs: DynResidue<LIMBS>)

Performs the += operation. Read more
§

impl<const LIMBS: usize> Clone for DynResidue<LIMBS>

§

fn clone(&self) -> DynResidue<LIMBS>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl<const LIMBS: usize> Debug for DynResidue<LIMBS>

§

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

Formats the value using the given formatter. Read more
§

impl<const LIMBS: usize> Invert for DynResidue<LIMBS>

§

type Output = CtOption<DynResidue<LIMBS>>

Output of the inversion.
§

fn invert(&self) -> <DynResidue<LIMBS> as Invert>::Output

Computes the inverse.
§

impl<const LIMBS: usize> Mul<&DynResidue<LIMBS>> for &DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the * operator.
§

fn mul(self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the * operation. Read more
§

impl<const LIMBS: usize> Mul<&DynResidue<LIMBS>> for DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the * operator.
§

fn mul(self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the * operation. Read more
§

impl<const LIMBS: usize> Mul<DynResidue<LIMBS>> for &DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the * operator.
§

fn mul(self, rhs: DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the * operation. Read more
§

impl<const LIMBS: usize> Mul<DynResidue<LIMBS>> for DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the * operator.
§

fn mul(self, rhs: DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the * operation. Read more
§

impl<const LIMBS: usize> MulAssign<&DynResidue<LIMBS>> for DynResidue<LIMBS>

§

fn mul_assign(&mut self, rhs: &DynResidue<LIMBS>)

Performs the *= operation. Read more
§

impl<const LIMBS: usize> MulAssign<DynResidue<LIMBS>> for DynResidue<LIMBS>

§

fn mul_assign(&mut self, rhs: DynResidue<LIMBS>)

Performs the *= operation. Read more
§

impl<const LIMBS: usize> Neg for &DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the - operator.
§

fn neg(self) -> DynResidue<LIMBS>

Performs the unary - operation. Read more
§

impl<const LIMBS: usize> Neg for DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the - operator.
§

fn neg(self) -> DynResidue<LIMBS>

Performs the unary - operation. Read more
§

impl<const LIMBS: usize> PartialEq<DynResidue<LIMBS>> for DynResidue<LIMBS>

§

fn eq(&self, other: &DynResidue<LIMBS>) -> bool

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

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

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

impl<const LIMBS: usize> PowBoundedExp<Uint<LIMBS>> for DynResidue<LIMBS>

§

fn pow_bounded_exp( &self, exponent: &Uint<LIMBS>, exponent_bits: usize ) -> DynResidue<LIMBS>

Raises to the exponent power, with exponent_bits representing the number of (least significant) bits to take into account for the exponent. Read more
§

impl<const LIMBS: usize> Retrieve for DynResidue<LIMBS>

§

type Output = Uint<LIMBS>

The original type.
§

fn retrieve(&self) -> <DynResidue<LIMBS> as Retrieve>::Output

Convert the number back from the optimized representation.
§

impl<const LIMBS: usize> Square for DynResidue<LIMBS>

§

fn square(&self) -> DynResidue<LIMBS>

Computes the same as self.mul(self), but may be more efficient.
§

impl<const LIMBS: usize> Sub<&DynResidue<LIMBS>> for &DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the - operator.
§

fn sub(self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the - operation. Read more
§

impl<const LIMBS: usize> Sub<&DynResidue<LIMBS>> for DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the - operator.
§

fn sub(self, rhs: &DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the - operation. Read more
§

impl<const LIMBS: usize> Sub<DynResidue<LIMBS>> for &DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the - operator.
§

fn sub(self, rhs: DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the - operation. Read more
§

impl<const LIMBS: usize> Sub<DynResidue<LIMBS>> for DynResidue<LIMBS>

§

type Output = DynResidue<LIMBS>

The resulting type after applying the - operator.
§

fn sub(self, rhs: DynResidue<LIMBS>) -> DynResidue<LIMBS>

Performs the - operation. Read more
§

impl<const LIMBS: usize> SubAssign<&DynResidue<LIMBS>> for DynResidue<LIMBS>

§

fn sub_assign(&mut self, rhs: &DynResidue<LIMBS>)

Performs the -= operation. Read more
§

impl<const LIMBS: usize> SubAssign<DynResidue<LIMBS>> for DynResidue<LIMBS>

§

fn sub_assign(&mut self, rhs: DynResidue<LIMBS>)

Performs the -= operation. Read more
§

impl<const LIMBS: usize> Copy for DynResidue<LIMBS>

§

impl<const LIMBS: usize> Eq for DynResidue<LIMBS>

§

impl<const LIMBS: usize> StructuralEq for DynResidue<LIMBS>

§

impl<const LIMBS: usize> StructuralPartialEq for DynResidue<LIMBS>

Auto Trait Implementations§

§

impl<const LIMBS: usize> RefUnwindSafe for DynResidue<LIMBS>

§

impl<const LIMBS: usize> Send for DynResidue<LIMBS>

§

impl<const LIMBS: usize> Sync for DynResidue<LIMBS>

§

impl<const LIMBS: usize> Unpin for DynResidue<LIMBS>

§

impl<const LIMBS: usize> UnwindSafe for DynResidue<LIMBS>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> Twhere Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for Twhere T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> Rwhere Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T, Exponent> Pow<Exponent> for Twhere T: PowBoundedExp<Exponent>, Exponent: Bounded,

§

fn pow(&self, exponent: &Exponent) -> T

Raises to the exponent power.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T, Rhs, Output> GroupOps<Rhs, Output> for Twhere T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>,

§

impl<T, Rhs, Output> GroupOpsOwned<Rhs, Output> for Twhere T: for<'r> GroupOps<&'r Rhs, Output>,

§

impl<T, Rhs, Output> ScalarMul<Rhs, Output> for Twhere T: Mul<Rhs, Output = Output> + MulAssign<Rhs>,

§

impl<T, Rhs, Output> ScalarMulOwned<Rhs, Output> for Twhere T: for<'r> ScalarMul<&'r Rhs, Output>,