Skip to main content

vortex_array/arrays/chunked/compute/
mask.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use itertools::Itertools;
5use vortex_error::VortexResult;
6
7use crate::ArrayRef;
8use crate::ExecutionCtx;
9use crate::IntoArray;
10use crate::array::ArrayView;
11use crate::arrays::Chunked;
12use crate::arrays::ChunkedArray;
13use crate::arrays::chunked::ChunkedArrayExt;
14use crate::scalar_fn::fns::mask::Mask as MaskExpr;
15use crate::scalar_fn::fns::mask::MaskKernel;
16
17impl MaskKernel for Chunked {
18    fn mask(
19        array: ArrayView<'_, Chunked>,
20        mask: &ArrayRef,
21        _ctx: &mut ExecutionCtx,
22    ) -> VortexResult<Option<ArrayRef>> {
23        let chunk_offsets = array.chunk_offset_values();
24        let chunks = array.iter_chunks().enumerate().map(|(i, chunk)| {
25            let start = chunk_offsets[i];
26            let end = chunk_offsets[i + 1];
27            let chunk_mask = mask.slice(start..end)?;
28            MaskExpr::try_new(chunk.clone(), chunk_mask).map(IntoArray::into_array)
29        });
30        chunks.process_results(|chunks| {
31            // SAFETY: masking makes every chunk's dtype nullable without changing its logical type.
32            Some(unsafe {
33                ChunkedArray::new_unchecked_sized(
34                    chunks,
35                    array.dtype().as_nullable(),
36                    array.nchunks(),
37                )
38                .into_array()
39            })
40        })
41    }
42}
43
44#[cfg(test)]
45mod test {
46    use std::sync::LazyLock;
47
48    use rstest::rstest;
49    use vortex_buffer::buffer;
50    use vortex_session::VortexSession;
51
52    use crate::IntoArray;
53    use crate::VortexSessionExecute;
54    use crate::arrays::ChunkedArray;
55    use crate::arrays::PrimitiveArray;
56    use crate::compute::conformance::mask::test_mask_conformance;
57    use crate::dtype::DType;
58    use crate::dtype::Nullability;
59    use crate::dtype::PType;
60
61    static SESSION: LazyLock<VortexSession> = LazyLock::new(VortexSession::empty);
62
63    #[rstest]
64    #[case(ChunkedArray::try_new(
65        vec![
66            buffer![0u64, 1].into_array(),
67            buffer![2_u64].into_array(),
68            PrimitiveArray::empty::<u64>(Nullability::NonNullable).into_array(),
69            buffer![3_u64, 4].into_array(),
70        ],
71        DType::Primitive(PType::U64, Nullability::NonNullable),
72    ).unwrap())]
73    #[case(ChunkedArray::try_new(
74        vec![
75            PrimitiveArray::from_option_iter([Some(1i32), None, Some(3)]).into_array(),
76            PrimitiveArray::from_option_iter([Some(4i32), Some(5)]).into_array(),
77        ],
78        DType::Primitive(PType::I32, Nullability::Nullable),
79    ).unwrap())]
80    #[case(ChunkedArray::try_new(
81        vec![
82            buffer![42u8].into_array(),
83        ],
84        DType::Primitive(PType::U8, Nullability::NonNullable),
85    ).unwrap())]
86    #[case(ChunkedArray::try_new(
87        (0..20).map(|i| buffer![i as f32, i as f32 + 0.5].into_array()),
88        DType::Primitive(PType::F32, Nullability::NonNullable),
89    ).unwrap())]
90    fn test_mask_chunked_conformance(#[case] chunked: ChunkedArray) {
91        test_mask_conformance(&chunked.into_array(), &mut SESSION.create_execution_ctx());
92    }
93}