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

vortex_array/arrays/primitive/compute/
fill_null.rs
