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_dtype::match_each_native_ptype;
7use vortex_error::VortexExpect;
8use vortex_error::VortexResult;
9use vortex_scalar::Scalar;
10
11use crate::ArrayRef;
12use crate::IntoArray;
13use crate::ToCanonical;
14use crate::arrays::PrimitiveVTable;
15use crate::arrays::primitive::PrimitiveArray;
16use crate::compute::FillNullKernel;
17use crate::compute::FillNullKernelAdapter;
18use crate::register_kernel;
19use crate::validity::Validity;
20use crate::vtable::ValidityHelper;
21
22impl FillNullKernel for PrimitiveVTable {
23    fn fill_null(&self, array: &PrimitiveArray, fill_value: &Scalar) -> VortexResult<ArrayRef> {
24        let result_validity = Validity::from(fill_value.dtype().nullability());
25
26        Ok(match array.validity() {
27            Validity::Array(is_valid) => {
28                let is_invalid = is_valid.to_bool().bit_buffer().not();
29                match_each_native_ptype!(array.ptype(), |T| {
30                    let mut buffer = array.buffer::<T>().into_mut();
31                    let fill_value = fill_value
32                        .as_primitive()
33                        .typed_value::<T>()
34                        .vortex_expect("top-level fill_null ensure non-null fill value");
35                    for invalid_index in is_invalid.set_indices() {
36                        buffer[invalid_index] = fill_value;
37                    }
38                    PrimitiveArray::new(buffer.freeze(), result_validity).into_array()
39                })
40            }
41            _ => unreachable!("checked in entry point"),
42        })
43    }
44}
45
46register_kernel!(FillNullKernelAdapter(PrimitiveVTable).lift());
47
48#[cfg(test)]
49mod test {
50    use vortex_buffer::buffer;
51    use vortex_scalar::Scalar;
52
53    use crate::IntoArray;
54    use crate::arrays::BoolArray;
55    use crate::arrays::primitive::PrimitiveArray;
56    use crate::canonical::ToCanonical;
57    use crate::compute::fill_null;
58    use crate::validity::Validity;
59
60    #[test]
61    fn fill_null_leading_none() {
62        let arr = PrimitiveArray::from_option_iter([None, Some(8u8), None, Some(10), None]);
63        let p = fill_null(arr.as_ref(), &Scalar::from(42u8))
64            .unwrap()
65            .to_primitive();
66        assert_eq!(p.as_slice::<u8>(), vec![42, 8, 42, 10, 42]);
67        assert!(p.validity_mask().all_true());
68    }
69
70    #[test]
71    fn fill_null_all_none() {
72        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
73
74        let p = fill_null(arr.as_ref(), &Scalar::from(255u8))
75            .unwrap()
76            .to_primitive();
77        assert_eq!(p.as_slice::<u8>(), vec![255, 255, 255, 255, 255]);
78        assert!(p.validity_mask().all_true());
79    }
80
81    #[test]
82    fn fill_null_nullable_non_null() {
83        let arr = PrimitiveArray::new(
84            buffer![8u8, 10, 12, 14, 16],
85            Validity::Array(BoolArray::from_iter([true, true, true, true, true]).into_array()),
86        );
87        let p = fill_null(arr.as_ref(), &Scalar::from(255u8))
88            .unwrap()
89            .to_primitive();
90        assert_eq!(p.as_slice::<u8>(), vec![8, 10, 12, 14, 16]);
91        assert!(p.validity_mask().all_true());
92    }
93
94    #[test]
95    fn fill_null_non_nullable() {
96        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
97        let p = fill_null(&arr, &Scalar::from(255u8))
98            .unwrap()
99            .to_primitive();
100        assert_eq!(p.as_slice::<u8>(), vec![8u8, 10, 12, 14, 16]);
101        assert!(p.validity_mask().all_true());
102    }
103}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
