Skip to main content

vortex_array/arrays/masked/compute/
mask.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use vortex_error::VortexResult;
5
6use crate::ArrayRef;
7use crate::IntoArray;
8use crate::array::ArrayView;
9use crate::arrays::Masked;
10use crate::arrays::masked::MaskedArraySlotsExt;
11use crate::scalar_fn::fns::mask::Mask as MaskExpr;
12use crate::scalar_fn::fns::mask::MaskReduce;
13use crate::validity::Validity;
14
15impl MaskReduce for Masked {
16    fn mask(array: ArrayView<'_, Masked>, mask: &ArrayRef) -> VortexResult<Option<ArrayRef>> {
17        // AND the existing validity mask with the new mask and push into child.
18        let combined_mask = array
19            .validity()?
20            .and(Validity::Array(mask.clone()))?
21            .to_array(array.len());
22        let masked_child = MaskExpr::try_new(array.child().clone(), combined_mask)?.into_array();
23        Ok(Some(masked_child))
24    }
25}
26
27#[cfg(test)]
28mod tests {
29    use rstest::rstest;
30
31    use crate::IntoArray;
32    use crate::VortexSessionExecute;
33    use crate::array_session;
34    use crate::arrays::MaskedArray;
35    use crate::arrays::PrimitiveArray;
36    use crate::compute::conformance::mask::test_mask_conformance;
37    use crate::validity::Validity;
38
39    #[rstest]
40    #[case(
41        MaskedArray::try_new(
42            PrimitiveArray::from_iter([1i32, 2, 3, 4, 5]).into_array(),
43            Validity::from_iter([true, true, false, true, false])
44        ).unwrap()
45    )]
46    #[case(
47        MaskedArray::try_new(
48            PrimitiveArray::from_iter([10i32, 20, 30]).into_array(),
49            Validity::AllValid
50        ).unwrap()
51    )]
52    #[case(
53        MaskedArray::try_new(
54            PrimitiveArray::from_iter(0..100).into_array(),
55            Validity::from_iter((0..100).map(|i| i % 3 != 0))
56        ).unwrap()
57    )]
58    fn test_mask_masked_conformance(#[case] array: MaskedArray) {
59        test_mask_conformance(
60            &array.into_array(),
61            &mut array_session().create_execution_ctx(),
62        );
63    }
64}