tasm_lib/arithmetic/u32/
is_u32.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
use std::collections::HashMap;
use triton_vm::prelude::*;

use crate::prelude::*;
use crate::traits::basic_snippet::{Reviewer, SignOffFingerprint};

/// Is the top of the stack a u32?
///
/// ### Behavior
///
/// ```text
/// BEFORE: _ value
/// AFTER:  _ [is_u32: bool]
/// ```
///
/// ### Preconditions
///
/// None.
///
/// ### Postconditions
///
/// - the output is properly [`BFieldCodec`] encoded
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Hash)]
pub struct IsU32;

impl BasicSnippet for IsU32 {
    fn inputs(&self) -> Vec<(DataType, String)> {
        vec![(DataType::U32, "value".to_string())]
    }

    fn outputs(&self) -> Vec<(DataType, String)> {
        vec![(DataType::Bool, "value < 2^32".to_string())]
    }

    fn entrypoint(&self) -> String {
        "tasmlib_arithmetic_u32_is_u32".to_string()
    }

    fn code(&self, _: &mut Library) -> Vec<LabelledInstruction> {
        triton_asm!(
            {self.entrypoint()}:
                        // _ a
                split   // _ hi lo
                pop 1   // _ hi
                push 0  // _ hi 0
                eq      // _ (hi == 0)
                return
        )
    }

    fn sign_offs(&self) -> HashMap<Reviewer, SignOffFingerprint> {
        let mut sign_offs = HashMap::new();
        sign_offs.insert(Reviewer("ferdinand"), 0x95dae6d2fe11abda.into());
        sign_offs
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_prelude::*;

    impl Closure for IsU32 {
        type Args = BFieldElement;

        fn rust_shadow(&self, stack: &mut Vec<BFieldElement>) {
            let value = stack.pop().unwrap();
            let is_u32 = u32::try_from(value).is_ok();
            push_encodable(stack, &is_u32);
        }

        fn pseudorandom_args(
            &self,
            seed: [u8; 32],
            bench_case: Option<BenchmarkCase>,
        ) -> Self::Args {
            match bench_case {
                Some(BenchmarkCase::CommonCase) => bfe!(1 << 16),
                Some(BenchmarkCase::WorstCase) => bfe!(u32::MAX),
                None => StdRng::from_seed(seed).random(),
            }
        }

        fn corner_case_args(&self) -> Vec<Self::Args> {
            bfe_vec![0, u32::MAX, u64::from(u32::MAX) + 1, BFieldElement::MAX]
        }
    }

    #[test]
    fn rust_shadow() {
        ShadowedClosure::new(IsU32).test();
    }
}

#[cfg(test)]
mod benches {
    use super::*;
    use crate::test_prelude::*;

    #[test]
    fn is_u32_benchmark() {
        ShadowedClosure::new(IsU32).bench();
    }
}