vortex_array/arrays/masked/compute/
take.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use vortex_error::VortexResult;
5use vortex_scalar::Scalar;
6
7use crate::arrays::{MaskedArray, MaskedVTable};
8use crate::compute::{TakeKernel, TakeKernelAdapter, fill_null, take};
9use crate::vtable::ValidityHelper;
10use crate::{Array, ArrayRef, IntoArray, register_kernel};
11
12impl TakeKernel for MaskedVTable {
13    fn take(&self, array: &MaskedArray, indices: &dyn Array) -> VortexResult<ArrayRef> {
14        let taken_child = if !indices.all_valid() {
15            // This is safe because we'll mask out these positions in the validity
16            let filled_take = fill_null(
17                indices,
18                &Scalar::default_value(indices.dtype().clone().as_nonnullable()),
19            )?;
20            take(&array.child, &filled_take)?
21        } else {
22            take(&array.child, indices)?
23        };
24
25        // Compute the new validity by taking from array's validity and merging with indices validity
26        let taken_validity = array.validity().take(indices)?;
27
28        // Construct new MaskedArray
29        Ok(MaskedArray::try_new(taken_child, taken_validity)?.into_array())
30    }
31}
32
33register_kernel!(TakeKernelAdapter(MaskedVTable).lift());
34
35#[cfg(test)]
36mod tests {
37    use rstest::rstest;
38
39    use crate::IntoArray;
40    use crate::arrays::{MaskedArray, PrimitiveArray};
41    use crate::compute::conformance::take::test_take_conformance;
42    use crate::validity::Validity;
43
44    #[rstest]
45    #[case(
46        MaskedArray::try_new(
47            PrimitiveArray::from_iter([1i32, 2, 3, 4, 5]).into_array(),
48            Validity::from_iter([true, true, false, true, false])
49        ).unwrap()
50    )]
51    #[case(
52        MaskedArray::try_new(
53            PrimitiveArray::from_iter([10i32, 20, 30]).into_array(),
54            Validity::AllValid
55        ).unwrap()
56    )]
57    #[case(
58        MaskedArray::try_new(
59            PrimitiveArray::from_iter(0..100).into_array(),
60            Validity::from_iter((0..100).map(|i| i % 3 != 0))
61        ).unwrap()
62    )]
63    fn test_take_masked_conformance(#[case] array: MaskedArray) {
64        test_take_conformance(array.as_ref());
65    }
66}