1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
//! Boolean operators of [Kleene logic](https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics).
use crate::datatypes::DataType;
use crate::scalar::BooleanScalar;
use crate::{
array::{Array, BooleanArray},
bitmap::{binary, quaternary, ternary, unary, Bitmap, MutableBitmap},
};
/// Logical 'or' operation on two arrays with [Kleene logic](https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics)
/// # Panics
/// This function panics iff the arrays have a different length
/// # Example
///
/// ```rust
/// use arrow2::array::BooleanArray;
/// use arrow2::compute::boolean_kleene::or;
///
/// let a = BooleanArray::from(&[Some(true), Some(false), None]);
/// let b = BooleanArray::from(&[None, None, None]);
/// let or_ab = or(&a, &b);
/// assert_eq!(or_ab, BooleanArray::from(&[Some(true), None, None]));
/// ```
pub fn or(lhs: &BooleanArray, rhs: &BooleanArray) -> BooleanArray {
assert_eq!(
lhs.len(),
rhs.len(),
"lhs and rhs must have the same length"
);
let lhs_values = lhs.values();
let rhs_values = rhs.values();
let lhs_validity = lhs.validity();
let rhs_validity = rhs.validity();
let validity = match (lhs_validity, rhs_validity) {
(Some(lhs_validity), Some(rhs_validity)) => {
Some(quaternary(
lhs_values,
rhs_values,
lhs_validity,
rhs_validity,
// see https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
|lhs, rhs, lhs_v, rhs_v| {
// A = T
(lhs & lhs_v) |
// B = T
(rhs & rhs_v) |
// A = F & B = F
(!lhs & lhs_v) & (!rhs & rhs_v)
},
))
}
(Some(lhs_validity), None) => {
// B != U
Some(ternary(
lhs_values,
rhs_values,
lhs_validity,
// see https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
|lhs, rhs, lhs_v| {
// A = T
(lhs & lhs_v) |
// B = T
rhs |
// A = F & B = F
(!lhs & lhs_v) & !rhs
},
))
}
(None, Some(rhs_validity)) => {
Some(ternary(
lhs_values,
rhs_values,
rhs_validity,
// see https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
|lhs, rhs, rhs_v| {
// A = T
lhs |
// B = T
(rhs & rhs_v) |
// A = F & B = F
!lhs & (!rhs & rhs_v)
},
))
}
(None, None) => None,
};
BooleanArray::new(DataType::Boolean, lhs_values | rhs_values, validity)
}
/// Logical 'and' operation on two arrays with [Kleene logic](https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics)
/// # Panics
/// This function panics iff the arrays have a different length
/// # Example
///
/// ```rust
/// use arrow2::array::BooleanArray;
/// use arrow2::compute::boolean_kleene::and;
///
/// let a = BooleanArray::from(&[Some(true), Some(false), None]);
/// let b = BooleanArray::from(&[None, None, None]);
/// let and_ab = and(&a, &b);
/// assert_eq!(and_ab, BooleanArray::from(&[None, Some(false), None]));
/// ```
pub fn and(lhs: &BooleanArray, rhs: &BooleanArray) -> BooleanArray {
assert_eq!(
lhs.len(),
rhs.len(),
"lhs and rhs must have the same length"
);
let lhs_values = lhs.values();
let rhs_values = rhs.values();
let lhs_validity = lhs.validity();
let rhs_validity = rhs.validity();
let validity = match (lhs_validity, rhs_validity) {
(Some(lhs_validity), Some(rhs_validity)) => {
Some(quaternary(
lhs_values,
rhs_values,
lhs_validity,
rhs_validity,
// see https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
|lhs, rhs, lhs_v, rhs_v| {
// B = F
(!rhs & rhs_v) |
// A = F
(!lhs & lhs_v) |
// A = T & B = T
(lhs & lhs_v) & (rhs & rhs_v)
},
))
}
(Some(lhs_validity), None) => {
Some(ternary(
lhs_values,
rhs_values,
lhs_validity,
// see https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
|lhs, rhs, lhs_v| {
// B = F
!rhs |
// A = F
(!lhs & lhs_v) |
// A = T & B = T
(lhs & lhs_v) & rhs
},
))
}
(None, Some(rhs_validity)) => {
Some(ternary(
lhs_values,
rhs_values,
rhs_validity,
// see https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
|lhs, rhs, rhs_v| {
// B = F
(!rhs & rhs_v) |
// A = F
!lhs |
// A = T & B = T
lhs & (rhs & rhs_v)
},
))
}
(None, None) => None,
};
BooleanArray::new(DataType::Boolean, lhs_values & rhs_values, validity)
}
/// Logical 'or' operation on an array and a scalar value with [Kleene logic](https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics)
/// # Example
///
/// ```rust
/// use arrow2::array::BooleanArray;
/// use arrow2::scalar::BooleanScalar;
/// use arrow2::compute::boolean_kleene::or_scalar;
///
/// let array = BooleanArray::from(&[Some(true), Some(false), None]);
/// let scalar = BooleanScalar::new(Some(false));
/// let result = or_scalar(&array, &scalar);
/// assert_eq!(result, BooleanArray::from(&[Some(true), Some(false), None]));
/// ```
pub fn or_scalar(array: &BooleanArray, scalar: &BooleanScalar) -> BooleanArray {
match scalar.value() {
Some(true) => {
let mut values = MutableBitmap::new();
values.extend_constant(array.len(), true);
BooleanArray::new(DataType::Boolean, values.into(), None)
}
Some(false) => array.clone(),
None => {
let values = array.values();
let validity = match array.validity() {
Some(validity) => binary(values, validity, |value, validity| validity & value),
None => unary(values, |value| value),
};
BooleanArray::new(DataType::Boolean, values.clone(), Some(validity))
}
}
}
/// Logical 'and' operation on an array and a scalar value with [Kleene logic](https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics)
/// # Example
///
/// ```rust
/// use arrow2::array::BooleanArray;
/// use arrow2::scalar::BooleanScalar;
/// use arrow2::compute::boolean_kleene::and_scalar;
///
/// let array = BooleanArray::from(&[Some(true), Some(false), None]);
/// let scalar = BooleanScalar::new(None);
/// let result = and_scalar(&array, &scalar);
/// assert_eq!(result, BooleanArray::from(&[None, Some(false), None]));
/// ```
pub fn and_scalar(array: &BooleanArray, scalar: &BooleanScalar) -> BooleanArray {
match scalar.value() {
Some(true) => array.clone(),
Some(false) => {
let values = Bitmap::new_zeroed(array.len());
BooleanArray::new(DataType::Boolean, values, None)
}
None => {
let values = array.values();
let validity = match array.validity() {
Some(validity) => binary(values, validity, |value, validity| validity & !value),
None => unary(values, |value| !value),
};
BooleanArray::new(DataType::Boolean, array.values().clone(), Some(validity))
}
}
}
/// Returns whether any of the values in the array is `true`
pub fn any(array: &BooleanArray) -> bool {
if array.is_empty() {
false
} else if array.validity().is_some() {
array.into_iter().any(|v| v == Some(true))
} else {
let vals = array.values();
vals.unset_bits() != vals.len()
}
}
/// Returns whether all values in the array are `true`
pub fn all(array: &BooleanArray) -> bool {
if array.is_empty() || array.null_count() > 0 {
false
} else {
let vals = array.values();
vals.unset_bits() == 0
}
}