pictorus-blocks 0.0.0

Implementations of Pictorus blocks.
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

use crate::traits::Float;
use pictorus_block_data::BlockData;
use pictorus_traits::{GeneratorBlock, Scalar};

#[derive(Debug, Clone)]
/// Outputs a signal that ramps up linearly from a specified start time at a specified rate.
pub struct RampBlock<T: Scalar + Float> {
    phantom: core::marker::PhantomData<T>,
    pub data: BlockData,
}

impl<T: Scalar + Float> Default for RampBlock<T>
where
    f64: From<T>,
{
    fn default() -> Self {
        Self {
            phantom: core::marker::PhantomData,
            data: BlockData::from_scalar(f64::from(T::default())),
        }
    }
}

impl<T> GeneratorBlock for RampBlock<T>
where
    T: Scalar + Float,
    f64: From<T>,
{
    type Parameters = Parameters<T>;
    type Output = T;

    fn generate(
        &mut self,
        parameters: &Self::Parameters,
        context: &dyn pictorus_traits::Context,
    ) -> pictorus_traits::PassBy<Self::Output> {
        let time = T::from_duration(context.time());
        let ramp_val =
            parameters.rate * num_traits::Float::max(time - parameters.start_time, T::zero());
        self.data = BlockData::from_scalar(ramp_val.into());
        ramp_val
    }
}

#[derive(Debug)]
pub struct Parameters<T: Scalar + Float> {
    pub start_time: T,
    pub rate: T,
}

impl<T: Scalar + Float> Parameters<T> {
    pub fn new(start_time: T, rate: T) -> Self {
        Self { start_time, rate }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::testing::{StubContext, StubRuntime};
    use core::time::Duration;

    #[test]
    fn test_ramp_block() {
        let mut block = RampBlock::<f64>::default();
        let mut runtime = StubRuntime::new(StubContext::new(
            Duration::from_secs_f64(0.0),
            None,
            Duration::from_secs_f64(1.0),
        ));

        // Slope is 1.0, start time is 0.0
        let parameters = Parameters::new(0.0, 1.0);
        let output = block.generate(&parameters, &runtime.context());
        assert_eq!(output, 0.0);

        runtime.tick();
        let output = block.generate(&parameters, &runtime.context());
        assert_eq!(output, 1.0);

        runtime.tick();
        let output = block.generate(&parameters, &runtime.context());
        assert_eq!(output, 2.0);

        // Slope is 3.0, start time is 1.0
        runtime.context.time = Duration::from_secs_f64(0.0); //reset time
        let parameters = Parameters::new(1.0, 3.0);
        let output = block.generate(&parameters, &runtime.context());
        assert_eq!(output, 0.0);

        runtime.tick();
        let output = block.generate(&parameters, &runtime.context());
        assert_eq!(output, 0.0);

        runtime.tick();
        let output = block.generate(&parameters, &runtime.context());
        assert_eq!(output, 3.0);

        runtime.tick();
        let output = block.generate(&parameters, &runtime.context());
        assert_eq!(output, 6.0);
    }
}