arnalisa 0.6.8

Pipeline system for calculating values
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

//! A bin that stores values in a fifo and calculates some facts about them.
//!
//! ```text
//!   ┌────────[fifo]────────┐
//!  ⇒│input              min│⇒
//!  ⇒│min_items          max│⇒
//!  ⇒│max_items        delta│⇒
//!   └──────────────────────┘
//! ```
//!
//! # Inputs:
//! - `input`: The input value
//! - `min_items`: The minimum number of items for the values to be
//!   calculated. As long as the number of values in the fifo is
//!   smaller than `min_items`, all outputs will be `Nothing`.
//! - `max_items`: The maximum number of items allowed in the fifo.
//!   If more items are in the present, they get taken out of the fifo.
//!
//! # Outputs:
//! - `min`: The minimum of all values in the fifo, or `Nothing` if the
//!   number of values in the fifo is smaller than the `min_items` input.
//! - `max`: The maximum of all values in the fifo, or `Nothing` if the
//!   number of values in the fifo is smaller than the `min_items` input.
//! - `delta`: The difference between the `min` and `max` output values.

use super::{
    build_names, BinBuildEnvironment, BinDescription, Calculator,
    FetchItem, GetCalibration, Item, Iteration, Result, Scope, SinkBin,
    SinkNames, SourceBin, SourceId, SourceNames, SourceSinkBinDescription,
    WriteDotSimple, SINK_INPUT,
};
use crate::{error, R64};
use indexmap::IndexSet;
use std::collections::VecDeque;

static BIN_TYPE: &str = "fifo";
static SINK_MIN_ITEMS: &str = "min_items";
static SINK_MAX_ITEMS: &str = "max_items";
static SOURCE_DELTA: &str = "delta";
static SOURCE_MIN: &str = "min";
static SOURCE_MAX: &str = "max";

/// A bin that stores values in a fifo and calculates some facts about them.
#[derive(Debug)]
pub struct Bin {
    scope: Scope,

    source_input: Box<dyn FetchItem>,
    source_min_items: Box<dyn FetchItem>,
    source_max_items: Box<dyn FetchItem>,

    fifo: VecDeque<Item>,
    min: Option<R64>,
    max: Option<R64>,

    result_min: Item,
    result_max: Item,
    result_delta: Item,
}

impl SinkBin for Bin {}

impl SourceBin for Bin {
    fn get_source_data(&self, source: &SourceId) -> Result<Item> {
        if source.id == SOURCE_MIN {
            Ok(self.result_min.clone())
        } else if source.id == SOURCE_MAX {
            Ok(self.result_max.clone())
        } else if source.id == SOURCE_DELTA {
            Ok(self.result_delta.clone())
        } else {
            error::MissingSourceName {
                scope: self.scope.clone(),
                name: source.id.to_string(),
                bin_type: BIN_TYPE.to_string(),
            }
            .fail()
        }
    }
}

impl Calculator for Bin {
    fn calculate(&mut self, _iteration: &Iteration) -> Result<()> {
        let input = self.source_input.fetch_item(&self.scope)?;
        let min_items = self.source_min_items.fetch_item(&self.scope)?;
        let max_items = self.source_max_items.fetch_item(&self.scope)?;

        let min_items = min_items.to_usize().unwrap_or(0usize);
        let max_items = max_items.to_usize().unwrap_or(usize::max_value());

        self.fifo.push_back(input.clone());
        let dissed = {
            let mut dissed = None;
            while self.fifo.len() > max_items {
                dissed = self.fifo.pop_front()
            }
            dissed
        };

        if let Some(d) = dissed {
            if d.to_float().is_ok() {
                self.min = None;
                self.max = None;

                for v in &self.fifo {
                    match (v.to_float(), self.min) {
                        (Ok(f), None) => self.min = Some(f),
                        (Ok(f), Some(m)) if f < m => self.min = Some(f),
                        _ => {}
                    }
                    match (v.to_float(), self.max) {
                        (Ok(f), None) => self.max = Some(f),
                        (Ok(f), Some(m)) if f > m => self.max = Some(f),
                        _ => {}
                    }
                }
            }
        }

        if self.fifo.len() >= min_items {
            match (input.to_float(), self.min) {
                (Ok(f), None) => self.min = Some(f),
                (Ok(f), Some(m)) if f < m => self.min = Some(f),
                _ => {}
            }
            match (input.to_float(), self.max) {
                (Ok(f), None) => self.max = Some(f),
                (Ok(f), Some(m)) if f > m => self.max = Some(f),
                _ => {}
            }
        } else {
            self.min = None;
            self.max = None;
        }

        let (result_min, result_max, result_delta) =
            match (self.min, self.max) {
                (Some(min), Some(max)) => {
                    (Item::F64(min), Item::F64(max), Item::F64(max - min))
                }
                _ => (Item::Nothing, Item::Nothing, Item::Nothing),
            };
        self.result_min = result_min;
        self.result_max = result_max;
        self.result_delta = result_delta;
        Ok(())
    }
}

/// Description for the fifo bin.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Description;

impl BinDescription for Description {
    type Bin = Bin;

    fn check_validity(
        &self,
        _scope: &Scope,
        _get_calibration: &mut dyn GetCalibration,
    ) -> Result<()> {
        Ok(())
    }

    fn bin_type(&self) -> &'static str {
        BIN_TYPE
    }
}

impl SinkNames for Description {
    fn sink_names(&self) -> IndexSet<String> {
        build_names(&[SINK_INPUT, SINK_MIN_ITEMS, SINK_MAX_ITEMS])
    }
}

impl SourceNames for Description {
    fn source_names(&self) -> Result<IndexSet<String>> {
        Ok(build_names(&[SOURCE_MIN, SOURCE_MAX, SOURCE_DELTA]))
    }
}

impl SourceSinkBinDescription for Description {
    fn build_bin(
        &self,
        scope: &Scope,
        env: &mut dyn BinBuildEnvironment,
    ) -> Result<Self::Bin> {
        Ok(Bin {
            scope: scope.clone(),
            source_input: env.resolve(SINK_INPUT)?,
            source_min_items: env.resolve(SINK_MIN_ITEMS)?,
            source_max_items: env.resolve(SINK_MAX_ITEMS)?,
            fifo: VecDeque::new(),
            min: None,
            max: None,
            result_min: Item::Nothing,
            result_max: Item::Nothing,
            result_delta: Item::Nothing,
        })
    }
}

impl WriteDotSimple for Description {}

#[cfg(test)]
mod tests {
    use super::Description;
    use crate::bins::{directsource, verificationsink};
    use crate::Item as I;
    use crate::{run_bin, Result};
    use indexmap::indexset;

    #[test]
    fn simulate() -> Result<()> {
        use crate::Item::*;

        let input = directsource::Description {
            columns: indexset![
                "input".to_string(),
                "min_items".to_string(),
                "max_items".to_string(),
            ],
            rows: vec![
                vec![Nothing, Nothing, Nothing],
                vec![Nothing, I::from(5f64), I::from(5f64)],
                vec![Nothing, I::from(5f64), I::from(5f64)],
                vec![I::from(1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(0f64), I::from(5f64), I::from(5f64)],
                vec![I::from(0f64), I::from(5f64), I::from(5f64)],
                vec![I::from(0f64), I::from(5f64), I::from(5f64)],
                vec![I::from(0f64), I::from(5f64), I::from(5f64)],
                vec![I::from(0f64), I::from(5f64), I::from(5f64)],
                vec![I::from(0f64), I::from(5f64), I::from(5f64)],
                vec![I::from(1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-1f64), I::from(5f64), I::from(5f64)],
                vec![I::from(10f64), I::from(5f64), I::from(5f64)],
                vec![I::from(-9f64), I::from(5f64), I::from(5f64)],
            ]
            .into(),
        };
        let verification = verificationsink::Description {
            columns: indexset![
                "min".to_string(),
                "max".to_string(),
                "delta".to_string(),
            ],
            expected: vec![
                vec![Nothing, Nothing, Nothing],
                vec![Nothing, Nothing, Nothing],
                vec![Nothing, Nothing, Nothing],
                vec![Nothing, Nothing, Nothing],
                vec![I::from(1f64), I::from(1f64), I::from(0f64)],
                vec![I::from(0f64), I::from(1f64), I::from(1f64)],
                vec![I::from(0f64), I::from(1f64), I::from(1f64)],
                vec![I::from(0f64), I::from(1f64), I::from(1f64)],
                vec![I::from(0f64), I::from(1f64), I::from(1f64)],
                vec![I::from(0f64), I::from(0f64), I::from(0f64)],
                vec![I::from(0f64), I::from(0f64), I::from(0f64)],
                vec![I::from(0f64), I::from(1f64), I::from(1f64)],
                vec![I::from(-1f64), I::from(1f64), I::from(2f64)],
                vec![I::from(-1f64), I::from(1f64), I::from(2f64)],
                vec![I::from(-1f64), I::from(1f64), I::from(2f64)],
                vec![I::from(-1f64), I::from(1f64), I::from(2f64)],
                vec![I::from(-1f64), I::from(-1f64), I::from(0f64)],
                vec![I::from(-1f64), I::from(-1f64), I::from(0f64)],
                vec![I::from(-1f64), I::from(-1f64), I::from(0f64)],
                vec![I::from(-1f64), I::from(10f64), I::from(11f64)],
                vec![I::from(-9f64), I::from(10f64), I::from(19f64)],
            ]
            .into(),
        };

        run_bin(&input, &Description {}, &verification)
    }
}