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 std::sync::LazyLock;
30
31    use rstest::rstest;
32    use vortex_session::VortexSession;
33
34    use crate::IntoArray;
35    use crate::VortexSessionExecute;
36    use crate::arrays::MaskedArray;
37    use crate::arrays::PrimitiveArray;
38    use crate::compute::conformance::mask::test_mask_conformance;
39    use crate::validity::Validity;
40
41    static SESSION: LazyLock<VortexSession> = LazyLock::new(VortexSession::empty);
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            &mut SESSION.create_execution_ctx(),
49        ).unwrap()
50    )]
51    #[case(
52        MaskedArray::try_new(
53            PrimitiveArray::from_iter([10i32, 20, 30]).into_array(),
54            Validity::AllValid,
55            &mut SESSION.create_execution_ctx(),
56        ).unwrap()
57    )]
58    #[case(
59        MaskedArray::try_new(
60            PrimitiveArray::from_iter(0..100).into_array(),
61            Validity::from_iter((0..100).map(|i| i % 3 != 0)),
62            &mut SESSION.create_execution_ctx(),
63        ).unwrap()
64    )]
65    fn test_mask_masked_conformance(#[case] array: MaskedArray) {
66        test_mask_conformance(&array.into_array(), &mut SESSION.create_execution_ctx());
67    }
68}