xdevs 0.4.0

An open source DEVS M&S framework.
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

use super::{DEVStoneAtomic, DEVStoneSeeder};
#[cfg(test)]
use super::{SharedProbe, TestProbe};
use crate::modeling::Coupled;

pub struct HOmod {
    pub coupled: Coupled,
}

impl HOmod {
    pub fn create(
        width: usize,
        depth: usize,
        int_delay: u64,
        ext_delay: u64,
        #[cfg(test)] probe: SharedProbe,
    ) -> Coupled {
        let mut coupled = Coupled::new("HOmod");
        let seeder = DEVStoneSeeder::new("seeder");
        let homod = Self::new(
            width,
            depth,
            int_delay,
            ext_delay,
            #[cfg(test)]
            probe,
        );
        let homod_name = homod.coupled.component.get_name().to_string();
        coupled.add_component(Box::new(seeder));
        coupled.add_component(Box::new(homod.coupled));
        coupled.add_ic("seeder", "output", &homod_name, "input_1");
        coupled.add_ic("seeder", "output", &homod_name, "input_2");
        coupled
    }

    fn new(
        width: usize,
        depth: usize,
        int_delay: u64,
        ext_delay: u64,
        #[cfg(test)] probe: SharedProbe,
    ) -> Self {
        // First we check the input parameters
        if width < 1 {
            panic!("width must be greater than 1")
        }
        if depth < 1 {
            panic!("depth must be greater than 1")
        }
        // Next we create the model structure
        let name = format!("coupled_{depth}");
        let mut coupled = Coupled::new(&name);
        coupled.add_in_port::<usize>("input_1");
        coupled.add_in_port::<usize>("input_2");
        coupled.add_out_port::<usize>("output");
        // If this is the inner coupled model, we just add one atomic.
        if depth == 1 {
            let atomic = DEVStoneAtomic::new(
                "inner_atomic",
                int_delay,
                ext_delay,
                #[cfg(test)]
                probe.clone(),
            );
            coupled.add_component(Box::new(atomic));
            coupled.add_eic("input_1", "inner_atomic", "input");
            coupled.add_eoc("inner_atomic", "output", "output");
            // Otherwise, we add a subcoupled and a set of atomics.
        } else {
            let subcoupled = Self::new(
                width,
                depth - 1,
                int_delay,
                ext_delay,
                #[cfg(test)]
                probe.clone(),
            );
            let subcoupled_name = subcoupled.coupled.component.get_name().to_string();
            coupled.add_component(Box::new(subcoupled.coupled));
            coupled.add_eic("input_1", &subcoupled_name, "input_1");
            coupled.add_eoc(&subcoupled_name, "output", "output");
            let mut prev_row: Vec<String> = Vec::new();
            let mut current_row: Vec<String> = Vec::new();
            // First row
            for i in 1..width {
                let atomic_name = format!("atomic(1,{i}");
                prev_row.push(atomic_name.clone());
                let atomic = DEVStoneAtomic::new(
                    &atomic_name,
                    int_delay,
                    ext_delay,
                    #[cfg(test)]
                    probe.clone(),
                );
                coupled.add_component(Box::new(atomic));
                coupled.add_eic("input_2", &atomic_name, "input");
                coupled.add_ic(&atomic_name, "output", &subcoupled_name, "input_2");
            }
            // Second row
            for i in 1..width {
                let atomic_name = format!("atomic(2,{i}");
                current_row.push(atomic_name.clone());
                let atomic = DEVStoneAtomic::new(
                    &atomic_name,
                    int_delay,
                    ext_delay,
                    #[cfg(test)]
                    probe.clone(),
                );
                coupled.add_component(Box::new(atomic));
                if i == 1 {
                    coupled.add_eic("input_2", &atomic_name, "input");
                }
                for prev_name in &prev_row {
                    coupled.add_ic(&atomic_name, "output", prev_name, "input");
                }
            }
            // Rest of the tree
            for layer in 3..(width + 1) {
                prev_row = current_row;
                current_row = Vec::new();
                for i in 1..prev_row.len() {
                    let atomic_name = format!("atomic({layer},{i}");
                    current_row.push(atomic_name.clone());
                    let atomic = DEVStoneAtomic::new(
                        &atomic_name,
                        int_delay,
                        ext_delay,
                        #[cfg(test)]
                        probe.clone(),
                    );
                    coupled.add_component(Box::new(atomic));
                    if i == 1 {
                        coupled.add_eic("input_2", &atomic_name, "input");
                    }
                    coupled.add_ic(&atomic_name, "output", prev_row.get(i).unwrap(), "input");
                }
            }
        }
        // Before exiting, we update the probe if required
        #[cfg(test)]
        {
            let mut x = probe.lock().unwrap();
            x.n_eics += coupled.n_eics();
            x.n_ics += coupled.n_ics();
            x.n_eocs += coupled.n_eocs();
        }
        Self { coupled }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::simulation::*;
    use std::sync::{Arc, Mutex};

    fn expected_atomics(width: usize, depth: usize) -> usize {
        (width - 1 + (width - 1) * width / 2) * (depth - 1) + 1
    }

    fn expected_eics(width: usize, depth: usize) -> usize {
        (2 * (width - 1) + 1) * (depth - 1) + 1
    }

    fn expected_ics(width: usize, depth: usize) -> usize {
        ((width - 1) * (width - 1) + (width - 1) * width / 2) * (depth - 1)
    }

    fn expected_eocs(_width: usize, depth: usize) -> usize {
        depth
    }

    fn expected_internals(width: usize, depth: usize) -> usize {
        let mut n = 1;
        for d in 1..depth {
            n += (1 + (d - 1) * (width - 1)) * (width - 1) * width / 2
                + (width - 1) * (width + (d - 1) * (width - 1));
        }
        n
    }

    fn expected_events(width: usize, depth: usize) -> usize {
        let mut n = 1;
        if width > 1 && depth > 1 {
            n += 2 * (width - 1);
            let mut aux = 0;
            for i in 2..depth {
                aux += 1 + (i - 1) * (width - 1);
            }
            n += aux * 2 * (width - 1) * (width - 1);
            n += (aux + 1) * ((width - 1) * (width - 1) + (width - 2) * (width - 1) / 2);
        }
        n
    }

    #[test]
    fn test_homod() {
        for width in (1..10).step_by(1) {
            for depth in (1..10).step_by(1) {
                let probe = Arc::new(Mutex::new(TestProbe::default()));
                let coupled = HOmod::create(width, depth, 0, 0, probe.clone());
                let mut simulator = RootCoordinator::new(coupled);
                simulator.simulate(f64::INFINITY);

                let x = probe.lock().unwrap();
                assert_eq!(expected_atomics(width, depth), x.n_atomics);
                assert_eq!(expected_eics(width, depth), x.n_eics);
                assert_eq!(expected_ics(width, depth), x.n_ics);
                assert_eq!(expected_eocs(width, depth), x.n_eocs);
                assert_eq!(expected_internals(width, depth), x.n_internals);
                assert_eq!(expected_internals(width, depth), x.n_externals);
                assert_eq!(expected_events(width, depth), x.n_events);
            }
        }
    }
}