refactor!: Drop “generic” if no counterpart exists

jan-ferdinand · jan-ferdinand · commit 10263084da0d · 2025-01-30T13:33:28.000+01:00
diff --git a/tasm-lib/benchmarks/tasmlib_hashing_merkle_root_from_xfes.json b/tasm-lib/benchmarks/tasmlib_hashing_merkle_root_from_xfes.json
@@ -1,6 +1,6 @@
 [
   {
-    "name": "tasmlib_hashing_merkle_root_from_xfes_generic",
+    "name": "tasmlib_hashing_merkle_root_from_xfes",
     "benchmark_result": {
       "clock_cycle_count": 7236,
       "hash_table_height": 3234,
@@ -11,7 +11,7 @@
     "case": "CommonCase"
   },
   {
-    "name": "tasmlib_hashing_merkle_root_from_xfes_generic",
+    "name": "tasmlib_hashing_merkle_root_from_xfes",
     "benchmark_result": {
       "clock_cycle_count": 14173,
       "hash_table_height": 6306,
diff --git a/tasm-lib/src/arithmetic/xfe.rs b/tasm-lib/src/arithmetic/xfe.rs
@@ -1,2 +1,2 @@
-pub mod mod_pow_u32_generic;
+pub mod mod_pow_u32;
 pub mod to_the_power_of_power_of_2;
diff --git a/tasm-lib/src/arithmetic/xfe/mod_pow_u32.rs b/tasm-lib/src/arithmetic/xfe/mod_pow_u32.rs
@@ -3,9 +3,9 @@ use triton_vm::prelude::*;
 use crate::prelude::*;
 
 #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
-pub struct XfeModPowU32Generic;
+pub struct XfeModPowU32;
 
-impl BasicSnippet for XfeModPowU32Generic {
+impl BasicSnippet for XfeModPowU32 {
     fn inputs(&self) -> Vec<(DataType, String)> {
         vec![
             (DataType::U32, "exponent".to_owned()),
@@ -149,7 +149,7 @@ pub mod tests {
     use crate::execute_with_terminal_state;
     use crate::test_prelude::*;
 
-    impl Closure for XfeModPowU32Generic {
+    impl Closure for XfeModPowU32 {
         type Args = (u32, XFieldElement);
 
         fn rust_shadow(&self, stack: &mut Vec<BFieldElement>) {
@@ -185,15 +185,15 @@ pub mod tests {
 
     #[test]
     fn mod_pow_u32_xfe_pbt() {
-        ShadowedClosure::new(XfeModPowU32Generic).test()
+        ShadowedClosure::new(XfeModPowU32).test()
     }
 
     #[test]
     fn verify_crash_if_exponent_not_u32() {
         let bfe_14 = BFieldElement::new(14);
         let xfe_14 = XFieldElement::new([bfe_14, bfe_14, bfe_14]);
         let xfe_14: Vec<_> = xfe_14.coefficients.into_iter().rev().collect();
-        let code = XfeModPowU32Generic.link_for_isolated_run();
+        let code = XfeModPowU32.link_for_isolated_run();
 
         for exponent in [
             1 << 32,
@@ -226,6 +226,6 @@ mod benches {
 
     #[test]
     fn benchmark() {
-        ShadowedClosure::new(XfeModPowU32Generic).bench();
+        ShadowedClosure::new(XfeModPowU32).bench();
     }
 }
diff --git a/tasm-lib/src/arithmetic/xfe/to_the_power_of_power_of_2.rs b/tasm-lib/src/arithmetic/xfe/to_the_power_of_power_of_2.rs
@@ -93,7 +93,7 @@ mod tests {
     use twenty_first::math::traits::ModPowU32;
 
     use super::*;
-    use crate::arithmetic::xfe::mod_pow_u32_generic::XfeModPowU32Generic;
+    use crate::arithmetic::xfe::mod_pow_u32::XfeModPowU32;
     use crate::test_prelude::*;
 
     impl Closure for ToThePowerOfPowerOf2 {
@@ -149,8 +149,8 @@ mod tests {
             .stack;
 
             let final_generic_stack = test_rust_equivalence_given_complete_state(
-                &ShadowedClosure::new(XfeModPowU32Generic),
-                &XfeModPowU32Generic.set_up_test_stack((2_u32.pow(log_2_exponent), base)),
+                &ShadowedClosure::new(XfeModPowU32),
+                &XfeModPowU32.set_up_test_stack((2_u32.pow(log_2_exponent), base)),
                 &[],
                 &NonDeterminism::default(),
                 &None,
diff --git a/tasm-lib/src/assertion_error_ids.md b/tasm-lib/src/assertion_error_ids.md
@@ -26,7 +26,7 @@ often.
 |    60..70 | [`MemCpy`](memory/memcpy.rs)                                                                |
 |    70..80 | [`DynMalloc`](memory/dyn_malloc.rs)                                                         |
 |    80..90 | [`SplitOff`](list/split_off.rs)                                                             |
-|   90..100 | [`MerkleRootFromXfesGeneric`](hashing/merkle_root_from_xfes_generic.rs)                     |
+|   90..100 | [`MerkleRootFromXfes`](hashing/merkle_root_from_xfes.rs)                                    |
 |  100..110 | [`SafeMulU64`](arithmetic/u64/safe_mul.rs)                                                  |
 |  110..120 | [`u64::Decr`](arithmetic/u64/decr.rs)                                                       |
 |  120..130 | [`Safepow`](arithmetic/u32/safe_pow.rs)                                                     |
diff --git a/tasm-lib/src/exported_snippets.rs b/tasm-lib/src/exported_snippets.rs
@@ -217,8 +217,8 @@ pub fn name_to_snippet(fn_name: &str) -> Option<Box<dyn BasicSnippet>> {
             Some(Box::new(hashing::absorb_multiple::AbsorbMultiple))
         }
         "tasmlib_hashing_merkle_root" => Some(Box::new(hashing::merkle_root::MerkleRoot)),
-        "tasmlib_hashing_merkle_root_from_xfes_generic" => Some(Box::new(
-            hashing::merkle_root_from_xfes_generic::MerkleRootFromXfesGeneric,
+        "tasmlib_hashing_merkle_root_from_xfes" => Some(Box::new(
+            hashing::merkle_root_from_xfes::MerkleRootFromXfes,
         )),
         "tasmlib_hashing_merkle_step_mem_u64_index" => {
             Some(Box::new(hashing::merkle_step_mem_u64_index::MerkleStepMemU64Index))
diff --git a/tasm-lib/src/hashing.rs b/tasm-lib/src/hashing.rs
@@ -4,7 +4,7 @@ pub mod algebraic_hasher;
 pub mod hash_from_stack;
 pub mod lt_digest;
 pub mod merkle_root;
-pub mod merkle_root_from_xfes_generic;
+pub mod merkle_root_from_xfes;
 pub mod merkle_step_mem_u64_index;
 pub mod merkle_step_u64_index;
 pub mod merkle_verify;
diff --git a/tasm-lib/src/hashing/merkle_root_from_xfes.rs b/tasm-lib/src/hashing/merkle_root_from_xfes.rs
@@ -8,9 +8,9 @@ use crate::prelude::*;
 /// The input list must have a length that is a power of two
 /// and is not one. Can otherwise handle any length.
 #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
-pub struct MerkleRootFromXfesGeneric;
+pub struct MerkleRootFromXfes;
 
-impl BasicSnippet for MerkleRootFromXfesGeneric {
+impl BasicSnippet for MerkleRootFromXfes {
     fn inputs(&self) -> Vec<(DataType, String)> {
         vec![(
             DataType::List(Box::new(DataType::Xfe)),
@@ -23,7 +23,7 @@ impl BasicSnippet for MerkleRootFromXfesGeneric {
     }
 
     fn entrypoint(&self) -> String {
-        "tasmlib_hashing_merkle_root_from_xfes_generic".to_string()
+        "tasmlib_hashing_merkle_root_from_xfes".to_string()
     }
 
     fn code(&self, library: &mut Library) -> Vec<LabelledInstruction> {
@@ -185,7 +185,7 @@ mod tests {
     use crate::test_helpers::test_assertion_failure;
     use crate::test_prelude::*;
 
-    impl Function for MerkleRootFromXfesGeneric {
+    impl Function for MerkleRootFromXfes {
         fn rust_shadow(
             &self,
             stack: &mut Vec<BFieldElement>,
@@ -252,7 +252,7 @@ mod tests {
         }
     }
 
-    impl MerkleRootFromXfesGeneric {
+    impl MerkleRootFromXfes {
         fn init_state(
             &self,
             xfes: Vec<XFieldElement>,
@@ -270,14 +270,14 @@ mod tests {
 
     #[test]
     fn test() {
-        ShadowedFunction::new(MerkleRootFromXfesGeneric).test()
+        ShadowedFunction::new(MerkleRootFromXfes).test()
     }
 
     #[test]
     fn cannot_handle_input_list_of_length_one() {
-        let height_0 = MerkleRootFromXfesGeneric.init_state(xfe_vec![1], bfe!(0));
+        let height_0 = MerkleRootFromXfes.init_state(xfe_vec![1], bfe!(0));
         test_assertion_failure(
-            &ShadowedFunction::new(MerkleRootFromXfesGeneric),
+            &ShadowedFunction::new(MerkleRootFromXfes),
             InitVmState::with_stack_and_memory(height_0.stack, height_0.memory),
             &[91],
         );
@@ -286,9 +286,9 @@ mod tests {
     #[test]
     fn cannot_handle_input_list_of_length_not_pow2() {
         for bad_length in [3, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 17] {
-            let init_state = MerkleRootFromXfesGeneric.init_state(xfe_vec![1; bad_length], bfe!(0));
+            let init_state = MerkleRootFromXfes.init_state(xfe_vec![1; bad_length], bfe!(0));
             test_assertion_failure(
-                &ShadowedFunction::new(MerkleRootFromXfesGeneric),
+                &ShadowedFunction::new(MerkleRootFromXfes),
                 InitVmState::with_stack_and_memory(init_state.stack, init_state.memory),
                 &[90],
             );
@@ -303,6 +303,6 @@ mod benches {
 
     #[test]
     fn benchmark() {
-        ShadowedFunction::new(MerkleRootFromXfesGeneric).bench()
+        ShadowedFunction::new(MerkleRootFromXfes).bench()
     }
 }
diff --git a/tasm-lib/src/verifier/fri/verify.rs b/tasm-lib/src/verifier/fri/verify.rs
@@ -19,7 +19,7 @@ use crate::data_type::StructType;
 use crate::field;
 use crate::hashing::algebraic_hasher::sample_indices::SampleIndices;
 use crate::hashing::algebraic_hasher::sample_scalars_static_length_dyn_malloc::SampleScalarsStaticLengthDynMalloc;
-use crate::hashing::merkle_root_from_xfes_generic::MerkleRootFromXfesGeneric;
+use crate::hashing::merkle_root_from_xfes::MerkleRootFromXfes;
 use crate::list::get::Get;
 use crate::list::higher_order::inner_function::InnerFunction;
 use crate::list::higher_order::inner_function::RawCode;
@@ -155,7 +155,7 @@ impl BasicSnippet for FriSnippet {
             }));
         let dequeue_commit_phase = format!("{entrypoint}_dequeue_commit_phase_remainder");
         let length_of_list = library.import(Box::new(Length));
-        let merkle_root_from_xfes = library.import(Box::new(MerkleRootFromXfesGeneric));
+        let merkle_root_from_xfes = library.import(Box::new(MerkleRootFromXfes));
         let get_xfe_from_list = library.import(Box::new(Get::new(DataType::Xfe)));
         let get_digest_from_list = library.import(Box::new(Get::new(DataType::Digest)));
         let sample_indices = library.import(Box::new(SampleIndices));

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`		`- "name": "tasmlib_hashing_merkle_root_from_xfes_generic",`
	`3`	`+ "name": "tasmlib_hashing_merkle_root_from_xfes",`
`4`	`4`	`"benchmark_result": {`
`5`	`5`	`"clock_cycle_count": 7236,`
`6`	`6`	`"hash_table_height": 3234,`
`@@ -11,7 +11,7 @@`
`11`	`11`	`"case": "CommonCase"`
`12`	`12`	`},`
`13`	`13`	`{`
`14`		`- "name": "tasmlib_hashing_merkle_root_from_xfes_generic",`
	`14`	`+ "name": "tasmlib_hashing_merkle_root_from_xfes",`
`15`	`15`	`"benchmark_result": {`
`16`	`16`	`"clock_cycle_count": 14173,`
`17`	`17`	`"hash_table_height": 6306,`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-pub mod mod_pow_u32_generic;`
	`1`	`+pub mod mod_pow_u32;`
`2`	`2`	`pub mod to_the_power_of_power_of_2;`