wavelet 0.6.1

High-performance graph-based stream processing runtime
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
use crate::Control;
use crate::prelude::{Executor, Node, NodeBuilder};
pub fn and_node(executor: &mut Executor, left: Node<bool>, right: Node<bool>) -> Node<bool> {
    and_node_with_init(executor, left, right, false)
}
pub fn and_node_with_init(
    executor: &mut Executor,
    left: Node<bool>,
    right: Node<bool>,
    init: bool,
) -> Node<bool> {
    NodeBuilder::new(init)
        .triggered_by(&left)
        .triggered_by(&right)
        .build(executor, move |this, _| {
            let new_value = *left.borrow() && *right.borrow();
            let is_different = new_value ^ *this;
            *this = new_value;
            Control::from(is_different)
        })
}
pub fn and_node_with_bootstrap(
    executor: &mut Executor,
    left: Node<bool>,
    right: Node<bool>,
) -> Node<bool> {
    NodeBuilder::new(false)
        .triggered_by(&left)
        .triggered_by(&right)
        .on_init(|ex, _, current| {
            ex.yield_driver().yield_now(current);
        })
        .build(executor, move |this, _| {
            let new_value = *left.borrow() && *right.borrow();
            let is_different = new_value ^ *this;
            *this = new_value;
            Control::from(is_different)
        })
}
pub fn or_node(executor: &mut Executor, left: Node<bool>, right: Node<bool>) -> Node<bool> {
    or_node_with_init(executor, left, right, false)
}
pub fn or_node_with_init(
    executor: &mut Executor,
    left: Node<bool>,
    right: Node<bool>,
    init: bool,
) -> Node<bool> {
    NodeBuilder::new(init)
        .triggered_by(&left)
        .triggered_by(&right)
        .build(executor, move |this, _| {
            let new_value = *left.borrow() || *right.borrow();
            let is_different = new_value ^ *this;
            *this = new_value;
            Control::from(is_different)
        })
}
pub fn or_node_with_bootstrap(
    executor: &mut Executor,
    left: Node<bool>,
    right: Node<bool>,
) -> Node<bool> {
    NodeBuilder::new(false)
        .triggered_by(&left)
        .triggered_by(&right)
        .on_init(|ex, _, current| {
            ex.yield_driver().yield_now(current);
        })
        .build(executor, move |this, _| {
            let new_value = *left.borrow() || *right.borrow();
            let is_different = new_value ^ *this;
            *this = new_value;
            Control::from(is_different)
        })
}
pub fn xor_node(executor: &mut Executor, left: Node<bool>, right: Node<bool>) -> Node<bool> {
    xor_node_with_init(executor, left, right, false)
}
pub fn xor_node_with_init(
    executor: &mut Executor,
    left: Node<bool>,
    right: Node<bool>,
    init: bool,
) -> Node<bool> {
    NodeBuilder::new(init)
        .triggered_by(&left)
        .triggered_by(&right)
        .build(executor, move |this, _| {
            let new_value = *left.borrow() ^ *right.borrow();
            let is_different = new_value ^ *this;
            *this = new_value;
            Control::from(is_different)
        })
}
pub fn xor_node_with_bootstrap(
    executor: &mut Executor,
    left: Node<bool>,
    right: Node<bool>,
) -> Node<bool> {
    NodeBuilder::new(false)
        .triggered_by(&left)
        .triggered_by(&right)
        .on_init(|ex, _, current| {
            ex.yield_driver().yield_now(current);
        })
        .build(executor, move |this, _| {
            let new_value = *left.borrow() ^ *right.borrow();
            let is_different = new_value ^ *this;
            *this = new_value;
            Control::from(is_different)
        })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::prelude::TestRuntime;
    use crate::prelude::*;
    use crate::testing::push_node;
    use std::cell::RefCell;
    use std::rc::Rc;

    #[test]
    fn test_and_node_basic() {
        let mut runtime = TestRuntime::new();

        // Create push nodes for inputs - returns (Node<T>, Push<T>)
        let (left_node, left_push) = push_node(runtime.executor(), false);
        let (right_node, right_push) = push_node(runtime.executor(), false);

        // Create the AND node
        let and = and_node(runtime.executor(), left_node, right_node);

        // Test all combinations
        // false AND false = false
        assert_eq!(*and.borrow(), false);

        // true AND false = false
        left_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), false);

        // true AND true = true
        right_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), true);

        // false AND true = false
        left_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), false);

        // false AND false = false
        right_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), false);
    }

    #[test]
    fn test_and_node_with_init() {
        let mut runtime = TestRuntime::new();

        let (left_node, left_push) = push_node(runtime.executor(), true);
        let (right_node, _right_push) = push_node(runtime.executor(), true);

        // Test with init = true
        let and = and_node_with_init(
            runtime.executor(),
            left_node.clone(),
            right_node.clone(),
            true,
        );

        // Should start with true regardless of inputs initially not being processed
        assert_eq!(*and.borrow(), true);

        // After cycle, should reflect actual AND logic
        left_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), true); // true AND true = true

        // Test with init = false but true inputs
        let and2 = and_node_with_init(runtime.executor(), left_node, right_node, false);
        assert_eq!(*and2.borrow(), false); // Starts with false

        left_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*and2.borrow(), true); // Updates to true AND true = true
    }

    #[test]
    fn test_and_node_with_bootstrap() {
        let mut runtime = TestRuntime::new();

        let (left_node, _left_push) = push_node(runtime.executor(), true);
        let (right_node, _right_push) = push_node(runtime.executor(), true);

        let and = and_node_with_bootstrap(runtime.executor(), left_node, right_node);

        // Initially false
        assert_eq!(*and.borrow(), false);

        // Bootstrap should schedule it for evaluation
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), true); // true AND true = true
    }

    #[test]
    fn test_or_node_basic() {
        let mut runtime = TestRuntime::new();

        let (left_node, left_push) = push_node(runtime.executor(), false);
        let (right_node, right_push) = push_node(runtime.executor(), false);

        let or = or_node(runtime.executor(), left_node, right_node);

        // false OR false = false
        assert_eq!(*or.borrow(), false);

        // true OR false = true
        left_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*or.borrow(), true);

        // true OR true = true
        right_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*or.borrow(), true);

        // false OR true = true
        left_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*or.borrow(), true);

        // false OR false = false
        right_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*or.borrow(), false);
    }

    #[test]
    fn test_or_node_with_init() {
        let mut runtime = TestRuntime::new();

        let (left_node, left_push) = push_node(runtime.executor(), false);
        let (right_node, _right_push) = push_node(runtime.executor(), false);

        // Test with init = true
        let or = or_node_with_init(
            runtime.executor(),
            left_node.clone(),
            right_node.clone(),
            true,
        );
        assert_eq!(*or.borrow(), true); // Starts with true

        left_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*or.borrow(), false); // false OR false = false

        // Test with init = false
        let or2 = or_node_with_init(runtime.executor(), left_node, right_node, false);
        assert_eq!(*or2.borrow(), false); // Starts with false
    }

    #[test]
    fn test_or_node_with_bootstrap() {
        let mut runtime = TestRuntime::new();

        let (left_node, _left_push) = push_node(runtime.executor(), false);
        let (right_node, _right_push) = push_node(runtime.executor(), true);

        let or = or_node_with_bootstrap(runtime.executor(), left_node, right_node);

        // Initially false
        assert_eq!(*or.borrow(), false);

        // Bootstrap triggers evaluation
        runtime.run_one_cycle();
        assert_eq!(*or.borrow(), true); // false OR true = true
    }

    #[test]
    fn test_xor_node_basic() {
        let mut runtime = TestRuntime::new();

        let (left_node, left_push) = push_node(runtime.executor(), false);
        let (right_node, right_push) = push_node(runtime.executor(), false);

        let xor = xor_node(runtime.executor(), left_node, right_node);

        // false XOR false = false
        assert_eq!(*xor.borrow(), false);

        // true XOR false = true
        left_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*xor.borrow(), true);

        // true XOR true = false
        right_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*xor.borrow(), false);

        // false XOR true = true
        left_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*xor.borrow(), true);

        // false XOR false = false
        right_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*xor.borrow(), false);
    }

    #[test]
    fn test_xor_node_with_init() {
        let mut runtime = TestRuntime::new();

        let (left_node, _left_push) = push_node(runtime.executor(), true);
        let (right_node, right_push) = push_node(runtime.executor(), false);

        // Test with init = true
        let xor = xor_node_with_init(
            runtime.executor(),
            left_node.clone(),
            right_node.clone(),
            true,
        );
        assert_eq!(*xor.borrow(), true); // Starts with true

        runtime.run_one_cycle();
        assert_eq!(*xor.borrow(), true); // true XOR false = true

        // Test with init = false
        let xor2 = xor_node_with_init(runtime.executor(), left_node, right_node, false);
        assert_eq!(*xor2.borrow(), false); // Starts with false

        right_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*xor2.borrow(), true); // true XOR false = true
    }

    #[test]
    fn test_xor_node_with_bootstrap() {
        let mut runtime = TestRuntime::new();

        let (left_node, _left_push) = push_node(runtime.executor(), true);
        let (right_node, _right_push) = push_node(runtime.executor(), true);

        let xor = xor_node_with_bootstrap(runtime.executor(), left_node, right_node);

        // Initially false
        assert_eq!(*xor.borrow(), false);

        // Bootstrap triggers evaluation
        runtime.run_one_cycle();
        assert_eq!(*xor.borrow(), false); // true XOR true = false
    }

    #[test]
    fn test_propagation_only_on_change() {
        let mut runtime = TestRuntime::new();

        let (left_node, left_push) = push_node(runtime.executor(), true);
        let (right_node, right_push) = push_node(runtime.executor(), false);

        let and = and_node(runtime.executor(), left_node, right_node);

        // Create a child node that counts how many times it's triggered
        let trigger_count = Rc::new(RefCell::new(0));
        let cloned = trigger_count.clone();
        let counter =
            NodeBuilder::new(0)
                .triggered_by(&and)
                .build(runtime.executor(), move |this, _| {
                    *cloned.borrow_mut() += 1;
                    *this += 1;
                    Control::Broadcast
                });

        // Initial state
        assert_eq!(*and.borrow(), false);
        assert_eq!(*counter.borrow(), 0);
        assert_eq!(*trigger_count.borrow(), 0);

        // Change that affects output (false -> false, no change)
        right_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), false);
        assert_eq!(*trigger_count.borrow(), 0); // Should not trigger

        // Change that affects output (false -> true)
        right_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), true);
        assert_eq!(*trigger_count.borrow(), 1); // Should trigger

        // Change that doesn't affect output (true -> true)
        left_push.push(true);
        right_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), true);
        assert_eq!(*trigger_count.borrow(), 1); // Should not trigger again
    }

    #[test]
    fn test_complex_logic_chain() {
        let mut runtime = TestRuntime::new();

        // Create a complex logic chain: (A AND B) OR (C XOR D)
        let (a_node, a_push) = push_node(runtime.executor(), true);
        let (b_node, b_push) = push_node(runtime.executor(), false);
        let (c_node, c_push) = push_node(runtime.executor(), true);
        let (d_node, d_push) = push_node(runtime.executor(), true);

        let and_ab = and_node(runtime.executor(), a_node, b_node);
        let xor_cd = xor_node(runtime.executor(), c_node, d_node);
        let final_or = or_node(runtime.executor(), and_ab, xor_cd);

        // Initial: (true AND false) OR (true XOR true) = false OR false = false
        runtime.run_one_cycle();
        assert_eq!(*final_or.borrow(), false);

        // Change B to true: (true AND true) OR (true XOR true) = true OR false = true
        b_push.push(true);
        runtime.run_one_cycle();
        assert_eq!(*final_or.borrow(), true);

        // Change D to false: (true AND true) OR (true XOR false) = true OR true = true
        d_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*final_or.borrow(), true);

        // Change A to false and B to false: (false AND false) OR (true XOR false) = false OR true = true
        a_push.push(false);
        b_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*final_or.borrow(), true);

        // Change C to false: (false AND false) OR (false XOR false) = false OR false = false
        c_push.push(false);
        runtime.run_one_cycle();
        assert_eq!(*final_or.borrow(), false);
    }

    #[test]
    fn test_bootstrap_scheduling() {
        let mut runtime = TestRuntime::new();

        let (left_node, _left_push) = push_node(runtime.executor(), true);
        let (right_node, _right_push) = push_node(runtime.executor(), true);

        // Create multiple bootstrapped nodes
        let and =
            and_node_with_bootstrap(runtime.executor(), left_node.clone(), right_node.clone());
        let or = or_node_with_bootstrap(runtime.executor(), left_node.clone(), right_node.clone());
        let xor = xor_node_with_bootstrap(runtime.executor(), left_node, right_node);

        // All should start at false
        assert_eq!(*and.borrow(), false);
        assert_eq!(*or.borrow(), false);
        assert_eq!(*xor.borrow(), false);

        // After one cycle, all should be evaluated
        runtime.run_one_cycle();
        assert_eq!(*and.borrow(), true); // true AND true = true
        assert_eq!(*or.borrow(), true); // true OR true = true
        assert_eq!(*xor.borrow(), false); // true XOR true = false
    }
}