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 std::sync::LazyLock;
35
36    use vortex_session::VortexSession;
37
38    use crate::IntoArray;
39    use crate::VortexSessionExecute;
40    use crate::arrays::VarBinArray;
41    use crate::compute::conformance::mask::test_mask_conformance;
42    use crate::dtype::DType;
43    use crate::dtype::Nullability;
44
45    static SESSION: LazyLock<VortexSession> = LazyLock::new(VortexSession::empty);
46
47    #[test]
48    fn test_mask_var_bin_array() {
49        let array = VarBinArray::from_vec(
50            vec!["hello", "world", "filter", "good", "bye"],
51            DType::Utf8(Nullability::NonNullable),
52        );
53        test_mask_conformance(&array.into_array(), &mut SESSION.create_execution_ctx());
54
55        let array = VarBinArray::from_iter(
56            vec![Some("hello"), None, Some("filter"), Some("good"), None],
57            DType::Utf8(Nullability::Nullable),
58        );
59        test_mask_conformance(&array.into_array(), &mut SESSION.create_execution_ctx());
60    }
61}