vortex_array/arrays/dict/compute/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4mod cast;
5mod compare;
6mod fill_null;
7mod is_constant;
8mod is_sorted;
9mod like;
10mod mask;
11mod min_max;
12pub(crate) mod rules;
13mod slice;
14
15use vortex_error::VortexResult;
16use vortex_mask::Mask;
17
18use super::DictArray;
19use super::DictVTable;
20use super::TakeExecute;
21use crate::Array;
22use crate::ArrayRef;
23use crate::ExecutionCtx;
24use crate::IntoArray;
25use crate::arrays::filter::FilterReduce;
26
27impl TakeExecute for DictVTable {
28    fn take(
29        array: &DictArray,
30        indices: &dyn Array,
31        _ctx: &mut ExecutionCtx,
32    ) -> VortexResult<Option<ArrayRef>> {
33        let codes = array
34            .codes()
35            .take(indices.to_array())?
36            .to_canonical()?
37            .into_array();
38        // SAFETY: selecting codes doesn't change the invariants of DictArray
39        // Preserve all_values_referenced since taking codes doesn't affect which values are referenced
40        Ok(Some(unsafe {
41            DictArray::new_unchecked(codes, array.values().clone()).into_array()
42        }))
43    }
44}
45
46impl FilterReduce for DictVTable {
47    fn filter(array: &DictArray, mask: &Mask) -> VortexResult<Option<ArrayRef>> {
48        let codes = array.codes().filter(mask.clone())?;
49
50        // SAFETY: filtering codes doesn't change invariants
51        // Preserve all_values_referenced since filtering codes doesn't affect which values are referenced
52        Ok(Some(unsafe {
53            DictArray::new_unchecked(codes, array.values().clone()).into_array()
54        }))
55    }
56}
57
58#[cfg(test)]
59mod test {
60    #[allow(unused_imports)]
61    use itertools::Itertools;
62    use vortex_buffer::buffer;
63
64    use crate::Array;
65    use crate::ArrayRef;
66    use crate::IntoArray;
67    use crate::ToCanonical;
68    use crate::accessor::ArrayAccessor;
69    use crate::arrays::ConstantArray;
70    use crate::arrays::PrimitiveArray;
71    use crate::arrays::VarBinArray;
72    use crate::arrays::VarBinViewArray;
73    use crate::assert_arrays_eq;
74    use crate::builders::dict::dict_encode;
75    use crate::builtins::ArrayBuiltins;
76    use crate::compute::conformance::filter::test_filter_conformance;
77    use crate::compute::conformance::mask::test_mask_conformance;
78    use crate::compute::conformance::take::test_take_conformance;
79    use crate::dtype::DType;
80    use crate::dtype::Nullability;
81    use crate::dtype::PType::I32;
82    use crate::scalar_fn::fns::operators::Operator;
83    #[test]
84    fn canonicalise_nullable_primitive() {
85        let values: Vec<Option<i32>> = (0..65)
86            .map(|i| match i % 3 {
87                0 => Some(42),
88                1 => Some(-9),
89                2 => None,
90                _ => unreachable!(),
91            })
92            .collect();
93
94        let dict = dict_encode(PrimitiveArray::from_option_iter(values.clone()).as_ref()).unwrap();
95        let actual = dict.to_primitive();
96
97        let expected = PrimitiveArray::from_option_iter(values);
98
99        assert_arrays_eq!(actual, expected);
100    }
101
102    #[test]
103    fn canonicalise_non_nullable_primitive_32_unique_values() {
104        let unique_values: Vec<i32> = (0..32).collect();
105        let expected = PrimitiveArray::from_iter((0..1000).map(|i| unique_values[i % 32]));
106
107        let dict = dict_encode(expected.as_ref()).unwrap();
108        let actual = dict.to_primitive();
109
110        assert_arrays_eq!(actual, expected);
111    }
112
113    #[test]
114    fn canonicalise_non_nullable_primitive_100_unique_values() {
115        let unique_values: Vec<i32> = (0..100).collect();
116        let expected = PrimitiveArray::from_iter((0..1000).map(|i| unique_values[i % 100]));
117
118        let dict = dict_encode(expected.as_ref()).unwrap();
119        let actual = dict.to_primitive();
120
121        assert_arrays_eq!(actual, expected);
122    }
123
124    #[test]
125    fn canonicalise_nullable_varbin() {
126        let reference = VarBinViewArray::from_iter(
127            vec![Some("a"), Some("b"), None, Some("a"), None, Some("b")],
128            DType::Utf8(Nullability::Nullable),
129        );
130        assert_eq!(reference.len(), 6);
131        let dict = dict_encode(reference.as_ref()).unwrap();
132        let flattened_dict = dict.to_varbinview();
133        assert_eq!(
134            flattened_dict.with_iterator(|iter| iter
135                .map(|slice| slice.map(|s| s.to_vec()))
136                .collect::<Vec<_>>()),
137            reference.with_iterator(|iter| iter
138                .map(|slice| slice.map(|s| s.to_vec()))
139                .collect::<Vec<_>>()),
140        );
141    }
142
143    fn sliced_dict_array() -> ArrayRef {
144        let reference = PrimitiveArray::from_option_iter([
145            Some(42),
146            Some(-9),
147            None,
148            Some(42),
149            Some(1),
150            Some(5),
151        ]);
152        let dict = dict_encode(reference.as_ref()).unwrap();
153        dict.slice(1..4).unwrap()
154    }
155
156    #[test]
157    fn compare_sliced_dict() {
158        use crate::arrays::BoolArray;
159        let sliced = sliced_dict_array();
160        let compared = sliced
161            .binary(ConstantArray::new(42, 3).to_array(), Operator::Eq)
162            .unwrap();
163
164        let expected = BoolArray::from_iter([Some(false), None, Some(true)]);
165        assert_arrays_eq!(compared, expected.to_array());
166    }
167
168    #[test]
169    fn test_mask_dict_array() {
170        let array = dict_encode(&buffer![2, 0, 2, 0, 10].into_array()).unwrap();
171        test_mask_conformance(array.as_ref());
172
173        let array = dict_encode(
174            PrimitiveArray::from_option_iter([Some(2), None, Some(2), Some(0), Some(10)]).as_ref(),
175        )
176        .unwrap();
177        test_mask_conformance(array.as_ref());
178
179        let array = dict_encode(
180            &VarBinArray::from_iter(
181                [
182                    Some("hello"),
183                    None,
184                    Some("hello"),
185                    Some("good"),
186                    Some("good"),
187                ],
188                DType::Utf8(Nullability::Nullable),
189            )
190            .into_array(),
191        )
192        .unwrap();
193        test_mask_conformance(array.as_ref());
194    }
195
196    #[test]
197    fn test_filter_dict_array() {
198        let array = dict_encode(&buffer![2, 0, 2, 0, 10].into_array()).unwrap();
199        test_filter_conformance(array.as_ref());
200
201        let array = dict_encode(
202            PrimitiveArray::from_option_iter([Some(2), None, Some(2), Some(0), Some(10)]).as_ref(),
203        )
204        .unwrap();
205        test_filter_conformance(array.as_ref());
206
207        let array = dict_encode(
208            &VarBinArray::from_iter(
209                [
210                    Some("hello"),
211                    None,
212                    Some("hello"),
213                    Some("good"),
214                    Some("good"),
215                ],
216                DType::Utf8(Nullability::Nullable),
217            )
218            .into_array(),
219        )
220        .unwrap();
221        test_filter_conformance(array.as_ref());
222    }
223
224    #[test]
225    fn test_take_dict() {
226        let array = dict_encode(buffer![1, 2].into_array().as_ref()).unwrap();
227
228        assert_eq!(
229            array
230                .take(PrimitiveArray::from_option_iter([Option::<i32>::None]).to_array())
231                .unwrap()
232                .dtype(),
233            &DType::Primitive(I32, Nullability::Nullable)
234        );
235    }
236
237    #[test]
238    fn test_take_dict_conformance() {
239        let array = dict_encode(&buffer![2, 0, 2, 0, 10].into_array()).unwrap();
240        test_take_conformance(array.as_ref());
241
242        let array = dict_encode(
243            PrimitiveArray::from_option_iter([Some(2), None, Some(2), Some(0), Some(10)]).as_ref(),
244        )
245        .unwrap();
246        test_take_conformance(array.as_ref());
247
248        let array = dict_encode(
249            &VarBinArray::from_iter(
250                [
251                    Some("hello"),
252                    None,
253                    Some("hello"),
254                    Some("good"),
255                    Some("good"),
256                ],
257                DType::Utf8(Nullability::Nullable),
258            )
259            .into_array(),
260        )
261        .unwrap();
262        test_take_conformance(array.as_ref());
263    }
264}
265
266#[cfg(test)]
267mod tests {
268    use rstest::rstest;
269    use vortex_buffer::buffer;
270
271    use crate::IntoArray;
272    use crate::arrays::PrimitiveArray;
273    use crate::arrays::VarBinArray;
274    use crate::arrays::dict::DictArray;
275    use crate::builders::dict::dict_encode;
276    use crate::compute::conformance::consistency::test_array_consistency;
277    use crate::dtype::DType;
278    use crate::dtype::Nullability;
279
280    #[rstest]
281    // Primitive arrays
282    #[case::dict_i32(dict_encode(&buffer![1i32, 2, 3, 2, 1].into_array()).unwrap())]
283    #[case::dict_nullable_codes(DictArray::try_new(
284        buffer![0u32, 1, 2, 2, 0].into_array(),
285        PrimitiveArray::from_option_iter([Some(10), Some(20), None]).into_array(),
286    ).unwrap())]
287    #[case::dict_nullable_values(dict_encode(
288        PrimitiveArray::from_option_iter([Some(1i32), None, Some(2), Some(1), None]).as_ref()
289    ).unwrap())]
290    #[case::dict_u64(dict_encode(&buffer![100u64, 200, 100, 300, 200].into_array()).unwrap())]
291    // String arrays
292    #[case::dict_str(dict_encode(
293        &VarBinArray::from_iter(
294            ["hello", "world", "hello", "test", "world"].map(Some),
295            DType::Utf8(Nullability::NonNullable),
296        ).into_array()
297    ).unwrap())]
298    #[case::dict_nullable_str(dict_encode(
299        &VarBinArray::from_iter(
300            [Some("hello"), None, Some("world"), Some("hello"), None],
301            DType::Utf8(Nullability::Nullable),
302        ).into_array()
303    ).unwrap())]
304    // Edge cases
305    #[case::dict_single(dict_encode(&buffer![42i32].into_array()).unwrap())]
306    #[case::dict_all_same(dict_encode(&buffer![5i32, 5, 5, 5, 5].into_array()).unwrap())]
307    #[case::dict_large(dict_encode(&PrimitiveArray::from_iter((0..1000).map(|i| i % 10)).into_array()).unwrap())]
308    fn test_dict_consistency(#[case] array: DictArray) {
309        test_array_consistency(array.as_ref());
310    }
311}
vortex_array/arrays/dict/compute/mod.rs

vortex_array/arrays/dict/compute/
mod.rs
