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
283
284
285
286
287
288
289
290
291
292
293
294
//!Array with variable-size list elements.

use crate::{
    array::Array,
    bitmap::{Bitmap, BitmapRef, BitmapRefMut, ValidityBitmap},
    buffer::{BufferType, VecBuffer},
    offset::{Offset, OffsetElement},
    validity::{Nullability, Validity},
    Index, Length,
};
use std::fmt::{Debug, Formatter, Result};

/// Array with variable-size list elements.
pub struct VariableSizeListArray<
    T: Array,
    const NULLABLE: bool = false,
    OffsetItem: OffsetElement = i32,
    Buffer: BufferType = VecBuffer,
>(pub Offset<T, NULLABLE, OffsetItem, Buffer>)
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>;

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Array
    for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
    Vec<T>: Nullability<NULLABLE>,
{
    type Item = <Vec<T> as Nullability<NULLABLE>>::Item;
}

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Debug
    for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>
where
    Offset<T, NULLABLE, OffsetItem, Buffer>: Debug,
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        f.debug_tuple("VariableSizeListArray")
            .field(&self.0)
            .finish()
    }
}

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Default
    for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
    Offset<T, NULLABLE, OffsetItem, Buffer>: Default,
{
    fn default() -> Self {
        Self(Offset::default())
    }
}

impl<T: Array, U, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Extend<U>
    for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
    Offset<T, NULLABLE, OffsetItem, Buffer>: Extend<U>,
{
    fn extend<I: IntoIterator<Item = U>>(&mut self, iter: I) {
        self.0.extend(iter);
    }
}

impl<T: Array, OffsetItem: OffsetElement, Buffer: BufferType>
    From<VariableSizeListArray<T, false, OffsetItem, Buffer>>
    for VariableSizeListArray<T, true, OffsetItem, Buffer>
where
    Offset<T, false, OffsetItem, Buffer>: Into<Offset<T, true, OffsetItem, Buffer>>,
{
    fn from(value: VariableSizeListArray<T, false, OffsetItem, Buffer>) -> Self {
        Self(value.0.into())
    }
}

impl<T: Array, U, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType>
    FromIterator<U> for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
    Offset<T, NULLABLE, OffsetItem, Buffer>: FromIterator<U>,
{
    fn from_iter<I: IntoIterator<Item = U>>(iter: I) -> Self {
        Self(iter.into_iter().collect())
    }
}

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Index
    for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
    Offset<T, NULLABLE, OffsetItem, Buffer>: Index,
{
    type Item<'a> = <Offset<T, NULLABLE, OffsetItem, Buffer> as Index>::Item<'a>
    where
        Self: 'a;

    unsafe fn index_unchecked(&self, index: usize) -> Self::Item<'_> {
        self.0.index_unchecked(index)
    }
}

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Length
    for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
    Offset<T, NULLABLE, OffsetItem, Buffer>: Length,
{
    fn len(&self) -> usize {
        self.0.len()
    }
}

impl<T: Array, OffsetItem: OffsetElement, Buffer: BufferType> BitmapRef
    for VariableSizeListArray<T, true, OffsetItem, Buffer>
{
    type Buffer = Buffer;

    fn bitmap_ref(&self) -> &Bitmap<Self::Buffer> {
        self.0.bitmap_ref()
    }
}

impl<T: Array, OffsetItem: OffsetElement, Buffer: BufferType> BitmapRefMut
    for VariableSizeListArray<T, true, OffsetItem, Buffer>
{
    fn bitmap_ref_mut(&mut self) -> &mut Bitmap<Self::Buffer> {
        self.0.bitmap_ref_mut()
    }
}

impl<T: Array, OffsetItem: OffsetElement, Buffer: BufferType> ValidityBitmap
    for VariableSizeListArray<T, true, OffsetItem, Buffer>
{
}

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

    #[test]
    fn from_iter() {
        let input = vec![vec![1], vec![2, 3], vec![4]];
        let array = input
            .into_iter()
            .collect::<VariableSizeListArray<FixedSizePrimitiveArray<u8>>>();
        assert_eq!(array.0.data.0, &[1, 2, 3, 4]);
        assert_eq!(array.0.offsets, &[0, 1, 3, 4]);
    }

    #[test]
    fn from_iter_nullable() {
        let input = vec![Some(vec![1]), None, Some(vec![2, 3]), Some(vec![4])];
        let array = input
            .into_iter()
            .collect::<VariableSizeListArray<FixedSizePrimitiveArray<u8>, true>>();
        assert_eq!(array.len(), 4);
        assert_eq!(array.0.data.0, &[1, 2, 3, 4]);
        assert_eq!(array.0.offsets.bitmap_ref().is_valid(0), Some(true));
        assert_eq!(array.0.offsets.bitmap_ref().is_null(1), Some(true));
        assert_eq!(array.0.offsets.bitmap_ref().is_valid(2), Some(true));
        assert_eq!(array.0.offsets.bitmap_ref().is_valid(3), Some(true));
        assert_eq!(array.0.offsets.as_ref().as_slice(), &[0, 1, 1, 3, 4]);
    }

    #[test]
    fn from_iter_nested() {
        let input = vec![vec![vec![1, 2, 3], vec![1, 2, 3]], vec![vec![4, 5, 6]]];
        let array = input
            .into_iter()
            .collect::<VariableSizeListArray<VariableSizeListArray<FixedSizePrimitiveArray<u8>>>>();
        assert_eq!(array.0.data.0.data.0, &[1, 2, 3, 1, 2, 3, 4, 5, 6]);
        assert_eq!(array.0.offsets, &[0, 2, 3]);
        assert_eq!(array.0.data.0.offsets, &[0, 3, 6, 9]);

        let input_3 = vec![vec![
            vec![vec![1, 2, 3], vec![1, 2, 3]],
            vec![vec![4, 5, 6]],
        ]];
        let array_3 = input_3.into_iter().collect::<VariableSizeListArray<
            VariableSizeListArray<VariableSizeListArray<FixedSizePrimitiveArray<u8>>>,
        >>();
        assert_eq!(array_3.0.data.0.data.0.data.0, &[1, 2, 3, 1, 2, 3, 4, 5, 6]);
        assert_eq!(array_3.0.offsets, &[0, 2]);
        assert_eq!(array_3.0.data.0.offsets, &[0, 2, 3]);
        assert_eq!(array_3.0.data.0.data.0.offsets, &[0, 3, 6, 9]);
    }

    #[test]
    fn from_iter_nested_nullable() {
        let input = vec![
            None,
            Some(vec![
                None,
                Some(vec![None, Some(vec![1, 2, 3]), Some(vec![1, 2, 3])]),
                Some(vec![None, Some(vec![4, 5, 6])]),
            ]),
        ];
        let array = input.into_iter().collect::<VariableSizeListArray<
            VariableSizeListArray<VariableSizeListArray<FixedSizePrimitiveArray<u8>, true>, true>,
            true,
        >>();
        assert_eq!(array.0.data.0.data.0.data.0, &[1, 2, 3, 1, 2, 3, 4, 5, 6]);
        assert_eq!(array.0.offsets.as_ref(), &[0, 0, 3]);
        assert_eq!(array.0.data.0.offsets.as_ref(), &[0, 0, 3, 5]);
        assert_eq!(array.0.data.0.data.0.offsets.as_ref(), &[0, 0, 3, 6, 6, 9]);
        assert_eq!(array.is_null(0), Some(true));
        assert_eq!(array.is_valid(1), Some(true));
        assert_eq!(array.0.data.is_null(0), Some(true));
        assert_eq!(array.0.data.is_valid(1), Some(true));
        assert_eq!(array.0.data.0.data.is_null(0), Some(true));
        assert_eq!(array.0.data.0.data.is_valid(1), Some(true));
        assert_eq!(array.0.data.0.data.0.is_null(0), Some(true));
        assert_eq!(array.0.data.0.data.0.is_valid(1), Some(true));

        let input_3 = vec![
            None,
            Some(vec![
                None,
                Some(vec![
                    None,
                    Some(vec![None, Some(2), Some(3)]),
                    Some(vec![None, Some(2), Some(3)]),
                ]),
                Some(vec![None, Some(vec![None, Some(5), Some(6)])]),
            ]),
        ];
        let array_3 = input_3.into_iter().collect::<VariableSizeListArray<
            VariableSizeListArray<
                VariableSizeListArray<FixedSizePrimitiveArray<u8, true>, true>,
                true,
            >,
            true,
        >>();
        assert_eq!(
            array_3.0.data.0.data.0.data.0.as_ref(),
            &[
                u8::default(),
                2,
                3,
                u8::default(),
                2,
                3,
                u8::default(),
                5,
                6
            ]
        );
        assert_eq!(array_3.0.offsets.as_ref(), &[0, 0, 3]);
        assert_eq!(array_3.0.data.0.offsets.as_ref(), &[0, 0, 3, 5]);
        assert_eq!(
            array_3.0.data.0.data.0.offsets.as_ref(),
            &[0, 0, 3, 6, 6, 9]
        );
        assert_eq!(array_3.is_null(0), Some(true));
        assert_eq!(array_3.is_valid(1), Some(true));
        assert_eq!(array_3.0.data.is_null(0), Some(true));
        assert_eq!(array_3.0.data.is_valid(1), Some(true));
        assert_eq!(array_3.0.data.0.data.is_null(0), Some(true));
        assert_eq!(array_3.0.data.0.data.is_valid(1), Some(true));
        assert_eq!(array_3.0.data.0.data.0.is_null(0), Some(true));
        assert_eq!(array_3.0.data.0.data.0.is_valid(1), Some(true));
        assert_eq!(array_3.0.data.0.data.0.data.0.is_null(0), Some(true));
        assert_eq!(array_3.0.data.0.data.0.data.0.is_valid(1), Some(true));
    }

    #[test]
    fn index() {
        let input = vec![vec![vec![1, 2, 3], vec![1, 2, 3]], vec![vec![4, 5, 6]]];
        let array = input
            .into_iter()
            .collect::<VariableSizeListArray<VariableSizeListArray<FixedSizePrimitiveArray<u8>>>>();
        assert_eq!(
            array
                .index_checked(0)
                .flatten()
                .copied()
                .collect::<Vec<_>>(),
            [1, 2, 3, 1, 2, 3]
        );
        assert_eq!(
            array
                .index_checked(1)
                .next()
                .expect("a value")
                .copied()
                .collect::<Vec<_>>(),
            [4, 5, 6]
        );
        assert!(array.index(2).is_none());
    }
}