blok 0.0.23

Types and traits for graphlike 3D arrays, designed for visual thinkers.
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


use super::*;
use crate::types::Row;


/// Functions for cloning the layer to and from different divisions.
impl<B: Block> Layer<B> {

    /// Clone the layer into an array of rows.
    pub fn clone_into_rows(&self) -> Vec<Row<B>> {
        // Cannot clone into blocks if Layout is corrupted.
        assert_eq!(self.layout().total(), self.blocks().len());
        
        let mut clone = self.blocks().clone();
        let mut rows = Vec::new();

        for r in self.layout().iter() {
            let (row, rest) = clone.split_at(*r);
            rows.push(Row::wrap(row.to_vec()));
            clone = rest.to_vec();
        }

        rows
    }

    /// Overwrite a layer's values from an array of rows.
    pub fn set_from_rows(&mut self, rows: Vec<Row<B>>) {
        self.layout = rows.iter()
            .map(|v| v.len())
            .collect();

        self.blocks = rows.into_iter()
            .flat_map(|r| r.blocks)
            .collect();
    }

    /// Clone the layer into a matrix of blocks.
    pub fn clone_into_blocks(&self) -> Vec<Vec<B>> {
        // Cannot clone into blocks if Layout is corrupted.
        assert_eq!(self.layout().total(), self.blocks().len());
        
        let mut clone = self.blocks().clone();
        let mut blocks = Vec::new();

        for r in self.layout().iter() {
            let (row, rest) = clone.split_at(*r);
            blocks.push(row.to_vec());
            clone = rest.to_vec();
        }

        blocks
    }

    /// Overwrite a layer's values from a matrix of blocks.
    pub fn set_from_blocks(&mut self, blocks: Vec<Vec<B>>) {
        self.layout = blocks.iter()
            .map(|v| v.len())
            .collect();

        self.blocks = blocks.into_iter()
            .flatten()
            .collect();
    }

    // TODO: clone_row

}


/*  UNIT TESTS  */
#[cfg(test)] mod test {

    use crate::{ layout, Layout, Layer, Block };
    use crate::block::test::TestBlock;

    ///
    #[test] fn clone_layer_into_blocks_test() {
        let mut layer = Layer::<TestBlock>::new();
        let layout = layout![1, 2];
        let blocks = vec![TestBlock::create(&"test".to_string()); 3];
        layer.set_from_layout(layout, blocks)
            .expect("Set layer successful");
        
        let cloned_blocks = layer.clone_into_blocks();
        assert_eq!(cloned_blocks[0].len(), 1);
        assert_eq!(cloned_blocks[1].len(), 2);

        let mut other_layer = Layer::<TestBlock>::new();
        other_layer.set_from_blocks(cloned_blocks);

        assert_eq!(other_layer.layout[0], 1);
        assert_eq!(other_layer.layout[1], 2);
        assert_eq!(other_layer.blocks.len(), 3);
    }

    ///
    #[test] #[should_panic] fn bad_clone_layer_into_blocks_test() {
        let mut layer = Layer::<TestBlock>::new();
        let layout = layout![1, 2];
        let blocks = vec![TestBlock::create(&"test".to_string()); 3];
        layer.set_from_layout(layout, blocks)
            .expect("Set layer successful");

        // Should panic if the blocks and layout do not match:
        layer.blocks.pop();
        let _cloned_blocks = layer.clone_into_blocks();
    }

    ///
    #[test] fn clone_layer_into_rows_test() {
        let mut layer = Layer::<TestBlock>::new();
        let layout = layout![1, 2];
        let blocks = vec![TestBlock::create(&"test".to_string()); 3];
        layer.set_from_layout(layout, blocks)
            .expect("Set layer successful");
        
        let cloned_rows = layer.clone_into_rows();
        assert_eq!(cloned_rows[0].len(), 1);
        assert_eq!(cloned_rows[1].len(), 2);

        let mut other_layer = Layer::<TestBlock>::new();
        other_layer.set_from_rows(cloned_rows);

        assert_eq!(other_layer.layout[0], 1);
        assert_eq!(other_layer.layout[1], 2);
        assert_eq!(other_layer.blocks.len(), 3);
    }

    ///
    #[test] #[should_panic] fn bad_clone_layer_into_rows_test() {
        let mut layer = Layer::<TestBlock>::new();
        let layout = layout![1, 2];
        let blocks = vec![TestBlock::create(&"test".to_string()); 3];
        layer.set_from_layout(layout, blocks)
            .expect("Set layer successful");

        // Should panic if the blocks and layout do not match:
        layer.blocks.pop();
        let _cloned_blocks = layer.clone_into_rows();
    }

}