vortex_array/arrays/varbin/compute/
compare.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use arrow_array::{BinaryArray, StringArray};
5use arrow_ord::cmp;
6use itertools::Itertools;
7use vortex_buffer::BitBuffer;
8use vortex_dtype::{DType, IntegerPType, match_each_integer_ptype};
9use vortex_error::{VortexExpect as _, VortexResult, vortex_bail, vortex_err};
10
11use crate::arrays::{BoolArray, PrimitiveArray, VarBinArray, VarBinVTable};
12use crate::arrow::{Datum, from_arrow_array_with_len};
13use crate::compute::{
14    CompareKernel, CompareKernelAdapter, Operator, compare, compare_lengths_to_empty,
15};
16use crate::vtable::ValidityHelper;
17use crate::{Array, ArrayRef, IntoArray, ToCanonical, register_kernel};
18
19// This implementation exists so we can have custom translation of RHS to arrow that's not the same as IntoCanonical
20impl CompareKernel for VarBinVTable {
21    fn compare(
22        &self,
23        lhs: &VarBinArray,
24        rhs: &dyn Array,
25        operator: Operator,
26    ) -> VortexResult<Option<ArrayRef>> {
27        if let Some(rhs_const) = rhs.as_constant() {
28            let nullable = lhs.dtype().is_nullable() || rhs_const.dtype().is_nullable();
29            let len = lhs.len();
30
31            let rhs_is_empty = match rhs_const.dtype() {
32                DType::Binary(_) => rhs_const
33                    .as_binary()
34                    .is_empty()
35                    .vortex_expect("RHS should not be null"),
36                DType::Utf8(_) => rhs_const
37                    .as_utf8()
38                    .is_empty()
39                    .vortex_expect("RHS should not be null"),
40                _ => vortex_bail!("VarBinArray can only have type of Binary or Utf8"),
41            };
42
43            if rhs_is_empty {
44                let buffer = match operator {
45                    Operator::Gte => BitBuffer::new_set(len), // Every possible value is >= ""
46                    Operator::Lt => BitBuffer::new_unset(len), // No value is < ""
47                    Operator::Eq | Operator::NotEq | Operator::Gt | Operator::Lte => {
48                        let lhs_offsets = lhs.offsets().to_primitive();
49                        match_each_integer_ptype!(lhs_offsets.ptype(), |P| {
50                            compare_offsets_to_empty::<P>(lhs_offsets, operator)
51                        })
52                    }
53                };
54
55                return Ok(Some(
56                    BoolArray::from_bit_buffer(
57                        buffer,
58                        lhs.validity()
59                            .clone()
60                            .union_nullability(rhs.dtype().nullability()),
61                    )
62                    .into_array(),
63                ));
64            }
65
66            let lhs = Datum::try_new(lhs.as_ref())?;
67
68            // TODO(robert): Handle LargeString/Binary arrays
69            let arrow_rhs: &dyn arrow_array::Datum = match rhs_const.dtype() {
70                DType::Utf8(_) => &rhs_const
71                    .as_utf8()
72                    .value()
73                    .map(StringArray::new_scalar)
74                    .unwrap_or_else(|| arrow_array::Scalar::new(StringArray::new_null(1))),
75                DType::Binary(_) => &rhs_const
76                    .as_binary()
77                    .value()
78                    .map(BinaryArray::new_scalar)
79                    .unwrap_or_else(|| arrow_array::Scalar::new(BinaryArray::new_null(1))),
80                _ => vortex_bail!(
81                    "VarBin array RHS can only be Utf8 or Binary, given {}",
82                    rhs_const.dtype()
83                ),
84            };
85
86            let array = match operator {
87                Operator::Eq => cmp::eq(&lhs, arrow_rhs),
88                Operator::NotEq => cmp::neq(&lhs, arrow_rhs),
89                Operator::Gt => cmp::gt(&lhs, arrow_rhs),
90                Operator::Gte => cmp::gt_eq(&lhs, arrow_rhs),
91                Operator::Lt => cmp::lt(&lhs, arrow_rhs),
92                Operator::Lte => cmp::lt_eq(&lhs, arrow_rhs),
93            }
94            .map_err(|err| vortex_err!("Failed to compare VarBin array: {}", err))?;
95
96            Ok(Some(from_arrow_array_with_len(&array, len, nullable)))
97        } else if !rhs.is::<VarBinVTable>() {
98            // NOTE: If the rhs is not a VarBin array it will be canonicalized to a VarBinView
99            // Arrow doesn't support comparing VarBin to VarBinView arrays, so we convert ourselves
100            // to VarBinView and re-invoke.
101            return Ok(Some(compare(lhs.to_varbinview().as_ref(), rhs, operator)?));
102        } else {
103            Ok(None)
104        }
105    }
106}
107
108register_kernel!(CompareKernelAdapter(VarBinVTable).lift());
109
110fn compare_offsets_to_empty<P: IntegerPType>(
111    offsets: PrimitiveArray,
112    operator: Operator,
113) -> BitBuffer {
114    let lengths_iter = offsets
115        .as_slice::<P>()
116        .iter()
117        .tuple_windows()
118        .map(|(&s, &e)| e - s);
119    compare_lengths_to_empty(lengths_iter, operator)
120}
121
122#[cfg(test)]
123mod test {
124    use vortex_buffer::{BitBuffer, ByteBuffer};
125    use vortex_dtype::{DType, Nullability};
126    use vortex_scalar::Scalar;
127
128    use crate::ToCanonical;
129    use crate::arrays::{ConstantArray, VarBinArray, VarBinViewArray};
130    use crate::compute::{Operator, compare};
131
132    #[test]
133    fn test_binary_compare() {
134        let array = VarBinArray::from_iter(
135            [Some(b"abc".to_vec()), None, Some(b"def".to_vec())],
136            DType::Binary(Nullability::Nullable),
137        );
138        let result = compare(
139            array.as_ref(),
140            ConstantArray::new(
141                Scalar::binary(ByteBuffer::copy_from(b"abc"), Nullability::Nullable),
142                3,
143            )
144            .as_ref(),
145            Operator::Eq,
146        )
147        .unwrap()
148        .to_bool();
149
150        assert_eq!(
151            &result.validity_mask().to_bit_buffer(),
152            &BitBuffer::from_iter([true, false, true])
153        );
154        assert_eq!(
155            result.bit_buffer(),
156            &BitBuffer::from_iter([true, false, false])
157        );
158    }
159
160    #[test]
161    fn varbinview_compare() {
162        let array = VarBinArray::from_iter(
163            [Some(b"abc".to_vec()), None, Some(b"def".to_vec())],
164            DType::Binary(Nullability::Nullable),
165        );
166        let vbv = VarBinViewArray::from_iter(
167            [None, None, Some(b"def".to_vec())],
168            DType::Binary(Nullability::Nullable),
169        );
170        let result = compare(array.as_ref(), vbv.as_ref(), Operator::Eq)
171            .unwrap()
172            .to_bool();
173
174        assert_eq!(
175            &result.validity_mask().to_bit_buffer(),
176            &BitBuffer::from_iter([false, false, true])
177        );
178        assert_eq!(
179            result.bit_buffer(),
180            &BitBuffer::from_iter([false, true, true])
181        );
182    }
183}
184
185#[cfg(test)]
186mod tests {
187    use vortex_dtype::{DType, Nullability};
188    use vortex_scalar::Scalar;
189
190    use crate::Array;
191    use crate::arrays::{ConstantArray, VarBinArray};
192    use crate::compute::{Operator, compare};
193
194    #[test]
195    fn test_null_compare() {
196        let arr = VarBinArray::from_iter([Some("h")], DType::Utf8(Nullability::NonNullable));
197
198        let const_ = ConstantArray::new(Scalar::utf8("", Nullability::Nullable), 1);
199
200        assert_eq!(
201            compare(arr.as_ref(), const_.as_ref(), Operator::Eq)
202                .unwrap()
203                .dtype(),
204            &DType::Bool(Nullability::Nullable)
205        );
206    }
207}
vortex_array/arrays/varbin/compute/compare.rs

vortex_array/arrays/varbin/compute/
compare.rs
