From 2164b542b41bdf684f27f1460ba824a7c33e3b20 Mon Sep 17 00:00:00 2001
From: maramihali <mihalimara22@gmail.com>
Date: Wed, 22 Mar 2023 18:49:55 +0000
Subject: [PATCH] Documentation #31

---
 src/r1csinstance.rs  |  5 +++++
 src/sparse_mlpoly.rs | 13 +++++++++++++
 2 files changed, 18 insertions(+)

diff --git a/src/r1csinstance.rs b/src/r1csinstance.rs
index ede46c1b..c961b436 100644
--- a/src/r1csinstance.rs
+++ b/src/r1csinstance.rs
@@ -314,6 +314,9 @@ impl<F: PrimeField> R1CSInstance<F> {
     &self,
     gens: &R1CSCommitmentGens<E>,
   ) -> (R1CSCommitment<E::G1>, R1CSDecommitment<F>) {
+    // Noting that matrices A, B and C are sparse, produces a combined dense
+    // dense polynomial from the non-zero entry that we commit to. This
+    // represents the computational commitment.
     let (comm, dense) = SparseMatPolynomial::multi_commit(&[&self.A, &self.B, &self.C], &gens.gens);
     let r1cs_comm = R1CSCommitment {
       num_cons: self.num_cons,
@@ -322,6 +325,8 @@ impl<F: PrimeField> R1CSInstance<F> {
       comm,
     };
 
+    // The decommitment is used by the prover to convince the verifier
+    // the received openings of A, B and C are correct.
     let r1cs_decomm = R1CSDecommitment { dense };
 
     (r1cs_comm, r1cs_decomm)
diff --git a/src/sparse_mlpoly.rs b/src/sparse_mlpoly.rs
index c3340067..17f6aa09 100644
--- a/src/sparse_mlpoly.rs
+++ b/src/sparse_mlpoly.rs
@@ -20,6 +20,8 @@ use ark_serialize::*;
 use core::cmp::Ordering;
 
 #[derive(Debug, CanonicalSerialize, CanonicalDeserialize, Clone)]
+// Each SparseMatEntry is a tuple (row, col, val) representing a non-zero value
+// in an R1CS  matrix.
 pub struct SparseMatEntry<F: PrimeField> {
   row: usize,
   col: usize,
@@ -33,9 +35,11 @@ impl<F: PrimeField> SparseMatEntry<F> {
 }
 
 #[derive(Debug, CanonicalSerialize, CanonicalDeserialize, Clone)]
+// The sparse multilinearrepresentation of an R1CS matrix of size x*y
 pub struct SparseMatPolynomial<F: PrimeField> {
   num_vars_x: usize,
   num_vars_y: usize,
+  // The non-zero entries in the matrix, represented by the tuple (row, col,val)
   M: Vec<SparseMatEntry<F>>,
 }
 
@@ -346,6 +350,7 @@ impl<F: PrimeField> SparseMatPolynomial<F> {
     }
   }
 
+  // get the number of non_zero entries in a sparse R1CS matrix
   pub fn get_num_nz_entries(&self) -> usize {
     self.M.len().next_power_of_two()
   }
@@ -364,6 +369,7 @@ impl<F: PrimeField> SparseMatPolynomial<F> {
     (ops_row, ops_col, val)
   }
 
+  // Produce the dense representation of sparse matrices A, B and C.
   fn multi_sparse_to_dense_rep(
     sparse_polys: &[&SparseMatPolynomial<F>],
   ) -> MultiSparseMatPolynomialAsDense<F> {
@@ -384,11 +390,17 @@ impl<F: PrimeField> SparseMatPolynomial<F> {
     let mut val_vec: Vec<DensePolynomial<F>> = Vec::new();
     for poly in sparse_polys {
       let (ops_row, ops_col, val) = poly.sparse_to_dense_vecs(N);
+      // aggregate all the row and columns that contain non-zero values in the
+      // three matrices
       ops_row_vec.push(ops_row);
       ops_col_vec.push(ops_col);
+      // create dense polynomials, in Lagrange representation, for the non-zero
+      // values of each matrix
       val_vec.push(DensePolynomial::new(val));
     }
 
+    // Note: everything else from
+
     let any_poly = &sparse_polys[0];
 
     let num_mem_cells = if any_poly.num_vars_x > any_poly.num_vars_y {
@@ -401,6 +413,7 @@ impl<F: PrimeField> SparseMatPolynomial<F> {
     let col = AddrTimestamps::new(num_mem_cells, N, ops_col_vec);
 
     // combine polynomials into a single polynomial for commitment purposes
+    // this is done because the commitment used has a public setup
     let comb_ops = DensePolynomial::merge(
       row
         .ops_addr