Skip to main content

vortex_array/arrays/varbin/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::VarBin;
10use crate::arrays::VarBinArray;
11use crate::arrays::varbin::VarBinArraySlotsExt;
12use crate::scalar_fn::fns::mask::MaskReduce;
13use crate::validity::Validity;
14
15impl MaskReduce for VarBin {
16    const VALIDITY_IS_METADATA_ONLY: bool = true;
17
18    fn mask(array: ArrayView<'_, VarBin>, mask: &ArrayRef) -> VortexResult<Option<ArrayRef>> {
19        // SAFETY: offsets and bytes are unchanged, and masking only removes valid rows.
20        Ok(Some(unsafe {
21            VarBinArray::new_unchecked_from_handle(
22                array.offsets().clone(),
23                array.bytes_handle().clone(),
24                array.dtype().as_nullable(),
25                array.validity()?.and(Validity::Array(mask.clone()))?,
26            )
27            .into_array()
28        }))
29    }
30}
31
32#[cfg(test)]
33mod test {
34    use crate::IntoArray;
35    use crate::VortexSessionExecute;
36    use crate::array_session;
37    use crate::arrays::VarBinArray;
38    use crate::compute::conformance::mask::test_mask_conformance;
39    use crate::dtype::DType;
40    use crate::dtype::Nullability;
41
42    #[test]
43    fn test_mask_var_bin_array() {
44        let array = VarBinArray::from_vec(
45            vec!["hello", "world", "filter", "good", "bye"],
46            DType::Utf8(Nullability::NonNullable),
47        );
48        test_mask_conformance(
49            &array.into_array(),
50            &mut array_session().create_execution_ctx(),
51        );
52
53        let array = VarBinArray::from_iter(
54            vec![Some("hello"), None, Some("filter"), Some("good"), None],
55            DType::Utf8(Nullability::Nullable),
56        );
57        test_mask_conformance(
58            &array.into_array(),
59            &mut array_session().create_execution_ctx(),
60        );
61    }
62}