miden-air 0.22.3

Algebraic intermediate representation of Miden VM processor
Documentation 
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

//! Constraint tagging helpers for stable numeric IDs.
//!
//! This module is compiled in tests or when the `testing` feature is enabled, with `std` available.
//! Non-testing or no-std builds use a no-op stub. This keeps call sites clean and avoids `std`
//! machinery in production.

use miden_crypto::stark::air::LiftedAirBuilder;

/// Extension methods for tagging constraints.
///
/// These helpers wrap blocks that should emit a fixed number of assertions. Each assertion
/// consumes one ID from the active tagged block, and the block panics if the count mismatches.
pub trait TaggingAirBuilderExt: LiftedAirBuilder {
    /// Tag exactly one asserted constraint.
    ///
    /// Panics if the wrapped block emits zero or multiple assertions when tagging is enabled.
    fn tagged<R>(
        &mut self,
        id: usize,
        namespace: &'static str,
        f: impl FnOnce(&mut Self) -> R,
    ) -> R {
        if !super::state::is_enabled() {
            return f(self);
        }
        super::state::with_tag(vec![id], namespace, || f(self))
    }

    /// Tag a list of asserted constraints (e.g., `assert_zeros` or per-iteration loops).
    ///
    /// Panics if the wrapped block does not emit exactly `N` assertions when tagging is enabled.
    fn tagged_list<R, const N: usize>(
        &mut self,
        ids: [usize; N],
        namespace: &'static str,
        f: impl FnOnce(&mut Self) -> R,
    ) -> R {
        if !super::state::is_enabled() {
            return f(self);
        }
        super::state::with_tag(ids.to_vec(), namespace, || f(self))
    }
}

impl<T: LiftedAirBuilder> TaggingAirBuilderExt for T {}