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

vortex_array/arrays/primitive/compute/
fill_null.rs
