signoff!: u32::or

BREAKING CHANGE: Remove the implementation of `DeprecatedSnippet` for
`u32::or::Or`, implement `BasicSnippet` directly.

Author: jan-ferdinand

tasm-lib/benchmarks/tasmlib_arithmetic_u32_or.json

@@ -4,7 +4,7 @@
     "benchmark_result": {
       "clock_cycle_count": 9,
       "hash_table_height": 12,
-      "u32_table_height": 36,
+      "u32_table_height": 18,
       "op_stack_table_height": 5,
       "ram_table_height": 0
     },

tasm-lib/src/arithmetic/u32/or.rs

@@ -1,172 +1,116 @@
-use rand::prelude::*;
+use std::collections::HashMap;
+
 use triton_vm::prelude::*;
 
-use crate::empty_stack;
 use crate::prelude::*;
-use crate::traits::deprecated_snippet::DeprecatedSnippet;
-use crate::InitVmState;
-
-#[derive(Clone, Debug)]
+use crate::traits::basic_snippet::Reviewer;
+use crate::traits::basic_snippet::SignOffFingerprint;
+
+/// [Bitwise “or”][bitor] (“`|`”) for `u32`s.
+///
+/// ### Behavior
+///
+/// ```text
+/// BEFORE: _ [right: u32] [left: u32]
+/// AFTER:  _ [left | right: u32]
+/// ```
+///
+/// ### Preconditions
+///
+/// - all input arguments are properly [`BFieldCodec`] encoded
+///
+/// ### Postconditions
+///
+/// - the output is the bitwise “or” of the input
+/// - the output is properly [`BFieldCodec`] encoded
+///
+/// [bitor]: core::ops::BitOr
+#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct Or;
 
-impl DeprecatedSnippet for Or {
-    fn entrypoint_name(&self) -> String {
-        "tasmlib_arithmetic_u32_or".to_string()
-    }
-
-    fn input_field_names(&self) -> Vec<String> {
-        vec!["rhs".to_string(), "lhs".to_string()]
-    }
-
-    fn input_types(&self) -> Vec<DataType> {
-        vec![DataType::U32, DataType::U32]
-    }
-
-    fn output_field_names(&self) -> Vec<String> {
-        vec!["lhs | rhs".to_string()]
+impl BasicSnippet for Or {
+    fn inputs(&self) -> Vec<(DataType, String)> {
+        ["right", "left"]
+            .map(|s| (DataType::U32, s.to_string()))
+            .to_vec()
     }
 
-    fn output_types(&self) -> Vec<DataType> {
-        vec![DataType::U32]
+    fn outputs(&self) -> Vec<(DataType, String)> {
+        vec![(DataType::U32, "left | right".to_string())]
     }
 
-    fn stack_diff(&self) -> isize {
-        -1
-    }
-
-    fn function_code(&self, _library: &mut crate::library::Library) -> String {
-        let entrypoint = self.entrypoint_name();
-        format!(
-            "
-                // BEFORE: _ rhs lhs
-                // AFTER:  _ (lhs | rhs)
-                {entrypoint}:
-                    dup 1
-                    dup 1
-                    xor
-                    // _ rhs lhs (rhs ^ lhs)
-
-                    swap 2
-                    and
-                    // _ (rhs ^ lhs) (lhs & rhs)
-
-                    add
-
-                    return
-                    "
-        )
-    }
-
-    fn crash_conditions(&self) -> Vec<String> {
-        vec!["Inputs are not u32".to_owned()]
-    }
-
-    fn gen_input_states(&self) -> Vec<InitVmState> {
-        let mut ret: Vec<InitVmState> = vec![];
-        for _ in 0..100 {
-            let mut stack = empty_stack();
-            let lhs = thread_rng().next_u32();
-            let rhs = thread_rng().next_u32();
-            let lhs = BFieldElement::new(lhs as u64);
-            let rhs = BFieldElement::new(rhs as u64);
-            stack.push(rhs);
-            stack.push(lhs);
-            ret.push(InitVmState::with_stack(stack));
-        }
-
-        ret
-    }
-
-    fn common_case_input_state(&self) -> InitVmState {
-        InitVmState::with_stack(
-            [
-                empty_stack(),
-                vec![BFieldElement::new(1 << 15), BFieldElement::new(1 << 16)],
-            ]
-            .concat(),
-        )
+    fn entrypoint(&self) -> String {
+        "tasmlib_arithmetic_u32_or".to_string()
     }
 
-    fn worst_case_input_state(&self) -> InitVmState {
-        InitVmState::with_stack(
-            [
-                empty_stack(),
-                vec![
-                    BFieldElement::new((1 << 32) - 1),
-                    BFieldElement::new((1 << 32) - 1),
-                ],
-            ]
-            .concat(),
+    fn code(&self, _: &mut Library) -> Vec<LabelledInstruction> {
+        triton_asm!(
+            // BEFORE: _ right left
+            // AFTER:  _ (left | right)
+            {self.entrypoint()}:
+                dup 1
+                dup 1       // _ right left right left
+                xor         // _ right left (right ^ left)
+                place 2
+                and         // _ (right ^ left) (right & left)
+                add
+                return
         )
     }
 
-    fn rust_shadowing(
-        &self,
-        stack: &mut Vec<BFieldElement>,
-        _std_in: Vec<BFieldElement>,
-        _secret_in: Vec<BFieldElement>,
-        _memory: &mut std::collections::HashMap<BFieldElement, BFieldElement>,
-    ) {
-        let lhs: u32 = stack.pop().unwrap().try_into().unwrap();
-        let rhs: u32 = stack.pop().unwrap().try_into().unwrap();
-
-        let or = lhs | rhs;
-        stack.push(BFieldElement::new(or as u64));
+    fn sign_offs(&self) -> HashMap<Reviewer, SignOffFingerprint> {
+        let mut sign_offs = HashMap::new();
+        sign_offs.insert(Reviewer("ferdinand"), 0x78bc3071bcc44a84.into());
+        sign_offs
     }
 }
 
 #[cfg(test)]
 mod tests {
-    use std::collections::HashMap;
-
     use super::*;
-    use crate::test_helpers::test_rust_equivalence_given_input_values_deprecated;
-    use crate::test_helpers::test_rust_equivalence_multiple_deprecated;
+    use crate::test_prelude::*;
 
-    #[test]
-    fn snippet_test() {
-        test_rust_equivalence_multiple_deprecated(&Or, true);
-    }
+    impl Closure for Or {
+        type Args = (u32, u32);
 
-    #[test]
-    fn or_simple_test() {
-        prop_safe_or(10, 1, Some(11));
-        prop_safe_or(256, 30, Some(286));
-        prop_safe_or(123, 0, Some(123));
-        prop_safe_or(0, 123, Some(123));
-        prop_safe_or(1 << 31, 1 << 30, Some((1 << 30) + (1 << 31)));
-        prop_safe_or(0, 0, Some(0));
-        prop_safe_or(14, 0, Some(14));
-        prop_safe_or(u32::MAX, 0, Some(u32::MAX));
-        prop_safe_or(0, u32::MAX, Some(u32::MAX));
-        prop_safe_or(u32::MAX, u32::MAX, Some(u32::MAX));
+        fn rust_shadow(&self, stack: &mut Vec<BFieldElement>) {
+            let (right, left) = pop_encodable::<Self::Args>(stack);
+            let or = left | right;
+            push_encodable(stack, &or);
+        }
+
+        fn pseudorandom_args(
+            &self,
+            seed: [u8; 32],
+            bench_case: Option<BenchmarkCase>,
+        ) -> Self::Args {
+            match bench_case {
+                Some(BenchmarkCase::CommonCase) => (1 << 15, 1 << 16),
+                Some(BenchmarkCase::WorstCase) => (u32::MAX, u32::MAX),
+                None => StdRng::from_seed(seed).gen(),
+            }
+        }
+
+        fn corner_case_args(&self) -> Vec<Self::Args> {
+            let edges = [0, 1, 2, 0b1110, 0b11110, 1 << 30, 1 << 31, u32::MAX];
+
+            edges.into_iter().cartesian_product(edges).collect()
+        }
     }
 
-    fn prop_safe_or(lhs: u32, rhs: u32, _expected: Option<u32>) {
-        let mut init_stack = empty_stack();
-        init_stack.push(BFieldElement::new(rhs as u64));
-        init_stack.push(BFieldElement::new(lhs as u64));
-
-        let expected = lhs | rhs;
-        let expected = [empty_stack(), vec![BFieldElement::new(expected as u64)]].concat();
-
-        test_rust_equivalence_given_input_values_deprecated(
-            &Or,
-            &init_stack,
-            &[],
-            HashMap::default(),
-            Some(&expected),
-        );
+    #[test]
+    fn rust_shadow() {
+        ShadowedClosure::new(Or).test();
     }
 }
 
 #[cfg(test)]
 mod benches {
     use super::*;
-    use crate::snippet_bencher::bench_and_write;
+    use crate::test_prelude::*;
 
     #[test]
-    fn u32_or_benchmark() {
-        bench_and_write(Or);
+    fn benchmark() {
+        ShadowedClosure::new(Or).bench();
     }
 }