vortex_array/scalar_fn/fns/binary/
boolean.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use arrow_array::cast::AsArray;
5use arrow_schema::DataType;
6use vortex_error::VortexResult;
7use vortex_error::vortex_err;
8
9use crate::Array;
10use crate::ArrayRef;
11use crate::arrays::ConstantArray;
12use crate::arrays::ConstantVTable;
13use crate::arrow::FromArrowArray;
14use crate::arrow::IntoArrowArray;
15use crate::builtins::ArrayBuiltins;
16use crate::dtype::DType;
17use crate::scalar::Scalar;
18use crate::scalar_fn::fns::operators::Operator;
19
20/// Point-wise Kleene logical _and_ between two Boolean arrays.
21#[deprecated(note = "Use `ArrayBuiltins::binary` instead")]
22pub fn and_kleene(lhs: &dyn Array, rhs: &dyn Array) -> VortexResult<ArrayRef> {
23    lhs.to_array().binary(rhs.to_array(), Operator::And)
24}
25
26/// Point-wise Kleene logical _or_ between two Boolean arrays.
27#[deprecated(note = "Use `ArrayBuiltins::binary` instead")]
28pub fn or_kleene(lhs: &dyn Array, rhs: &dyn Array) -> VortexResult<ArrayRef> {
29    lhs.to_array().binary(rhs.to_array(), Operator::Or)
30}
31
32/// Execute a Kleene boolean operation between two arrays.
33///
34/// This is the entry point for boolean operations from the binary expression.
35/// Handles constant-constant directly, otherwise falls back to Arrow.
36pub(crate) fn execute_boolean(
37    lhs: &dyn Array,
38    rhs: &dyn Array,
39    op: Operator,
40) -> VortexResult<ArrayRef> {
41    if let Some(result) = constant_boolean(lhs, rhs, op)? {
42        return Ok(result);
43    }
44    arrow_execute_boolean(lhs.to_array(), rhs.to_array(), op)
45}
46
47/// Arrow implementation for Kleene boolean operations using [`Operator`].
48fn arrow_execute_boolean(lhs: ArrayRef, rhs: ArrayRef, op: Operator) -> VortexResult<ArrayRef> {
49    let nullable = lhs.dtype().is_nullable() || rhs.dtype().is_nullable();
50
51    let lhs = lhs.into_arrow(&DataType::Boolean)?.as_boolean().clone();
52    let rhs = rhs.into_arrow(&DataType::Boolean)?.as_boolean().clone();
53
54    let array = match op {
55        Operator::And => arrow_arith::boolean::and_kleene(&lhs, &rhs)?,
56        Operator::Or => arrow_arith::boolean::or_kleene(&lhs, &rhs)?,
57        other => return Err(vortex_err!("Not a boolean operator: {other}")),
58    };
59
60    ArrayRef::from_arrow(&array, nullable)
61}
62
63/// Constant-folds a boolean operation between two constant arrays.
64fn constant_boolean(
65    lhs: &dyn Array,
66    rhs: &dyn Array,
67    op: Operator,
68) -> VortexResult<Option<ArrayRef>> {
69    let (Some(lhs), Some(rhs)) = (
70        lhs.as_opt::<ConstantVTable>(),
71        rhs.as_opt::<ConstantVTable>(),
72    ) else {
73        return Ok(None);
74    };
75
76    let length = lhs.len();
77    let nullable = lhs.dtype().is_nullable() || rhs.dtype().is_nullable();
78    let lhs_val = lhs.scalar().as_bool().value();
79    let rhs_val = rhs
80        .scalar()
81        .as_bool_opt()
82        .ok_or_else(|| vortex_err!("expected rhs to be boolean"))?
83        .value();
84
85    let result = match op {
86        Operator::And => match (lhs_val, rhs_val) {
87            (Some(false), _) | (_, Some(false)) => Some(false),
88            (None, _) | (_, None) => None,
89            (Some(l), Some(r)) => Some(l & r),
90        },
91        Operator::Or => match (lhs_val, rhs_val) {
92            (Some(true), _) | (_, Some(true)) => Some(true),
93            (None, _) | (_, None) => None,
94            (Some(l), Some(r)) => Some(l | r),
95        },
96        other => return Err(vortex_err!("Not a boolean operator: {other}")),
97    };
98
99    let scalar = result
100        .map(|b| Scalar::bool(b, nullable.into()))
101        .unwrap_or_else(|| Scalar::null(DType::Bool(nullable.into())));
102
103    Ok(Some(ConstantArray::new(scalar, length).to_array()))
104}
105
106#[cfg(test)]
107mod tests {
108    use rstest::rstest;
109
110    use crate::ArrayRef;
111    use crate::IntoArray;
112    use crate::arrays::BoolArray;
113    use crate::builtins::ArrayBuiltins;
114    use crate::canonical::ToCanonical;
115    use crate::scalar_fn::fns::operators::Operator;
116
117    #[rstest]
118    #[case(
119        BoolArray::from_iter([Some(true), Some(true), Some(false), Some(false)]).into_array(),
120        BoolArray::from_iter([Some(true), Some(false), Some(true), Some(false)]).into_array(),
121    )]
122    #[case(
123        BoolArray::from_iter([Some(true), Some(false), Some(true), Some(false)]).into_array(),
124        BoolArray::from_iter([Some(true), Some(true), Some(false), Some(false)]).into_array(),
125    )]
126    fn test_or(#[case] lhs: ArrayRef, #[case] rhs: ArrayRef) {
127        let r = lhs.binary(rhs, Operator::Or).unwrap();
128        let r = r.to_bool().into_array();
129
130        let v0 = r.scalar_at(0).unwrap().as_bool().value();
131        let v1 = r.scalar_at(1).unwrap().as_bool().value();
132        let v2 = r.scalar_at(2).unwrap().as_bool().value();
133        let v3 = r.scalar_at(3).unwrap().as_bool().value();
134
135        assert!(v0.unwrap());
136        assert!(v1.unwrap());
137        assert!(v2.unwrap());
138        assert!(!v3.unwrap());
139    }
140
141    #[rstest]
142    #[case(
143        BoolArray::from_iter([Some(true), Some(true), Some(false), Some(false)]).into_array(),
144        BoolArray::from_iter([Some(true), Some(false), Some(true), Some(false)]).into_array(),
145    )]
146    #[case(
147        BoolArray::from_iter([Some(true), Some(false), Some(true), Some(false)]).into_array(),
148        BoolArray::from_iter([Some(true), Some(true), Some(false), Some(false)]).into_array(),
149    )]
150    fn test_and(#[case] lhs: ArrayRef, #[case] rhs: ArrayRef) {
151        let r = lhs
152            .binary(rhs, Operator::And)
153            .unwrap()
154            .to_bool()
155            .into_array();
156
157        let v0 = r.scalar_at(0).unwrap().as_bool().value();
158        let v1 = r.scalar_at(1).unwrap().as_bool().value();
159        let v2 = r.scalar_at(2).unwrap().as_bool().value();
160        let v3 = r.scalar_at(3).unwrap().as_bool().value();
161
162        assert!(v0.unwrap());
163        assert!(!v1.unwrap());
164        assert!(!v2.unwrap());
165        assert!(!v3.unwrap());
166    }
167}
vortex_array/scalar_fn/fns/binary/boolean.rs

vortex_array/scalar_fn/fns/binary/
boolean.rs
