Skip to main content

FixedTrinomialSolinas32

Struct FixedTrinomialSolinas32 

Source
pub struct FixedTrinomialSolinas32<const P1: u8, const P2: u8, const K: i32>();
Expand description

A modular reducer for trinomial Solinas numbers 2^P1 - 2^P2 + K as modulus with 32-bit operands.

Supports P1 up to 31, P2 < P1, and odd signed K with |K| < 2^P2. All inputs and outputs are u32. The modulus 2^P1 - 2^P2 + K must be prime for modular inverse and Fermat-based operations to be valid.

§Example

use num_modular::{FixedTrinomialSolinas32, Reducer};

const P1: u8 = 4;
const P2: u8 = 2;
const K: i32 = 1;
let modulus = (1u32 << P1) - (1u32 << P2) + (K as u32); // 2^4 - 2^2 + 1 = 13
let reducer = FixedTrinomialSolinas32::<P1, P2, K>::new(&modulus);
let a = reducer.transform(3);
let b = reducer.transform(5);
assert_eq!(reducer.residue(reducer.add(&a, &b)), 8);

Implementations§

Source§

impl<const P1: u8, const P2: u8, const K: i32> FixedTrinomialSolinas32<P1, P2, K>

Source

pub const MODULUS: u32

Trait Implementations§

Source§

impl<const P1: u8, const P2: u8, const K: i32> Clone for FixedTrinomialSolinas32<P1, P2, K>

Source§

fn clone(&self) -> FixedTrinomialSolinas32<P1, P2, K>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const P1: u8, const P2: u8, const K: i32> Copy for FixedTrinomialSolinas32<P1, P2, K>

Source§

impl<const P1: u8, const P2: u8, const K: i32> Debug for FixedTrinomialSolinas32<P1, P2, K>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const P1: u8, const P2: u8, const K: i32> Reducer<u32> for FixedTrinomialSolinas32<P1, P2, K>

Source§

fn new(m: &u32) -> Self

Create a reducer for a modulus m
Source§

fn transform(&self, target: u32) -> u32

Transform a normal integer into reduced form
Source§

fn check(&self, target: &u32) -> bool

Check whether target is a valid reduced form
Source§

fn residue(&self, target: u32) -> u32

Transform a reduced form back to normal integer
Source§

fn modulus(&self) -> u32

Get the modulus in original integer type
Source§

fn is_zero(&self, target: &u32) -> bool

Test if the residue() == 0
Source§

fn add(&self, lhs: &u32, rhs: &u32) -> u32

Calculate (lhs + rhs) mod m in reduced form
Source§

fn sub(&self, lhs: &u32, rhs: &u32) -> u32

Calculate (lhs - rhs) mod m in reduced form
Source§

fn dbl(&self, target: u32) -> u32

Calculate 2*target mod m
Source§

fn neg(&self, target: u32) -> u32

Calculate -monty mod m in reduced form
Source§

fn mul(&self, lhs: &u32, rhs: &u32) -> u32

Calculate (lhs * rhs) mod m in reduced form
Source§

fn inv(&self, target: u32) -> Option<u32>

Calculate target^-1 mod m in reduced form, it may return None when there is no modular inverse.
Source§

fn sqr(&self, target: u32) -> u32

Calculate target^2 mod m in reduced form
Source§

fn pow(&self, base: u32, exp: &u32) -> u32

Calculate base ^ exp mod m in reduced form
Source§

fn add_in_place(&self, lhs: &mut T, rhs: &T)

Source§

fn sub_in_place(&self, lhs: &mut T, rhs: &T)

Source§

fn mul_in_place(&self, lhs: &mut T, rhs: &T)

Auto Trait Implementations§

§

impl<const P1: u8, const P2: u8, const K: i32> Freeze for FixedTrinomialSolinas32<P1, P2, K>

§

impl<const P1: u8, const P2: u8, const K: i32> RefUnwindSafe for FixedTrinomialSolinas32<P1, P2, K>

§

impl<const P1: u8, const P2: u8, const K: i32> Send for FixedTrinomialSolinas32<P1, P2, K>

§

impl<const P1: u8, const P2: u8, const K: i32> Sync for FixedTrinomialSolinas32<P1, P2, K>

§

impl<const P1: u8, const P2: u8, const K: i32> Unpin for FixedTrinomialSolinas32<P1, P2, K>

§

impl<const P1: u8, const P2: u8, const K: i32> UnsafeUnpin for FixedTrinomialSolinas32<P1, P2, K>

§

impl<const P1: u8, const P2: u8, const K: i32> UnwindSafe for FixedTrinomialSolinas32<P1, P2, K>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.