flatk 0.5.2

Flat layout abstraction toolkit.
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

/// This suite of tests checks that subsets and chunked sets can be composed.
use flatk::*;

#[test]
fn chunked_index() {
    let v = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11];
    let s = Chunked::from_offsets(vec![0, 3, 4, 6, 9, 11], v.clone());
    let s = s.view();

    assert_eq!(s.get(2), Some(&s[2])); // Single index

    let r = s.get(1..3).unwrap(); // Range
    let mut iter = r.iter();
    assert_eq!(Some(&[4][..]), iter.next());
    assert_eq!(Some(&[5, 6][..]), iter.next());
    assert_eq!(None, iter.next());

    let r = s.get(3..).unwrap(); // RangeFrom
    let mut iter = r.iter();
    assert_eq!(Some(&[7, 8, 9][..]), iter.next());
    assert_eq!(Some(&[10, 11][..]), iter.next());
    assert_eq!(None, iter.next());

    let r = s.get(..2).unwrap(); // RangeTo
    let mut iter = r.iter();
    assert_eq!(Some(&[1, 2, 3][..]), iter.next());
    assert_eq!(Some(&[4][..]), iter.next());
    assert_eq!(None, iter.next());

    assert_eq!(s.view(), s.get(..).unwrap()); // RangeFull
    assert_eq!(s.view(), s.view().get(..).unwrap());

    let r = s.get(1..=2).unwrap(); // RangeInclusive
    let mut iter = r.iter();
    assert_eq!(Some(&[4][..]), iter.next());
    assert_eq!(Some(&[5, 6][..]), iter.next());
    assert_eq!(None, iter.next());

    let r = s.get(..=1).unwrap(); // RangeToInclusive
    let mut iter = r.iter();
    assert_eq!(Some(&[1, 2, 3][..]), iter.next());
    assert_eq!(Some(&[4][..]), iter.next());
    assert_eq!(None, iter.next());
}

#[test]
fn chunked_isolate_mut() {
    let mut v = vec![1, 2, 3, 4, 0, 0, 7, 8, 9, 10, 11];
    let mut s = Chunked::from_offsets(vec![0, 3, 4, 6, 9, 11], v.view_mut());

    s.view_mut()
        .try_isolate(2)
        .unwrap()
        .copy_from_slice(&[5, 6]); // Single index
    assert_eq!(
        *s.data(),
        vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11].as_slice()
    );
}

#[test]
fn chunked_subset() {
    let v: Vec<usize> = (1..12).collect();
    let subset = Subset::from_indices(vec![1, 3, 5, 7, 9, 10], v);
    let chunked = Chunked::from_offsets(vec![0, 2, 6], subset);
    let mut iter = chunked.iter();
    let sub = iter.next().unwrap();
    let mut sub_iter = sub.iter();
    assert_eq!(Some(&2), sub_iter.next());
    assert_eq!(Some(&4), sub_iter.next());
    assert_eq!(None, sub_iter.next());
    let sub = iter.next().unwrap();
    let mut sub_iter = sub.iter();
    assert_eq!(Some(&6), sub_iter.next());
    assert_eq!(Some(&8), sub_iter.next());
    assert_eq!(Some(&10), sub_iter.next());
    assert_eq!(Some(&11), sub_iter.next());
    assert_eq!(None, sub_iter.next());
}

#[test]
fn subset_chunked() {
    let v: Vec<usize> = (1..12).collect();
    let chunked = Chunked::from_offsets(vec![0, 2, 4, 7, 10, 11], v);
    let subset = Subset::from_indices(vec![1, 3, 4], chunked);
    let subset = subset.view();
    let mut iter = subset.iter();
    assert_eq!(Some(&[3, 4][..]), iter.next());
    assert_eq!(Some(&[8, 9, 10][..]), iter.next());
    assert_eq!(Some(&[11][..]), iter.next());
    assert_eq!(None, iter.next());
}

#[test]
fn subset_clone_into() {
    let v: Vec<usize> = (1..=15).collect();
    let subset = Subset::from_indices(vec![1, 3, 4, 5], v);
    let mut other = vec![0; 4];
    subset.clone_into_other(&mut other);
    assert_eq!(other, vec![2, 4, 5, 6]);
}

#[test]
fn subset_unichunked_clone_into() {
    let v: Vec<usize> = (1..=15).collect();
    let uni = Chunked3::from_flat(v);
    let subset = Subset::from_indices(vec![1, 3, 4], uni);
    let mut other = Chunked3::from_flat(vec![0; 9]);
    subset.clone_into_other(&mut other);
    assert_eq!(other.into_inner(), vec![4, 5, 6, 10, 11, 12, 13, 14, 15]);
}

#[test]
fn subset_unichunked_const() {
    let v: Vec<usize> = (1..=15).collect();
    let uni = Chunked3::from_flat(v.clone());
    let subset = Subset::from_indices(vec![1, 3, 4], uni.view());
    let mut iter = subset.iter();
    assert_eq!(Some(&[4, 5, 6]), iter.next());
    assert_eq!(Some(&[10, 11, 12]), iter.next());
    assert_eq!(Some(&[13, 14, 15]), iter.next());
    assert_eq!(None, iter.next());

    // Verify that this works for views as well.
    let uni = Chunked3::from_flat(v.as_slice());
    let subset = Subset::from_unique_ordered_indices(&[1, 3, 4][..], uni);
    let mut iter = subset.iter();
    assert_eq!(Some(&[4, 5, 6]), iter.next());
    assert_eq!(Some(&[10, 11, 12]), iter.next());
    assert_eq!(Some(&[13, 14, 15]), iter.next());
    assert_eq!(None, iter.next());
}

#[test]
fn subset_unichunked_mut() {
    let v: Vec<usize> = (1..=15).collect();
    let mut uni = Chunked3::from_flat(v.clone());
    let mut subset = Subset::from_indices(vec![0, 2, 4], uni.view_mut());
    {
        let subset_view = subset.view();
        let mut subset_iter = subset_view.iter();
        assert_eq!(Some(&[1, 2, 3]), subset_iter.next());
        assert_eq!(Some(&[7, 8, 9]), subset_iter.next());
        assert_eq!(Some(&[13, 14, 15]), subset_iter.next());
        assert_eq!(None, subset_iter.next());
    }
    *subset.view_mut().isolate(1) = [0; 3];
    assert_eq!(&[0, 0, 0], subset.view().at(1));

    // Verify that this works for views as well.
    let mut subset = Subset::from_unique_ordered_indices(&[0, 2, 4][..], uni.view_mut());
    {
        let subset_view = subset.view();
        let mut subset_iter = subset_view.iter();
        assert_eq!(Some(&[1, 2, 3]), subset_iter.next());
        assert_eq!(Some(&[0; 3]), subset_iter.next());
        assert_eq!(Some(&[13, 14, 15]), subset_iter.next());
        assert_eq!(None, subset_iter.next());
    }

    // Try with iter_mut this time setting all elements to 1.
    for elem in subset.iter_mut() {
        *elem = [1; 3];
    }

    for i in 0..3 {
        assert_eq!(&[1, 1, 1], subset.view().at(i));
    }
}

#[test]
fn subset_unichunked_index() {
    let v: Vec<usize> = (1..=15).collect();
    let uni = Chunked3::from_flat(v);
    let subset = Subset::from_indices(vec![1, 3, 4], uni.view());
    assert_eq!(Some(&[4, 5, 6]), subset.get(0));
    assert_eq!(Some(&[10, 11, 12]), subset.get(1));
    assert_eq!(Some(&[13, 14, 15]), subset.get(2));
    assert_eq!(&[4, 5, 6], subset.at(0));
    assert_eq!(&[10, 11, 12], subset.at(1));
    assert_eq!(&[13, 14, 15], subset.at(2));
    assert_eq!([4, 5, 6], subset[0]);
    assert_eq!([10, 11, 12], subset[1]);
    assert_eq!([13, 14, 15], subset[2]);

    let v: Vec<usize> = (1..=15).collect();
    let mut uni = Chunked3::from_flat(v);
    let indices = vec![1, 3, 4];
    let mut subset = Subset::from_unique_ordered_indices(indices.as_slice(), uni.view_mut());
    subset[1] = [0, 0, 0];
    let subset_view = subset.view();
    assert_eq!(Some(&[4, 5, 6]), subset_view.get(0));
    assert_eq!(Some(&[0, 0, 0]), subset_view.get(1));
    assert_eq!(Some(&[13, 14, 15]), subset_view.get(2));
    assert_eq!(&[4, 5, 6], subset_view.at(0));
    assert_eq!(&[0, 0, 0], subset_view.at(1));
    assert_eq!(&[13, 14, 15], subset_view.at(2));
    assert_eq!([4, 5, 6], subset[0]);
    assert_eq!([0, 0, 0], subset[1]);
    assert_eq!([13, 14, 15], subset[2]);
}

fn get<'a>(x: ChunkedView<'a, &'a [usize]>) -> &'a [usize] {
    x.at(1)
}

#[test]
fn chunked_return_get_result_from_fn() {
    let v: Vec<_> = (1..=10).collect();
    let s = Chunked::from_sizes(vec![1, 4, 5], v);
    assert_eq!(get(s.view()), &[2, 3, 4, 5]);
}

// Test that we can create and return a subset of a substructure of a nested chunked set
fn subset<'a, 'b>(
    indices: &'a [usize],
    x: ChunkedView<'b, ChunkedView<'b, Chunked3<&'b [usize]>>>,
) -> SubsetView<'a, Chunked3<&'b [usize]>> {
    Subset::from_unique_ordered_indices(indices, x.at(1).at(1))
}

#[test]
fn subset_nested_chunked() {
    let v: Vec<_> = (1..=45).collect();
    let u = Chunked3::from_flat(v);
    let c1 = Chunked::from_sizes(vec![1, 4, 5, 5], u);
    let c2 = Chunked::from_sizes(vec![1, 2, 1], c1);
    let subset = subset(&[0, 1], c2.view());
    assert_eq!(subset[0], [16, 17, 18]);
    assert_eq!(subset[1], [19, 20, 21]);
}

#[test]
fn subset_nested_unichunked() {
    let v: Vec<_> = (1..=24).collect();
    let u = Chunked3::from_flat(v);
    let set = Chunked2::from_flat(u);
    let subset = Subset::from_unique_ordered_indices(&[0, 2], set);
    let subset = subset.view();
    assert_eq!(subset.at(0).at(0), &[1, 2, 3]);
    assert_eq!(subset.at(0).at(1), &[4, 5, 6]);
    assert_eq!(subset.at(1).at(0), &[13, 14, 15]);
    assert_eq!(subset.at(1).at(1), &[16, 17, 18]);
}