Skip to main content

vortex_alp/alp_rd/compute/
mask.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use vortex_array::ArrayRef;
5use vortex_array::ArrayView;
6use vortex_array::IntoArray;
7use vortex_array::arrays::scalar_fn::ScalarFnFactoryExt;
8use vortex_array::scalar_fn::EmptyOptions;
9use vortex_array::scalar_fn::fns::mask::Mask as MaskExpr;
10use vortex_array::scalar_fn::fns::mask::MaskReduce;
11use vortex_error::VortexResult;
12
13use crate::ALPRD;
14use crate::ALPRDArrayExt;
15
16impl MaskReduce for ALPRD {
17    #[allow(clippy::disallowed_methods)]
18    fn mask(array: ArrayView<'_, Self>, mask: &ArrayRef) -> VortexResult<Option<ArrayRef>> {
19        let masked_left_parts = MaskExpr.try_new_array(
20            array.left_parts().len(),
21            EmptyOptions,
22            [array.left_parts().clone(), mask.clone()],
23        )?;
24        Ok(Some(
25            ALPRD::try_new(
26                array.dtype().as_nullable(),
27                masked_left_parts,
28                array.left_parts_dictionary().clone(),
29                array.right_parts().clone(),
30                array.right_bit_width(),
31                array.left_parts_patches(),
32            )?
33            .into_array(),
34        ))
35    }
36}
37
38#[cfg(test)]
39mod tests {
40    use std::sync::LazyLock;
41
42    use rstest::rstest;
43    use vortex_array::IntoArray;
44    use vortex_array::VortexSessionExecute;
45    use vortex_array::array_session;
46    use vortex_array::arrays::PrimitiveArray;
47    use vortex_array::compute::conformance::mask::test_mask_conformance;
48    use vortex_session::VortexSession;
49
50    use crate::ALPRDFloat;
51    use crate::RDEncoder;
52
53    static SESSION: LazyLock<VortexSession> = LazyLock::new(|| {
54        let session = array_session();
55        crate::initialize(&session);
56        session
57    });
58
59    #[rstest]
60    #[case(0.1f32, 0.2f32, 3e25f32)]
61    #[case(0.1f64, 0.2f64, 3e100f64)]
62    fn test_mask_simple<T: ALPRDFloat>(#[case] a: T, #[case] b: T, #[case] outlier: T) {
63        let mut ctx = SESSION.create_execution_ctx();
64        test_mask_conformance(
65            &RDEncoder::new(&[a, b])
66                .encode(PrimitiveArray::from_iter([a, b, outlier, b, outlier]).as_view())
67                .into_array(),
68            &mut ctx,
69        );
70    }
71
72    #[rstest]
73    #[case(0.1f32, 3e25f32)]
74    #[case(0.5f64, 1e100f64)]
75    fn test_mask_with_nulls<T: ALPRDFloat>(#[case] a: T, #[case] outlier: T) {
76        let mut ctx = SESSION.create_execution_ctx();
77        test_mask_conformance(
78            &RDEncoder::new(&[a])
79                .encode(
80                    PrimitiveArray::from_option_iter([Some(a), None, Some(outlier), Some(a), None])
81                        .as_view(),
82                )
83                .into_array(),
84            &mut ctx,
85        );
86    }
87}