vortex_array/arrays/primitive/compute/
fill_null.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::ops::Not;
5
6use vortex_buffer::BufferMut;
7use vortex_dtype::{Nullability, match_each_native_ptype};
8use vortex_error::{VortexExpect, VortexResult};
9use vortex_scalar::Scalar;
10
11use crate::arrays::primitive::PrimitiveArray;
12use crate::arrays::{ConstantArray, PrimitiveVTable};
13use crate::compute::{FillNullKernel, FillNullKernelAdapter};
14use crate::validity::Validity;
15use crate::vtable::ValidityHelper;
16use crate::{ArrayRef, IntoArray, ToCanonical, register_kernel};
17
18impl FillNullKernel for PrimitiveVTable {
19    fn fill_null(&self, array: &PrimitiveArray, fill_value: &Scalar) -> VortexResult<ArrayRef> {
20        let result_validity = match fill_value.dtype().nullability() {
21            Nullability::NonNullable => Validity::NonNullable,
22            Nullability::Nullable => Validity::AllValid,
23        };
24
25        Ok(match array.validity() {
26            Validity::NonNullable | Validity::AllValid => {
27                match_each_native_ptype!(array.ptype(), |T| {
28                    PrimitiveArray::new::<T>(array.buffer(), result_validity).into_array()
29                })
30            }
31            Validity::AllInvalid => {
32                ConstantArray::new(fill_value.clone(), array.len()).into_array()
33            }
34            Validity::Array(is_valid) => {
35                // TODO(danking): when we take PrimitiveArray by value, we should mutate in-place
36                let is_invalid = is_valid.to_bool()?.boolean_buffer().not();
37                match_each_native_ptype!(array.ptype(), |T| {
38                    let mut buffer = BufferMut::copy_from(array.as_slice::<T>());
39                    let fill_value = fill_value
40                        .as_primitive()
41                        .typed_value::<T>()
42                        .vortex_expect("top-level fill_null ensure non-null fill value");
43                    for invalid_index in is_invalid.set_indices() {
44                        buffer[invalid_index] = fill_value;
45                    }
46                    PrimitiveArray::new(buffer.freeze(), result_validity).into_array()
47                })
48            }
49        })
50    }
51}
52
53register_kernel!(FillNullKernelAdapter(PrimitiveVTable).lift());
54
55#[cfg(test)]
56mod test {
57    use vortex_buffer::buffer;
58    use vortex_scalar::Scalar;
59
60    use crate::IntoArray;
61    use crate::arrays::BoolArray;
62    use crate::arrays::primitive::PrimitiveArray;
63    use crate::canonical::ToCanonical;
64    use crate::compute::fill_null;
65    use crate::validity::Validity;
66
67    #[test]
68    fn fill_null_leading_none() {
69        let arr = PrimitiveArray::from_option_iter([None, Some(8u8), None, Some(10), None]);
70        let p = fill_null(arr.as_ref(), &Scalar::from(42u8))
71            .unwrap()
72            .to_primitive()
73            .unwrap();
74        assert_eq!(p.as_slice::<u8>(), vec![42, 8, 42, 10, 42]);
75        assert!(p.validity_mask().unwrap().all_true());
76    }
77
78    #[test]
79    fn fill_null_all_none() {
80        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
81
82        let p = fill_null(arr.as_ref(), &Scalar::from(255u8))
83            .unwrap()
84            .to_primitive()
85            .unwrap();
86        assert_eq!(p.as_slice::<u8>(), vec![255, 255, 255, 255, 255]);
87        assert!(p.validity_mask().unwrap().all_true());
88    }
89
90    #[test]
91    fn fill_null_nullable_non_null() {
92        let arr = PrimitiveArray::new(
93            buffer![8u8, 10, 12, 14, 16],
94            Validity::Array(BoolArray::from_iter([true, true, true, true, true]).into_array()),
95        );
96        let p = fill_null(arr.as_ref(), &Scalar::from(255u8))
97            .unwrap()
98            .to_primitive()
99            .unwrap();
100        assert_eq!(p.as_slice::<u8>(), vec![8, 10, 12, 14, 16]);
101        assert!(p.validity_mask().unwrap().all_true());
102    }
103
104    #[test]
105    fn fill_null_non_nullable() {
106        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
107        let p = fill_null(&arr, &Scalar::from(255u8))
108            .unwrap()
109            .to_primitive()
110            .unwrap();
111        assert_eq!(p.as_slice::<u8>(), vec![8u8, 10, 12, 14, 16]);
112        assert!(p.validity_mask().unwrap().all_true());
113    }
114}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
