vortex_array/arrays/primitive/compute/
fill_null.rs

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

vortex_array/arrays/primitive/compute/
fill_null.rs
