From 7a24f7d081dc0e1a1342c0ea108d3961551fdd36 Mon Sep 17 00:00:00 2001
From: M Alghazwi <m.ghazwi@gmail.com>
Date: Tue, 5 Nov 2024 13:19:00 +0100
Subject: [PATCH] add testing params

---
 .../src/proof_input/gen_input.rs              |  2 +
 .../src/proof_input/test_params.rs            | 93 ++++++++++++++++++-
 2 files changed, 94 insertions(+), 1 deletion(-)

diff --git a/codex-plonky2-circuits/src/proof_input/gen_input.rs b/codex-plonky2-circuits/src/proof_input/gen_input.rs
index c3b2685..eb14e81 100644
--- a/codex-plonky2-circuits/src/proof_input/gen_input.rs
+++ b/codex-plonky2-circuits/src/proof_input/gen_input.rs
@@ -355,6 +355,7 @@ mod tests {
     use crate::circuits::sample_cells::{CircuitParams, DatasetTreeCircuit, SampleCircuitInput};
     use crate::proof_input::test_params::{D, C, F, H, N_SLOTS};
 
+    // test sample cells (non-circuit)
     #[test]
     fn test_sample_cells() {
         let dataset_t = DatasetTree::<F, D>::new_for_testing();
@@ -365,6 +366,7 @@ mod tests {
         assert_eq!(res, true);
     }
 
+    // test sample cells in-circuit for a selected slot
     #[test]
     fn test_sample_cells_circuit_from_selected_slot() -> anyhow::Result<()> {
 
diff --git a/codex-plonky2-circuits/src/proof_input/test_params.rs b/codex-plonky2-circuits/src/proof_input/test_params.rs
index 1820fdf..7292143 100644
--- a/codex-plonky2-circuits/src/proof_input/test_params.rs
+++ b/codex-plonky2-circuits/src/proof_input/test_params.rs
@@ -23,9 +23,100 @@ pub const ENTROPY: usize = 1234567; // external randomness
 pub const SEED: usize = 12345; // seed for creating fake data TODO: not used now
 
 pub const N_SLOTS: usize = 8; // number of slots in the dataset
-pub const TESTING_SLOT_INDEX: usize = 2; //the index of the slot to be sampled
+pub const TESTING_SLOT_INDEX: usize = 2; // the index of the slot to be sampled
 pub const N_CELLS: usize = 512; // number of cells in each slot
 
+/// Params struct
+pub struct Params {
+    pub max_depth: usize,
+    pub max_slots: usize,
+    pub cell_size: usize,
+    pub block_size: usize,
+    pub n_samples: usize,
+    pub entropy: usize,
+    pub seed: usize,
+    pub n_slots: usize,
+    pub testing_slot_index: usize,
+    pub n_cells: usize,
+}
+
+/// Implement the Default trait for Params using the hardcoded constants
+impl Default for Params {
+    fn default() -> Self {
+        Params {
+            max_depth: MAX_DEPTH,
+            max_slots: MAX_SLOTS,
+            cell_size: CELL_SIZE,
+            block_size: BLOCK_SIZE,
+            n_samples: N_SAMPLES,
+            entropy: ENTROPY,
+            seed: SEED,
+            n_slots: N_SLOTS,
+            testing_slot_index: TESTING_SLOT_INDEX,
+            n_cells: N_CELLS,
+        }
+    }
+}
+
+/// Implement a new function to create Params with custom values
+impl Params {
+    pub fn new(
+        max_depth: usize,
+        max_slots: usize,
+        cell_size: usize,
+        block_size: usize,
+        n_samples: usize,
+        entropy: usize,
+        seed: usize,
+        n_slots: usize,
+        testing_slot_index: usize,
+        n_cells: usize,
+    ) -> Self {
+        Params {
+            max_depth,
+            max_slots,
+            cell_size,
+            block_size,
+            n_samples,
+            entropy,
+            seed,
+            n_slots,
+            testing_slot_index,
+            n_cells,
+        }
+    }
+    // GOLDILOCKS_F_SIZE
+    pub fn goldilocks_f_size(&self) -> usize {
+        64
+    }
+
+    // N_FIELD_ELEMS_PER_CELL
+    pub fn n_field_elems_per_cell(&self) -> usize {
+        self.cell_size * 8 / self.goldilocks_f_size()
+    }
+
+    // BOT_DEPTH
+    pub fn bot_depth(&self) -> usize {
+        (self.block_size / self.cell_size).ilog2() as usize
+    }
+
+    // N_CELLS_IN_BLOCKS
+    pub fn n_cells_in_blocks(&self) -> usize {
+        1 << self.bot_depth()
+    }
+
+    // N_BLOCKS
+    pub fn n_blocks(&self) -> usize {
+        1 << (self.max_depth - self.bot_depth())
+    }
+
+    // DATASET_DEPTH
+    pub fn dataset_depth(&self) -> usize {
+        self.max_slots.ilog2() as usize
+    }
+}
+
+
 // computed constants
 pub const GOLDILOCKS_F_SIZE: usize = 64;
 pub const N_FIELD_ELEMS_PER_CELL: usize = CELL_SIZE * 8 / GOLDILOCKS_F_SIZE;