sim-lib-interference-runtime 0.1.0

Tensor-backed Citizen records and Shape contracts for coherent interference studies.
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
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//! Runtime Shapes for interference call arguments and results.

use std::{marker::PhantomData, sync::Arc};

use sim_kernel::{Cx, Expr, MatchScore, Result, Shape, ShapeDoc, ShapeMatch, Symbol, Value};
use sim_shape::shape_value;

use crate::{
    PlaneDescriptor, ProblemDescriptor, ProjectionRequestDescriptor, ScalarProjectionDescriptor,
    StudyDescriptor, citizen::RecordCitizenSpec,
};

/// Shape symbol for coherent problem records.
pub fn problem_shape_symbol() -> Symbol {
    Symbol::qualified("interference", "Problem")
}

/// Shape symbol for physical sampling-plane records.
pub fn plane_shape_symbol() -> Symbol {
    Symbol::qualified("interference", "Plane")
}

/// Shape symbol for complete Tensor-backed studies.
pub fn study_shape_symbol() -> Symbol {
    Symbol::qualified("interference", "Study")
}

/// Shape symbol for scalar projection requests.
pub fn projection_request_shape_symbol() -> Symbol {
    Symbol::qualified("interference", "ProjectionRequest")
}

/// Shape symbol for scalar projection results.
pub fn projection_shape_symbol() -> Symbol {
    Symbol::qualified("interference", "Projection")
}

/// Returns the five public Shape symbols registered by the record library.
pub fn interference_shape_symbols() -> Vec<Symbol> {
    vec![
        problem_shape_symbol(),
        plane_shape_symbol(),
        study_shape_symbol(),
        projection_request_shape_symbol(),
        projection_shape_symbol(),
    ]
}

pub(crate) fn register_interference_shapes(linker: &mut sim_kernel::Linker<'_>) -> Result<()> {
    for (symbol, shape) in shape_specs() {
        linker.shape_value(symbol.clone(), shape_value(symbol, shape))?;
    }
    Ok(())
}

fn shape_specs() -> Vec<(Symbol, Arc<dyn Shape>)> {
    vec![
        (problem_shape_symbol(), problem_shape()),
        (plane_shape_symbol(), plane_shape()),
        (study_shape_symbol(), study_shape()),
        (
            projection_request_shape_symbol(),
            projection_request_shape(),
        ),
        (projection_shape_symbol(), projection_shape()),
    ]
}

pub(crate) fn problem_shape() -> Arc<dyn Shape> {
    record_shape::<ProblemDescriptor>(
        problem_shape_symbol(),
        "Problem",
        "checked coherent single-frequency problem",
    )
}

pub(crate) fn plane_shape() -> Arc<dyn Shape> {
    record_shape::<PlaneDescriptor>(
        plane_shape_symbol(),
        "Plane",
        "checked orthonormal finite physical sampling plane",
    )
}

pub(crate) fn study_shape() -> Arc<dyn Shape> {
    record_shape::<StudyDescriptor>(
        study_shape_symbol(),
        "Study",
        "Tensor field with matching problem, plane, sampling, work, and provider evidence",
    )
}

pub(crate) fn projection_request_shape() -> Arc<dyn Shape> {
    record_shape::<ProjectionRequestDescriptor>(
        projection_request_shape_symbol(),
        "ProjectionRequest",
        "checked observable, phase floor, target dimensions, and detector rule",
    )
}

pub(crate) fn projection_shape() -> Arc<dyn Shape> {
    record_shape::<ScalarProjectionDescriptor>(
        projection_shape_symbol(),
        "Projection",
        "one-Tensor scalar projection with exact mask and certificate",
    )
}

fn record_shape<T>(symbol: Symbol, name: &'static str, detail: &'static str) -> Arc<dyn Shape>
where
    T: RecordCitizenSpec,
{
    Arc::new(RecordShape::<T> {
        symbol,
        name,
        detail,
        marker: PhantomData,
    })
}

struct RecordShape<T> {
    symbol: Symbol,
    name: &'static str,
    detail: &'static str,
    marker: PhantomData<T>,
}

impl<T> Shape for RecordShape<T>
where
    T: RecordCitizenSpec,
{
    fn symbol(&self) -> Option<Symbol> {
        Some(self.symbol.clone())
    }

    fn check_value(&self, _cx: &mut Cx, value: Value) -> Result<ShapeMatch> {
        let Some(record) = value.object().downcast_ref::<T>() else {
            return Ok(ShapeMatch::reject(format!("{} record expected", self.name)));
        };
        Ok(match record.validate() {
            Ok(()) => ShapeMatch::accept(MatchScore::exact(100)),
            Err(error) => ShapeMatch::reject(format!("malformed {}: {error}", self.name)),
        })
    }

    fn check_expr(&self, cx: &mut Cx, expr: &Expr) -> Result<ShapeMatch> {
        let value = cx.eval_expr(expr.clone())?;
        self.check_value(cx, value)
    }

    fn describe(&self, _cx: &mut Cx) -> Result<ShapeDoc> {
        Ok(ShapeDoc::new(self.name).with_detail(self.detail))
    }
}