Struct Modulus 

pub struct Modulus { /* private fields */ }

Structure encapsulating an integer modulus up to 62 bits.

Implementations

impl Modulus

pub fn new(p: u64) -> Result<Self>

Create a modulus from an integer of at most 62 bits.

pub const fn add(&self, a: u64, b: u64) -> u64

Performs the modular addition of a and b in constant time. Aborts if a >= p or b >= p in debug mode.

pub const unsafe fn add_vt(&self, a: u64, b: u64) -> u64

Performs the modular addition of a and b in variable time. Aborts if a >= p or b >= p in debug mode.

Safety

This function is not constant time and its timing may reveal information about the values being added.

pub const fn sub(&self, a: u64, b: u64) -> u64

Performs the modular subtraction of a and b in constant time. Aborts if a >= p or b >= p in debug mode.

pub const fn mul(&self, a: u64, b: u64) -> u64

Performs the modular multiplication of a and b in constant time. Aborts if a >= p or b >= p in debug mode.

pub const fn mul_opt(&self, a: u64, b: u64) -> u64

Optimized modular multiplication of a and b in constant time.

Aborts if a >= p or b >= p in debug mode.

pub const fn neg(&self, a: u64) -> u64

Modular negation in constant time.

Aborts if a >= p in debug mode.

pub const fn shoup(&self, a: u64) -> u64

Compute the Shoup representation of a.

Aborts if a >= p in debug mode.

pub const fn mul_shoup(&self, a: u64, b: u64, b_shoup: u64) -> u64

Shoup multiplication of a and b in constant time.

Aborts if b >= p or b_shoup != shoup(b) in debug mode.

pub const fn lazy_mul_shoup(&self, a: u64, b: u64, b_shoup: u64) -> u64

Lazy Shoup multiplication of a and b in constant time. The output is in the interval [0, 2 * p).

Aborts if b >= p or b_shoup != shoup(b) in debug mode.

pub fn add_vec(&self, a: &mut [u64], b: &[u64])

Modular addition of vectors in place in constant time.

Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

pub unsafe fn add_vec_vt(&self, a: &mut [u64], b: &[u64])

Modular addition of vectors in place in variable time. Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

Safety

This function is not constant time and its timing may reveal information about the values being added.

pub fn sub_vec(&self, a: &mut [u64], b: &[u64])

Modular subtraction of vectors in place in constant time.

Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

pub unsafe fn sub_vec_vt(&self, a: &mut [u64], b: &[u64])

Modular subtraction of vectors in place in variable time. Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

Safety

This function is not constant time and its timing may reveal information about the values being subtracted.

pub fn mul_vec(&self, a: &mut [u64], b: &[u64])

Modular multiplication of vectors in place in constant time.

Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

pub fn scalar_mul_vec(&self, a: &mut [u64], b: u64)

Modular scalar multiplication of vectors in place in constant time.

Aborts if any of the values in a is >= p in debug mode.

pub unsafe fn scalar_mul_vec_vt(&self, a: &mut [u64], b: u64)

Modular scalar multiplication of vectors in place in variable time. Aborts if any of the values in a is >= p in debug mode.

Safety

This function is not constant time and its timing may reveal information about the values being multiplied.

pub unsafe fn mul_vec_vt(&self, a: &mut [u64], b: &[u64])

Modular multiplication of vectors in place in variable time. Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

Safety

This function is not constant time and its timing may reveal information about the values being subtracted.

pub fn shoup_vec(&self, a: &[u64]) -> Vec<u64>

Compute the Shoup representation of a vector.

Aborts if any of the values of the vector is >= p in debug mode.

pub fn mul_shoup_vec(&self, a: &mut [u64], b: &[u64], b_shoup: &[u64])

Shoup modular multiplication of vectors in place in constant time.

Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

pub unsafe fn mul_shoup_vec_vt(&self, a: &mut [u64], b: &[u64], b_shoup: &[u64])

Shoup modular multiplication of vectors in place in variable time. Aborts if a and b differ in size, and if any of their values is >= p in debug mode.

Safety

This function is not constant time and its timing may reveal information about the values being multiplied.

pub fn reduce_vec(&self, a: &mut [u64])

Reduce a vector in place in constant time.

pub unsafe fn center_vec_vt(&self, a: &[u64]) -> Vec<i64>

Center a vector in variable time.

Safety

This function is not constant time and its timing may reveal information about the values being centered.

pub unsafe fn reduce_vec_vt(&self, a: &mut [u64])

Reduce a vector in place in variable time.

Safety

This function is not constant time and its timing may reveal information about the values being reduced.

pub fn reduce_vec_i64(&self, a: &[i64]) -> Vec<u64>

Reduce a vector in place in constant time.

pub unsafe fn reduce_vec_i64_vt(&self, a: &[i64]) -> Vec<u64>

Reduce a vector in place in variable time.

Safety

This function is not constant time and its timing may reveal information about the values being reduced.

pub fn reduce_vec_new(&self, a: &[u64]) -> Vec<u64>

Reduce a vector in constant time.

pub unsafe fn reduce_vec_new_vt(&self, a: &[u64]) -> Vec<u64>

Reduce a vector in variable time.

Safety

This function is not constant time and its timing may reveal information about the values being reduced.

pub fn neg_vec(&self, a: &mut [u64])

Modular negation of a vector in place in constant time.

Aborts if any of the values in the vector is >= p in debug mode.

pub unsafe fn neg_vec_vt(&self, a: &mut [u64])

Modular negation of a vector in place in variable time. Aborts if any of the values in the vector is >= p in debug mode.

Safety

This function is not constant time and its timing may reveal information about the values being negated.

pub fn pow(&self, a: u64, n: u64) -> u64

Modular exponentiation in variable time.

Aborts if a >= p or n >= p in debug mode.

pub fn inv(&self, a: u64) -> Option<u64>

Modular inversion in variable time.

Returns None if p is not prime or a = 0. Aborts if a >= p in debug mode.

pub const fn reduce_u128(&self, a: u128) -> u64

Modular reduction of a u128 in constant time.

pub const unsafe fn reduce_u128_vt(&self, a: u128) -> u64

Modular reduction of a u128 in variable time.

Safety

This function is not constant time and its timing may reveal information about the value being reduced.

pub const fn reduce(&self, a: u64) -> u64

Modular reduction of a u64 in constant time.

pub const unsafe fn reduce_vt(&self, a: u64) -> u64

Modular reduction of a u64 in variable time.

Safety

This function is not constant time and its timing may reveal information about the value being reduced.

pub const fn reduce_opt_u128(&self, a: u128) -> u64

Optimized modular reduction of a u128 in constant time.

pub const fn reduce_opt(&self, a: u64) -> u64

Optimized modular reduction of a u64 in constant time.

pub const unsafe fn reduce_opt_vt(&self, a: u64) -> u64

Optimized modular reduction of a u64 in variable time.

Safety

This function is not constant time and its timing may reveal information about the value being reduced.

pub const fn lazy_reduce_u128(&self, a: u128) -> u64

Lazy modular reduction of a in constant time. The output is in the interval [0, 2 * p).

pub const fn lazy_reduce(&self, a: u64) -> u64

Lazy modular reduction of a in constant time. The output is in the interval [0, 2 * p).

pub const fn lazy_reduce_opt_u128(&self, a: u128) -> u64

Lazy optimized modular reduction of a in constant time. The output is in the interval [0, 2 * p).

Aborts if the input is >= p ^ 2 in debug mode.

pub fn lazy_reduce_vec(&self, a: &mut [u64])

Lazy modular reduction of a vector in constant time. The output coefficients are in the interval [0, 2 * p).

pub fn random_vec<R: RngCore + CryptoRng>( &self, size: usize, rng: &mut R, ) -> Vec<u64>

Returns a random vector.

pub const fn serialization_length(&self, size: usize) -> usize

Length of the serialization of a vector of size size.

Panics if the size is not a multiple of 8.

pub fn serialize_vec(&self, a: &[u64]) -> Vec<u8>

Serialize a vector of elements of length a multiple of 8.

Panics if the length of the vector is not a multiple of 8.

pub fn deserialize_vec(&self, b: &[u8]) -> Vec<u64>

Deserialize a vector of bytes into a vector of elements mod p.

Methods from Deref<Target = u64>

pub const MIN: u64 = 0u64

pub const MAX: u64 = 18_446_744_073_709_551_615u64

pub const BITS: u32 = 64u32

Trait Implementations

impl Clone for Modulus

fn clone(&self) -> Modulus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modulus

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

Formats the value using the given formatter.

impl Deref for Modulus

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for Modulus

fn eq(&self, other: &Self) -> 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 Eq for Modulus