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
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

use pictorus_block_data::{BlockData as OldBlockData, FromPass};
use pictorus_traits::{GeneratorBlock, Matrix, Pass, PassBy, Scalar};

pub struct Parameters<T> {
    pub constant: T,
}

impl<T> Parameters<T> {
    pub fn new(constant: T) -> Self {
        Self { constant }
    }
}

/// Outputs a constant numeric value.
pub struct ConstantBlock<T>
where
    T: Apply,
{
    pub data: OldBlockData,
    buffer: Option<T::Output>,
}

impl<T> Default for ConstantBlock<T>
where
    T: Apply,
    OldBlockData: FromPass<T::Output>,
{
    fn default() -> Self {
        Self {
            buffer: None,
            data: <OldBlockData as FromPass<T::Output>>::from_pass(<T::Output>::default().as_by()),
        }
    }
}

impl<T> GeneratorBlock for ConstantBlock<T>
where
    T: Apply,
    OldBlockData: FromPass<T::Output>,
{
    type Output = T::Output;
    type Parameters = Parameters<T>;

    fn generate(
        &mut self,
        parameters: &Self::Parameters,
        _context: &dyn pictorus_traits::Context,
    ) -> pictorus_traits::PassBy<Self::Output> {
        let output = T::apply(&mut self.buffer, parameters);
        self.data = OldBlockData::from_pass(output);
        output
    }
}

pub trait Apply: Pass + Sized {
    type Output: Pass + Default;

    fn apply<'s>(
        store: &'s mut Option<Self::Output>,
        parameters: &Parameters<Self>,
    ) -> PassBy<'s, Self::Output>;
}

impl Apply for f64 {
    type Output = f64;

    fn apply<'s>(
        store: &'s mut Option<Self::Output>,
        parameters: &Parameters<Self>,
    ) -> PassBy<'s, Self::Output> {
        *store = Some(parameters.constant);
        parameters.constant
    }
}

impl<const NROWS: usize, const NCOLS: usize, T> Apply for Matrix<NROWS, NCOLS, T>
where
    T: Scalar,
{
    type Output = Matrix<NROWS, NCOLS, T>;

    fn apply<'s>(
        store: &'s mut Option<Self::Output>,
        parameters: &Parameters<Self>,
    ) -> PassBy<'s, Self::Output> {
        let output = store.insert(Matrix::zeroed());
        *output = parameters.constant;
        output
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::testing::StubContext;
    use pictorus_block_data::{BlockData, ToPass};

    #[test]
    fn test_constant_scalar() {
        let mut block = ConstantBlock::<f64>::default();
        let parameters = Parameters::new(3.0);
        let context = StubContext::default();

        let output = block.generate(&parameters, &context);
        assert_eq!(output, 3.0);
        assert_eq!(block.data, BlockData::from_scalar(3.0));
    }

    #[test]
    fn test_constant_vector() {
        let vector: [f64; 2] = [1.0, 2.0];

        let mut block = ConstantBlock::<Matrix<1, 2, f64>>::default();
        let parameters = Parameters::new(BlockData::from_vector(&vector).to_pass());
        let context = StubContext::default();

        let output = block.generate(&parameters, &context); // <-- Converts Vector to Matrix in from_pass
        assert_eq!(output.data[0][0], 1.0);
        assert_eq!(output.data[1][0], 2.0);

        assert_eq!(block.data, BlockData::from_matrix(&[&vector]));
    }

    #[test]
    fn test_constant_matrix() {
        let matrix_as_blockdata = BlockData::from_matrix(&[&[1.0, 2.0], &[3.0, 4.0]]);

        let mut block = ConstantBlock::<Matrix<2, 2, f64>>::default();
        let parameters = Parameters::new(matrix_as_blockdata.to_pass());
        let context = StubContext::default();

        let output = block.generate(&parameters, &context);
        assert_eq!(output.data[0][0], 1.0);
        assert_eq!(output.data[1][0], 2.0);
        assert_eq!(output.data[0][1], 3.0);
        assert_eq!(output.data[1][1], 4.0);
        assert_eq!(block.data, matrix_as_blockdata);
    }
}