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