Integrate modulus in NTT structs

Author: jnsiemer

benches/ntt_multiplication.rs

@@ -12,8 +12,8 @@
 use criterion::*;
 use qfall_math::{
     integer_mod_q::{
-        MatNTTPolynomialRingZq, MatPolynomialRingZq, Modulus, ModulusPolynomialRingZq,
-        NTTPolynomialRingZq, PolyOverZq, PolynomialRingZq,
+        MatNTTPolynomialRingZq, MatPolynomialRingZq, ModulusPolynomialRingZq, NTTPolynomialRingZq,
+        PolyOverZq, PolynomialRingZq,
     },
     traits::*,
 };
@@ -52,7 +52,6 @@ pub fn get_hawk1024_setup() -> ModulusPolynomialRingZq {
 /// `n=256`, `q = 2^23 - 2^13 + 1` and `zeta = 1753`
 pub fn bench_ntt_dilithium_params_with_ntt(c: &mut Criterion) {
     let modulus = get_dilithium_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = PolynomialRingZq::sample_uniform(&modulus);
     let p2 = PolynomialRingZq::sample_uniform(&modulus);
@@ -62,15 +61,14 @@ pub fn bench_ntt_dilithium_params_with_ntt(c: &mut Criterion) {
 
     c.bench_function(
         "PolynomialRingZq Multiplication with NTT (Dilithium)",
-        |b| b.iter(|| ntt1.mul(&ntt2, &mod_q)),
+        |b| b.iter(|| &ntt1 * &ntt2),
     );
 }
 
 /// benchmark multiplication in typical dilithium parameter set with NTT & Transforms
 /// `n=256`, `q = 2^23 - 2^13 + 1` and `zeta = 1753`
 pub fn bench_ntt_dilithium_params_with_ntt_and_transforms(c: &mut Criterion) {
     let modulus = get_dilithium_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = PolynomialRingZq::sample_uniform(&modulus);
     let p2 = PolynomialRingZq::sample_uniform(&modulus);
@@ -82,9 +80,9 @@ pub fn bench_ntt_dilithium_params_with_ntt_and_transforms(c: &mut Criterion) {
                 let ntt1 = NTTPolynomialRingZq::from(&p1);
                 let ntt2 = NTTPolynomialRingZq::from(&p2);
 
-                let ntt_res = ntt1.mul(&ntt2, &mod_q);
+                let ntt_res = &ntt1 * &ntt2;
 
-                let _ = PolynomialRingZq::from((ntt_res, &modulus));
+                let _ = PolynomialRingZq::from(ntt_res);
             })
         },
     );
@@ -108,7 +106,6 @@ pub fn bench_ntt_dilithium_params_without_ntt(c: &mut Criterion) {
 /// `n=256`, `q = 12289` and `zeta = 1945`
 pub fn bench_ntt_hawk1024_params_with_ntt(c: &mut Criterion) {
     let modulus = get_hawk1024_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = PolynomialRingZq::sample_uniform(&modulus);
     let p2 = PolynomialRingZq::sample_uniform(&modulus);
@@ -117,15 +114,14 @@ pub fn bench_ntt_hawk1024_params_with_ntt(c: &mut Criterion) {
     let ntt2 = NTTPolynomialRingZq::from(&p2);
 
     c.bench_function("PolynomialRingZq Multiplication with NTT (HAWK1024)", |b| {
-        b.iter(|| ntt1.mul(&ntt2, &mod_q))
+        b.iter(|| &ntt1 * &ntt2)
     });
 }
 
 /// benchmark multiplication in typical HAWK1024 parameter set with NTT and Transforms
 /// `n=256`, `q = 12289` and `zeta = 1945`
 pub fn bench_ntt_hawk1024_params_with_ntt_and_transforms(c: &mut Criterion) {
     let modulus = get_hawk1024_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = PolynomialRingZq::sample_uniform(&modulus);
     let p2 = PolynomialRingZq::sample_uniform(&modulus);
@@ -137,9 +133,9 @@ pub fn bench_ntt_hawk1024_params_with_ntt_and_transforms(c: &mut Criterion) {
                 let ntt1 = NTTPolynomialRingZq::from(&p1);
                 let ntt2 = NTTPolynomialRingZq::from(&p2);
 
-                let ntt_res = ntt1.mul(&ntt2, &mod_q);
+                let ntt_res = &ntt1 * &ntt2;
 
-                let _ = PolynomialRingZq::from((ntt_res, &modulus));
+                let _ = PolynomialRingZq::from(ntt_res);
             })
         },
     );
@@ -163,7 +159,6 @@ pub fn bench_ntt_hawk1024_params_without_ntt(c: &mut Criterion) {
 /// `n=256`, `q = 2^23 - 2^13 + 1` and `zeta = 1753`
 pub fn bench_mat_ntt_dilithium_params_with_ntt(c: &mut Criterion) {
     let modulus = get_dilithium_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = MatPolynomialRingZq::sample_uniform(4, 4, &modulus);
     let p2 = MatPolynomialRingZq::sample_uniform(4, 1, &modulus);
@@ -173,15 +168,14 @@ pub fn bench_mat_ntt_dilithium_params_with_ntt(c: &mut Criterion) {
 
     c.bench_function(
         "MatPolynomialRingZq Multiplication with NTT (Dilithium)",
-        |b| b.iter(|| ntt1.mul(&ntt2, &mod_q)),
+        |b| b.iter(|| &ntt1 * &ntt2),
     );
 }
 
 /// benchmark multiplication in typical dilithium parameter set with NTT & Transforms
 /// `n=256`, `q = 2^23 - 2^13 + 1` and `zeta = 1753`
 pub fn bench_mat_ntt_dilithium_params_with_ntt_and_transforms(c: &mut Criterion) {
     let modulus = get_dilithium_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = MatPolynomialRingZq::sample_uniform(4, 4, &modulus);
     let p2 = MatPolynomialRingZq::sample_uniform(4, 1, &modulus);
@@ -193,9 +187,9 @@ pub fn bench_mat_ntt_dilithium_params_with_ntt_and_transforms(c: &mut Criterion)
                 let ntt1 = MatNTTPolynomialRingZq::from(&p1);
                 let ntt2 = MatNTTPolynomialRingZq::from(&p2);
 
-                let mut ntt_res = ntt1.mul(&ntt2, &mod_q);
+                let mut ntt_res = &ntt1 * &ntt2;
 
-                let _ = MatPolynomialRingZq::from((&mut ntt_res, &modulus));
+                let _ = MatPolynomialRingZq::from(&mut ntt_res);
             })
         },
     );
@@ -219,7 +213,6 @@ pub fn bench_mat_ntt_dilithium_params_without_ntt(c: &mut Criterion) {
 /// `n=256`, `q = 12289` and `zeta = 1945`
 pub fn bench_mat_ntt_hawk1024_params_with_ntt(c: &mut Criterion) {
     let modulus = get_hawk1024_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = MatPolynomialRingZq::sample_uniform(1, 2, &modulus);
     let p2 = MatPolynomialRingZq::sample_uniform(2, 2, &modulus);
@@ -229,15 +222,14 @@ pub fn bench_mat_ntt_hawk1024_params_with_ntt(c: &mut Criterion) {
 
     c.bench_function(
         "MatPolynomialRingZq Multiplication with NTT (HAWK1024)",
-        |b| b.iter(|| ntt1.mul(&ntt2, &mod_q)),
+        |b| b.iter(|| &ntt1 * &ntt2),
     );
 }
 
 /// benchmark multiplication in typical HAWK1024 parameter set with NTT and Transforms
 /// `n=256`, `q = 12289` and `zeta = 1945`
 pub fn bench_mat_ntt_hawk1024_params_with_ntt_and_transforms(c: &mut Criterion) {
     let modulus = get_hawk1024_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = MatPolynomialRingZq::sample_uniform(2, 2, &modulus);
     let p2 = MatPolynomialRingZq::sample_uniform(2, 1, &modulus);
@@ -249,9 +241,9 @@ pub fn bench_mat_ntt_hawk1024_params_with_ntt_and_transforms(c: &mut Criterion)
                 let ntt1 = MatNTTPolynomialRingZq::from(&p1);
                 let ntt2 = MatNTTPolynomialRingZq::from(&p2);
 
-                let mut ntt_res = ntt1.mul(&ntt2, &mod_q);
+                let mut ntt_res = &ntt1 * &ntt2;
 
-                let _ = MatPolynomialRingZq::from((&mut ntt_res, &modulus));
+                let _ = MatPolynomialRingZq::from(&mut ntt_res);
             })
         },
     );
@@ -291,7 +283,6 @@ pub fn get_rbe_setup() -> ModulusPolynomialRingZq {
 /// `n=256`, `q = 12289` and `zeta = 1945`
 pub fn bench_mat_ntt_rbe_params_with_ntt(c: &mut Criterion) {
     let modulus = get_rbe_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = MatPolynomialRingZq::sample_uniform(1, 2, &modulus);
     let p2 = MatPolynomialRingZq::sample_uniform(2, 12, &modulus);
@@ -300,15 +291,14 @@ pub fn bench_mat_ntt_rbe_params_with_ntt(c: &mut Criterion) {
     let ntt2 = MatNTTPolynomialRingZq::from(&p2);
 
     c.bench_function("MatPolynomialRingZq Multiplication with NTT (RBE)", |b| {
-        b.iter(|| ntt1.mul(&ntt2, &mod_q))
+        b.iter(|| &ntt1 * &ntt2)
     });
 }
 
 /// benchmark multiplication in typical RBE parameter set with NTT and Transforms
 /// `n=256`, `q = 12289` and `zeta = 1945`
 pub fn bench_mat_ntt_rbe_params_with_ntt_and_transforms(c: &mut Criterion) {
     let modulus = get_rbe_setup();
-    let mod_q = Modulus::from(modulus.get_q());
 
     let p1 = MatPolynomialRingZq::sample_uniform(1, 2, &modulus);
     let p2 = MatPolynomialRingZq::sample_uniform(2, 12, &modulus);
@@ -320,9 +310,9 @@ pub fn bench_mat_ntt_rbe_params_with_ntt_and_transforms(c: &mut Criterion) {
                 let ntt1 = MatNTTPolynomialRingZq::from(&p1);
                 let ntt2 = MatNTTPolynomialRingZq::from(&p2);
 
-                let mut ntt_res = ntt1.mul(&ntt2, &mod_q);
+                let mut ntt_res = &ntt1 * &ntt2;
 
-                let _ = MatPolynomialRingZq::from((&mut ntt_res, &modulus));
+                let _ = MatPolynomialRingZq::from(&mut ntt_res);
             })
         },
     );

src/integer_mod_q/mat_ntt_polynomial_ring_zq.rs

@@ -8,7 +8,7 @@
 
 //! [`MatNTTPolynomialRingZq`] containts the NTT representations of matrices over polynomials.
 
-use crate::integer::Z;
+use crate::{integer::Z, integer_mod_q::ModulusPolynomialRingZq};
 use derive_more::Display;
 use serde::{Deserialize, Serialize};
 use std::fmt;
@@ -25,36 +25,41 @@ mod sample;
 ///
 /// Attributes
 /// - `matrix`: holds the matrix entries with its coefficients
+/// - `nr_rows`: the number of rows of the matrix
+/// - `nr_columns`: the number of columns of the matrix
+/// - `modulus`: the [`ModulusPolynomialRingZq`] defining the modulus `q`, the ring `Z_q[X]/f(X)`, and
+///   the NTT transform [`NTTBasisPolynomialRingZq`](crate::integer_mod_q::NTTBasisPolynomialRingZq)
 ///
 /// # Examples
 /// ```
 /// use qfall_math::integer_mod_q::{Modulus, MatPolynomialRingZq, MatNTTPolynomialRingZq, ModulusPolynomialRingZq};
 /// use std::str::FromStr;
 ///
-/// // sample random matrix
-/// let mat_rnd = MatNTTPolynomialRingZq::sample_uniform(2, 2, 4, 257);
-/// // or instantiate matrix from MatPolynomialRingZq
+/// // setup modulus with ability to transform to NTT
 /// let mut modulus = ModulusPolynomialRingZq::from_str("5  1 0 0 0 1 mod 257").unwrap();
 /// modulus.set_ntt_unchecked(64);
+///
+/// // sample random matrix
+/// let mat_rnd = MatNTTPolynomialRingZq::sample_uniform(2, 2, &modulus);
+/// // or instantiate matrix from MatPolynomialRingZq
 /// let mat_poly_ring = MatPolynomialRingZq::identity(2, 2, &modulus);
 /// let mat_ntt_poly_ring = MatNTTPolynomialRingZq::from(&mat_poly_ring);
 ///
 /// // multiply, add and subtract objects
-/// let mod_q = Modulus::from(modulus.get_q());
-/// let mut tmp_mat_ntt = mat_ntt_poly_ring.mul(&mat_rnd, &mod_q);
-/// tmp_mat_ntt.add_assign(&mat_rnd, &mod_q);
-/// tmp_mat_ntt.sub_assign(&mat_rnd, &mod_q);
+/// let mut tmp_mat_ntt = mat_ntt_poly_ring * &mat_rnd;
+/// tmp_mat_ntt += &mat_rnd;
+/// tmp_mat_ntt -= &mat_rnd;
 ///
 /// // Return to MatPolynomialRingZq
-/// let res = MatPolynomialRingZq::from((&mut tmp_mat_ntt, &modulus));
+/// let res = tmp_mat_ntt.inv_ntt();
 /// ```
 #[derive(PartialEq, Eq, Serialize, Deserialize, Display, Clone)]
-#[display("{}", print_vec_z(&self.matrix))]
+#[display("{} / {}", print_vec_z(&self.matrix), self.modulus)]
 pub struct MatNTTPolynomialRingZq {
     pub matrix: Vec<Z>,
-    pub d: usize, // modulus degree
     pub nr_rows: usize,
     pub nr_columns: usize,
+    pub modulus: ModulusPolynomialRingZq,
 }
 
 impl fmt::Debug for MatNTTPolynomialRingZq {
@@ -65,8 +70,8 @@ impl fmt::Debug for MatNTTPolynomialRingZq {
 
         write!(
             f,
-            "MatNTTPolynomialRingZq {{matrix: {}, d: {}, nr_rows: {}, nr_columns: {} storage: {{matrix: {:?}}}}}",
-            short_print, self.d, self.nr_rows, self.nr_columns, self.matrix
+            "MatNTTPolynomialRingZq {{matrix: {}, nr_rows: {}, nr_columns: {}, modulus: {}, storage: {{matrix: {:?}, modulus: {:?}}}}}",
+            short_print, self.nr_rows, self.nr_columns, self.modulus, self.matrix, self.modulus
         )
     }
 }
@@ -75,7 +80,7 @@ impl fmt::Debug for MatNTTPolynomialRingZq {
 pub(crate) fn print_vec_z(vector: &Vec<Z>) -> String {
     let mut out = String::new();
     for v in vector {
-        out.push_str(&format!("{}, ", v.to_string()));
+        out.push_str(&format!("{}, ", v));
     }
     // Remove last whitespace and comma
     out.pop().unwrap();