polydat 0.3.2

Polydat — a variates construction engine
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251

// Copyright 2024-2026 Jonathan Shook
// SPDX-License-Identifier: Apache-2.0

//! One compile path behind every entry point. A source string, a parsed
//! file, or an assembler a host built by hand reaches the same graph and
//! the same kernel on every engine; the options mean the same thing
//! whichever entry point carries them; and what the interpreter refuses
//! under strict, every engine refuses.

use polydat::ast::Value;
use polydat::compile::assembly::{PolydatAssembler, WireRef};
use polydat::dsl::compile::{
    CompileOptions, compile_polydat, compile_polydat_kernel, compile_polydat_kernel_with_options,
    compile_polydat_to_assembler, compile_polydat_to_assembler_with, compile_polydat_with,
    compile_polydat_with_engine, compile_polydat_with_log, compile_polydat_with_options,
};
use polydat::dsl::events::CompileEventLog;
use polydat::{Engine, JitMode, Kernel, KernelError, Provenance};

const SRC: &str = "input cycle: u64\nh := hash(cycle)\nk := mod_wire(h, 7)\ns := \"k={k}\"\n";

/// Every engine a build can name; a refusal is skipped, as elsewhere.
fn engines() -> Vec<Engine> {
    let mut all = vec![
        Engine::Interpreter(JitMode::Auto),
        Engine::Closures(Provenance::Auto),
        Engine::Closures(Provenance::Raw),
    ];
    if cfg!(feature = "jit") {
        all.push(Engine::Native(Provenance::Auto));
        all.push(Engine::Native(Provenance::Raw));
    }
    all
}

fn values(k: &mut dyn Kernel, cycle: u64) -> Vec<Value> {
    k.set_inputs(&[cycle]);
    k.output_names().iter().map(|o| k.pull(o)).collect()
}

#[test]
fn every_entry_point_reaches_the_same_kernel() {
    let mut oracle = compile_polydat(SRC).unwrap();
    let want: Vec<Value> = values(&mut oracle, 5);
    let options = CompileOptions::default();
    let mut log = CompileEventLog::new();
    let mut kernels: Vec<(&str, Box<dyn Kernel>)> = vec![
        (
            "compile_polydat_kernel",
            compile_polydat_kernel(SRC).unwrap(),
        ),
        (
            "compile_polydat_kernel_with_options",
            compile_polydat_kernel_with_options(SRC, &options, Some(&mut log)).unwrap(),
        ),
        (
            "compile_polydat_with_options",
            Box::new(compile_polydat_with_options(SRC, &options, None).unwrap()),
        ),
        (
            "compile_polydat_with_log",
            Box::new(compile_polydat_with_log(SRC, &mut CompileEventLog::new()).unwrap()),
        ),
        (
            "compile_polydat_to_assembler",
            compile_polydat_to_assembler(SRC)
                .unwrap()
                .compile_kernel()
                .unwrap(),
        ),
        (
            "compile_polydat_to_assembler_with",
            Box::new(
                compile_polydat_to_assembler_with(SRC, &options)
                    .unwrap()
                    .compile()
                    .unwrap(),
            ),
        ),
    ];
    for engine in engines() {
        if let Ok(k) = compile_polydat_with(SRC, engine) {
            kernels.push(("compile_polydat_with", k));
        }
        if let Ok(k) = compile_polydat_with_engine(SRC, engine, &options, None) {
            kernels.push(("compile_polydat_with_engine", k));
        }
        if let Ok(k) = compile_polydat_to_assembler(SRC)
            .unwrap()
            .compile_with(engine)
        {
            kernels.push(("PolydatAssembler::compile_with", k));
        }
    }
    for (name, k) in kernels.iter_mut() {
        assert_eq!(
            k.output_names(),
            oracle.output_names(),
            "{name} on {}",
            k.engine()
        );
        assert_eq!(values(k.as_mut(), 5), want, "{name} on {}", k.engine());
    }
}

/// The assembler a host builds by hand is the same first-class road to a
/// kernel: nodes and wires added one by one compile on every engine to
/// what the same graph from source computes.
#[test]
fn a_hand_built_assembler_compiles_on_every_engine() {
    fn build() -> PolydatAssembler {
        let mut asm = PolydatAssembler::new(vec!["cycle".into()]);
        use polydat::ast::PortType;
        let hash = polydat::dsl::factory::build_node(
            "hash",
            &[WireRef::input("cycle")],
            &[PortType::U64],
            &[],
        )
        .unwrap();
        asm.add_node("h", hash, vec![WireRef::input("cycle")]);
        let m = polydat::dsl::factory::build_node(
            "mod",
            &[WireRef::node("h")],
            &[PortType::U64],
            &[polydat::dsl::ConstArg::Int(7)],
        )
        .unwrap();
        asm.add_node("k", m, vec![WireRef::node("h")]);
        asm.add_output("h", WireRef::node("h"));
        asm.add_output("k", WireRef::node("k"));
        asm
    }
    fn hk(k: &mut dyn Kernel) -> (Value, Value) {
        k.set_inputs(&[9]);
        (k.pull("h"), k.pull("k"))
    }
    let mut from_source =
        compile_polydat("input cycle: u64\nh := hash(cycle)\nk := mod(h, 7)\n").unwrap();
    let want = hk(&mut from_source);
    let mut p1 = build().compile().unwrap();
    assert_eq!(hk(&mut p1), want);
    for engine in engines() {
        let mut k = match build().compile_with(engine) {
            Ok(k) => k,
            Err(KernelError::Refused { .. }) => continue,
            Err(e) => panic!("{engine}: {e}"),
        };
        assert_eq!(hk(k.as_mut()), want, "{engine}");
    }
    let mut default = build().compile_kernel().unwrap();
    // The default engine, in the provenance mode the selector chose.
    assert!(matches!(
        (default.engine(), Engine::default()),
        (Engine::Native(_), Engine::Native(_)) | (Engine::Closures(_), Engine::Closures(_))
    ));
    assert_eq!(hk(default.as_mut()), want);
}

/// What strict refuses, it refuses on every engine: an implicit adapter
/// between a float wire and an integer port is an error under
/// `strict: true` whichever engine the options reach.
#[test]
fn strict_refuses_implicit_coercions_on_every_engine() {
    let src = "input cycle: u64\nh := hash(cycle)\nf := sqrt(h)\n";
    let strict = CompileOptions {
        strict: true,
        ..CompileOptions::default()
    };
    assert!(compile_polydat_with_options(src, &strict, None).is_err());
    for engine in engines() {
        let outcome = compile_polydat_with_engine(src, engine, &strict, None);
        assert!(
            matches!(
                outcome,
                Err(KernelError::Assembly(_)) | Err(KernelError::Source(_))
            ),
            "{engine}: strict must refuse the implicit coercion, got {:?}",
            outcome.map(|k| k.engine())
        );
        let lax = compile_polydat_with_engine(src, engine, &CompileOptions::default(), None);
        assert!(
            lax.is_ok() || matches!(lax, Err(KernelError::Refused { .. })),
            "{engine}: {:?}",
            lax.err()
        );
    }
}

/// The logged interpreter compile is the plain one with a log: a program
/// with a traversal compiles through it, as it does everywhere else.
#[test]
fn the_logged_compile_accepts_a_traversal() {
    let src = "input cycle: u64\nfor k in 1..3 {\n  y := k * 10\n}\n";
    let mut log = CompileEventLog::new();
    let k = compile_polydat_with_log(src, &mut log).expect("a for statement compiles with a log");
    assert_eq!(k.traversals().len(), 1);
}

/// A cursor extent computed from a constant expression is resolved on
/// every engine, not only on the interpreter: `cursor_schemas` reports
/// the same extent whichever engine built the kernel.
#[test]
fn deferred_cursor_extents_resolve_on_every_engine() {
    let src = "input cycle: u64\nn := 10 + 5\ncursor q = range(0, n)\nv := hash(q.ordinal)\n";
    let want = compile_polydat(src).unwrap().cursor_schemas()[0].extent;
    assert_eq!(want, Some(15));
    for engine in engines() {
        let k = match compile_polydat_with(src, engine) {
            Ok(k) => k,
            Err(KernelError::Refused { .. }) => continue,
            Err(e) => panic!("{engine}: {e}"),
        };
        assert_eq!(k.cursor_schemas()[0].extent, want, "{engine}");
    }
}

/// A module the program defines is visible inside its `for` bodies
/// whichever way the program was compiled: from a string with no source
/// directory, the body resolves the module from the program, not from a
/// file on disk.
#[test]
fn a_program_module_is_visible_inside_a_traversal_body() {
    let src = "\
input cycle: u64
twice(x: u64) -> (y: u64) := {
  y := x * 2
}
for k in 1..4 {
  d := twice(k)
}
";
    for engine in engines() {
        let mut k = match compile_polydat_with(src, engine) {
            Ok(k) => k,
            Err(KernelError::Refused { .. }) => continue,
            Err(e) => panic!("{engine}: {e}"),
        };
        k.set_inputs(&[0]);
        let streams = k.traverse_all().unwrap();
        let mut seen = Vec::new();
        for s in &streams {
            for i in 0..s.len() {
                let mut act = s.activation(i).unwrap();
                act.kernel.set_inputs(&[0]);
                seen.push(act.kernel.pull("d").as_u64());
            }
        }
        assert_eq!(seen, vec![2, 4, 6], "{engine}");
    }
}