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 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use arrow_array::{make_array, Array, ArrayRef, BooleanArray};
use arrow_buffer::buffer::{bitwise_bin_op_helper, bitwise_unary_op_helper};
use arrow_buffer::{BooleanBuffer, NullBuffer};
use arrow_schema::{ArrowError, DataType};
/// Copies original array, setting validity bit to false if a secondary comparison
/// boolean array is set to true
///
/// Typically used to implement NULLIF.
pub fn nullif(left: &dyn Array, right: &BooleanArray) -> Result<ArrayRef, ArrowError> {
let left_data = left.to_data();
if left_data.len() != right.len() {
return Err(ArrowError::ComputeError(
"Cannot perform comparison operation on arrays of different length".to_string(),
));
}
let len = left_data.len();
if len == 0 || left_data.data_type() == &DataType::Null {
return Ok(make_array(left_data));
}
// left=0 (null) right=null output bitmap=null
// left=0 right=1 output bitmap=null
// left=1 (set) right=null output bitmap=set (passthrough)
// left=1 right=1 & comp=true output bitmap=null
// left=1 right=1 & comp=false output bitmap=set
//
// Thus: result = left null bitmap & (!right_values | !right_bitmap)
// OR left null bitmap & !(right_values & right_bitmap)
// Compute right_values & right_bitmap
let right = match right.nulls() {
Some(nulls) => right.values() & nulls.inner(),
None => right.values().clone(),
};
// Compute left null bitmap & !right
let (combined, null_count) = match left_data.nulls() {
Some(left) => {
let mut valid_count = 0;
let b = bitwise_bin_op_helper(
left.buffer(),
left.offset(),
right.inner(),
right.offset(),
len,
|l, r| {
let t = l & !r;
valid_count += t.count_ones() as usize;
t
},
);
(b, len - valid_count)
}
None => {
let mut null_count = 0;
let buffer = bitwise_unary_op_helper(right.inner(), right.offset(), len, |b| {
let t = !b;
null_count += t.count_zeros() as usize;
t
});
(buffer, null_count)
}
};
let combined = BooleanBuffer::new(combined, 0, len);
// Safety:
// Counted nulls whilst computing
let nulls = unsafe { NullBuffer::new_unchecked(combined, null_count) };
let data = left_data.into_builder().nulls(Some(nulls));
// SAFETY:
// Only altered null mask
Ok(make_array(unsafe { data.build_unchecked() }))
}
#[cfg(test)]
mod tests {
use super::*;
use arrow_array::builder::{BooleanBuilder, Int32Builder, StructBuilder};
use arrow_array::cast::AsArray;
use arrow_array::types::Int32Type;
use arrow_array::{Int32Array, NullArray, StringArray, StructArray};
use arrow_data::ArrayData;
use arrow_schema::{Field, Fields};
use rand::{thread_rng, Rng};
#[test]
fn test_nullif_int_array() {
let a = Int32Array::from(vec![Some(15), None, Some(8), Some(1), Some(9)]);
let comp = BooleanArray::from(vec![Some(false), None, Some(true), Some(false), None]);
let res = nullif(&a, &comp).unwrap();
let expected = Int32Array::from(vec![
Some(15),
None,
None, // comp true, slot 2 turned into null
Some(1),
// Even though comp array / right is null, should still pass through original value
// comp true, slot 2 turned into null
Some(9),
]);
let res = res.as_primitive::<Int32Type>();
assert_eq!(&expected, res);
}
#[test]
fn test_nullif_null_array() {
assert_eq!(
nullif(&NullArray::new(0), &BooleanArray::new_null(0))
.unwrap()
.as_ref(),
&NullArray::new(0)
);
assert_eq!(
nullif(
&NullArray::new(3),
&BooleanArray::from(vec![Some(false), Some(true), None]),
)
.unwrap()
.as_ref(),
&NullArray::new(3)
);
}
#[test]
fn test_nullif_int_array_offset() {
let a = Int32Array::from(vec![None, Some(15), Some(8), Some(1), Some(9)]);
let a = a.slice(1, 3); // Some(15), Some(8), Some(1)
let a = a.as_any().downcast_ref::<Int32Array>().unwrap();
let comp = BooleanArray::from(vec![
Some(false),
Some(false),
Some(false),
None,
Some(true),
Some(false),
None,
]);
let comp = comp.slice(2, 3); // Some(false), None, Some(true)
let comp = comp.as_any().downcast_ref::<BooleanArray>().unwrap();
let res = nullif(a, comp).unwrap();
let expected = Int32Array::from(vec![
Some(15), // False => keep it
Some(8), // None => keep it
None, // true => None
]);
let res = res.as_primitive::<Int32Type>();
assert_eq!(&expected, res)
}
#[test]
fn test_nullif_string() {
let s = StringArray::from_iter([
Some("hello"),
None,
Some("world"),
Some("a"),
Some("b"),
None,
None,
]);
let select = BooleanArray::from_iter([
Some(true),
Some(true),
Some(false),
Some(true),
Some(false),
Some(false),
None,
]);
let a = nullif(&s, &select).unwrap();
let r: Vec<_> = a.as_string::<i32>().iter().collect();
assert_eq!(
r,
vec![None, None, Some("world"), None, Some("b"), None, None]
);
let s = s.slice(2, 3);
let select = select.slice(1, 3);
let a = nullif(&s, &select).unwrap();
let r: Vec<_> = a.as_string::<i32>().iter().collect();
assert_eq!(r, vec![None, Some("a"), None]);
}
#[test]
fn test_nullif_int_large_left_offset() {
let a = Int32Array::from(vec![
Some(-1), // 0
Some(-1),
Some(-1),
Some(-1),
Some(-1),
Some(-1),
Some(-1),
Some(-1),
Some(-1), // 8
Some(-1),
Some(-1),
Some(-1),
Some(-1),
Some(-1),
Some(-1),
Some(-1),
None, // 16
Some(15), // 17
Some(8),
Some(1),
Some(9),
]);
let a = a.slice(17, 3); // Some(15), Some(8), Some(1)
let comp = BooleanArray::from(vec![
Some(false),
Some(false),
Some(false),
None,
Some(true),
Some(false),
None,
]);
let comp = comp.slice(2, 3); // Some(false), None, Some(true)
let comp = comp.as_any().downcast_ref::<BooleanArray>().unwrap();
let res = nullif(&a, comp).unwrap();
let res = res.as_any().downcast_ref::<Int32Array>().unwrap();
let expected = Int32Array::from(vec![
Some(15), // False => keep it
Some(8), // None => keep it
None, // true => None
]);
assert_eq!(&expected, res)
}
#[test]
fn test_nullif_int_large_right_offset() {
let a = Int32Array::from(vec![
None, // 0
Some(15), // 1
Some(8),
Some(1),
Some(9),
]);
let a = a.slice(1, 3); // Some(15), Some(8), Some(1)
let comp = BooleanArray::from(vec![
Some(false), // 0
Some(false),
Some(false),
Some(false),
Some(false),
Some(false),
Some(false),
Some(false),
Some(false), // 8
Some(false),
Some(false),
Some(false),
Some(false),
Some(false),
Some(false),
Some(false),
Some(false), // 16
Some(false), // 17
Some(false), // 18
None,
Some(true),
Some(false),
None,
]);
let comp = comp.slice(18, 3); // Some(false), None, Some(true)
let comp = comp.as_any().downcast_ref::<BooleanArray>().unwrap();
let res = nullif(&a, comp).unwrap();
let res = res.as_any().downcast_ref::<Int32Array>().unwrap();
let expected = Int32Array::from(vec![
Some(15), // False => keep it
Some(8), // None => keep it
None, // true => None
]);
assert_eq!(&expected, res)
}
#[test]
fn test_nullif_boolean_offset() {
let a = BooleanArray::from(vec![
None, // 0
Some(true), // 1
Some(false),
Some(true),
Some(true),
]);
let a = a.slice(1, 3); // Some(true), Some(false), Some(true)
let comp = BooleanArray::from(vec![
Some(false), // 0
Some(false), // 1
Some(false), // 2
None,
Some(true),
Some(false),
None,
]);
let comp = comp.slice(2, 3); // Some(false), None, Some(true)
let comp = comp.as_any().downcast_ref::<BooleanArray>().unwrap();
let res = nullif(&a, comp).unwrap();
let res = res.as_any().downcast_ref::<BooleanArray>().unwrap();
let expected = BooleanArray::from(vec![
Some(true), // False => keep it
Some(false), // None => keep it
None, // true => None
]);
assert_eq!(&expected, res)
}
struct Foo {
a: Option<i32>,
b: Option<bool>,
/// Whether the entry should be valid.
is_valid: bool,
}
impl Foo {
fn new_valid(a: i32, b: bool) -> Foo {
Self {
a: Some(a),
b: Some(b),
is_valid: true,
}
}
fn new_null() -> Foo {
Self {
a: None,
b: None,
is_valid: false,
}
}
}
/// Struct Array equality is a bit weird -- we need to have the *child values*
/// correct even if the enclosing struct indicates it is null. But we
/// also need the top level is_valid bits to be correct.
fn create_foo_struct(values: Vec<Foo>) -> StructArray {
let mut struct_array = StructBuilder::new(
Fields::from(vec![
Field::new("a", DataType::Int32, true),
Field::new("b", DataType::Boolean, true),
]),
vec![
Box::new(Int32Builder::with_capacity(values.len())),
Box::new(BooleanBuilder::with_capacity(values.len())),
],
);
for value in values {
struct_array
.field_builder::<Int32Builder>(0)
.unwrap()
.append_option(value.a);
struct_array
.field_builder::<BooleanBuilder>(1)
.unwrap()
.append_option(value.b);
struct_array.append(value.is_valid);
}
struct_array.finish()
}
#[test]
fn test_nullif_struct_slices() {
let struct_array = create_foo_struct(vec![
Foo::new_valid(7, true),
Foo::new_valid(15, false),
Foo::new_valid(8, true),
Foo::new_valid(12, false),
Foo::new_null(),
Foo::new_null(),
Foo::new_valid(42, true),
]);
// Some({a: 15, b: false}), Some({a: 8, b: true}), Some({a: 12, b: false}),
// None, None
let struct_array = struct_array.slice(1, 5);
let comp = BooleanArray::from(vec![
Some(false), // 0
Some(false), // 1
Some(false), // 2
None,
Some(true),
Some(false),
None,
]);
let comp = comp.slice(2, 5); // Some(false), None, Some(true), Some(false), None
let comp = comp.as_any().downcast_ref::<BooleanArray>().unwrap();
let res = nullif(&struct_array, comp).unwrap();
let res = res.as_any().downcast_ref::<StructArray>().unwrap();
let expected = create_foo_struct(vec![
// Some(false) -> keep
Foo::new_valid(15, false),
// None -> keep
Foo::new_valid(8, true),
// Some(true) -> null out. But child values are still there.
Foo {
a: Some(12),
b: Some(false),
is_valid: false,
},
// Some(false) -> keep, but was null
Foo::new_null(),
// None -> keep, but was null
Foo::new_null(),
]);
assert_eq!(&expected, res);
}
#[test]
fn test_nullif_no_nulls() {
let a = Int32Array::from(vec![Some(15), Some(7), Some(8), Some(1), Some(9)]);
let comp = BooleanArray::from(vec![Some(false), None, Some(true), Some(false), None]);
let res = nullif(&a, &comp).unwrap();
let res = res.as_primitive::<Int32Type>();
let expected = Int32Array::from(vec![Some(15), Some(7), None, Some(1), Some(9)]);
assert_eq!(res, &expected);
}
#[test]
fn nullif_empty() {
let a = Int32Array::from(ArrayData::new_empty(&DataType::Int32));
let mask = BooleanArray::from(ArrayData::new_empty(&DataType::Boolean));
let res = nullif(&a, &mask).unwrap();
assert_eq!(res.as_ref(), &a);
}
fn test_nullif(values: &Int32Array, filter: &BooleanArray) {
let expected: Int32Array = values
.iter()
.zip(filter.iter())
.map(|(a, b)| match b {
Some(true) => None,
Some(false) | None => a,
})
.collect();
let r = nullif(values, filter).unwrap();
let r_data = r.to_data();
r_data.validate().unwrap();
assert_eq!(r.as_ref(), &expected);
}
#[test]
fn nullif_fuzz() {
let mut rng = thread_rng();
let arrays = [
Int32Array::from(vec![0; 128]),
(0..128).map(|_| rng.gen_bool(0.5).then_some(0)).collect(),
];
for a in arrays {
let a_slices = [(0, 128), (64, 64), (0, 64), (32, 32), (0, 0), (32, 0)];
for (a_offset, a_length) in a_slices {
let a = a.slice(a_offset, a_length);
for i in 1..65 {
let b_start_offset = rng.gen_range(0..i);
let b_end_offset = rng.gen_range(0..i);
let b: BooleanArray = (0..a_length + b_start_offset + b_end_offset)
.map(|_| rng.gen_bool(0.5).then(|| rng.gen_bool(0.5)))
.collect();
let b = b.slice(b_start_offset, a_length);
test_nullif(&a, &b);
}
}
}
}
}