siraph 0.1.2

A node-based digital signal processing crate
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

#![cfg(test)]

use siraph::{Graph, Input, Node, Output, Register, Sink};

pub struct Add {
    left: Input<i32>,
    right: Input<i32>,
    result: Output<i32>,
}

impl Add {
    pub fn new() -> Self {
        Self {
            left: Input::default(),
            right: Input::default(),
            result: Output::default(),
        }
    }
}

impl Node for Add {
    fn register(&self, r: &mut Register) {
        r.input("left", &self.left);
        r.input("right", &self.right);
        r.output("result", &self.result);
    }

    fn process(&mut self) {
        if self.result.is_used() {
            let left = self.left.get().unwrap_or_default();
            let right = self.right.get().unwrap_or_default();
            self.result.set(left + right)
        }
    }

    fn reset(&mut self) {}
}

pub struct Counter {
    value: i32,
    output: Output<i32>,
}

impl Counter {
    pub fn new(start: i32) -> Self {
        Self {
            value: start,
            output: Output::default(),
        }
    }
}

impl Node for Counter {
    fn register(&self, r: &mut Register) {
        r.output("output", &self.output);
    }

    fn process(&mut self) {
        self.output.set(self.value);
        self.value += 1;
    }

    fn reset(&mut self) {}
}

#[test]
fn test_basic_use() {
    let mut graph = Graph::default();
    let a = graph.insert(Counter::new(0));

    let mut sink = graph.sink(a, "output").unwrap();

    for i in 0i32..1000 {
        assert_eq!(sink.next(), Some(i));
    }
}

#[test]
fn test_basic_plug() {
    let mut graph = Graph::default();
    let a = graph.insert(Counter::new(0));
    let b = graph.insert(Counter::new(2));
    let c = graph.insert(Add::new());

    graph.plug(a, "output", c, "left").unwrap();
    graph.plug(b, "output", c, "right").unwrap();

    let mut sink = graph.sink(c, "result").unwrap();

    for i in 0..1000 {
        assert_eq!(sink.next(), Some(2 + i * 2));
    }
}

#[test]
#[should_panic(expected = "ERROR")]
fn test_cycle_simple() {
    let mut graph = Graph::default();

    let a = graph.insert(Add::new());

    graph.plug(a, "result", a, "left").expect("ERROR");
}

#[test]
#[should_panic(expected = "ERROR")]
fn test_cycle_multiple() {
    let mut graph = Graph::default();

    let a = graph.insert(Add::new());
    let b = graph.insert(Add::new());
    let c = graph.insert(Add::new());

    graph.plug(a, "result", b, "left").unwrap();
    graph.plug(b, "result", c, "left").unwrap();
    graph.plug(c, "result", a, "left").expect("ERROR");
}

#[test]
fn test_stable_node_handles() {
    let mut graph = Graph::default();

    let a = graph.insert(Add::new());
    let b = graph.insert(Counter::new(0));

    graph.remove(a).unwrap();

    // if handles are not stable, `b` should
    // not be a valid handle anymore.
    let _: Sink<'_, i32> = graph.sink(b, "output").unwrap();
}