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;
9
10use crate::ArrayRef;
11use crate::ExecutionCtx;
12use crate::IntoArray;
13use crate::ToCanonical;
14use crate::arrays::PrimitiveVTable;
15use crate::arrays::primitive::PrimitiveArray;
16use crate::expr::FillNullKernel;
17use crate::scalar::Scalar;
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.to_bool().to_bit_buffer().not();
32                match_each_native_ptype!(array.ptype(), |T| {
33                    let mut buffer = array.to_buffer::<T>().into_mut();
34                    let fill_value = fill_value
35                        .as_primitive()
36                        .typed_value::<T>()
37                        .vortex_expect("top-level fill_null ensure non-null fill value");
38                    for invalid_index in is_invalid.set_indices() {
39                        buffer[invalid_index] = fill_value;
40                    }
41                    PrimitiveArray::new(buffer.freeze(), result_validity).into_array()
42                })
43            }
44            _ => unreachable!("checked in entry point"),
45        }))
46    }
47}
48
49#[cfg(test)]
50mod test {
51    use vortex_buffer::buffer;
52
53    use crate::IntoArray;
54    use crate::arrays::BoolArray;
55    use crate::arrays::primitive::PrimitiveArray;
56    use crate::assert_arrays_eq;
57    use crate::builtins::ArrayBuiltins;
58    use crate::canonical::ToCanonical;
59    use crate::scalar::Scalar;
60    use crate::validity::Validity;
61
62    #[test]
63    fn fill_null_leading_none() {
64        let arr = PrimitiveArray::from_option_iter([None, Some(8u8), None, Some(10), None]);
65        let p = arr
66            .to_array()
67            .fill_null(Scalar::from(42u8))
68            .unwrap()
69            .to_primitive();
70        assert_arrays_eq!(p, PrimitiveArray::from_iter([42u8, 8, 42, 10, 42]));
71        assert!(p.validity_mask().unwrap().all_true());
72    }
73
74    #[test]
75    fn fill_null_all_none() {
76        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
77
78        let p = arr
79            .to_array()
80            .fill_null(Scalar::from(255u8))
81            .unwrap()
82            .to_primitive();
83        assert_arrays_eq!(p, PrimitiveArray::from_iter([255u8, 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 = arr
94            .to_array()
95            .fill_null(Scalar::from(255u8))
96            .unwrap()
97            .to_primitive();
98        assert_arrays_eq!(p, PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]));
99        assert!(p.validity_mask().unwrap().all_true());
100    }
101
102    #[test]
103    fn fill_null_non_nullable() {
104        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
105        let p = arr.fill_null(Scalar::from(255u8)).unwrap().to_primitive();
106        assert_arrays_eq!(p, PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]));
107        assert!(p.validity_mask().unwrap().all_true());
108    }
109}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
