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::array::ArrayView;
13use crate::arrays::BoolArray;
14use crate::arrays::Primitive;
15use crate::arrays::PrimitiveArray;
16use crate::match_each_native_ptype;
17use crate::scalar::Scalar;
18use crate::scalar_fn::fns::fill_null::FillNullKernel;
19use crate::validity::Validity;
20
21impl FillNullKernel for Primitive {
22    fn fill_null(
23        array: ArrayView<'_, Primitive>,
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.execute::<BoolArray>(ctx)?.into_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::VortexSessionExecute;
55    use crate::array_session;
56    use crate::arrays::PrimitiveArray;
57    use crate::arrays::primitive::compute::fill_null::BoolArray;
58    use crate::assert_arrays_eq;
59    use crate::builtins::ArrayBuiltins;
60    use crate::scalar::Scalar;
61    use crate::validity::Validity;
62
63    #[test]
64    fn fill_null_leading_none() {
65        let mut ctx = array_session().create_execution_ctx();
66        let arr = PrimitiveArray::from_option_iter([None, Some(8u8), None, Some(10), None]);
67        let p = arr.into_array().fill_null(Scalar::from(42u8)).unwrap();
68        assert_arrays_eq!(
69            p,
70            PrimitiveArray::from_iter([42u8, 8, 42, 10, 42]),
71            &mut ctx
72        );
73        assert!(
74            p.validity()
75                .unwrap()
76                .execute_mask(p.len(), &mut array_session().create_execution_ctx())
77                .unwrap()
78                .all_true()
79        );
80    }
81
82    #[test]
83    fn fill_null_all_none() {
84        let mut ctx = array_session().create_execution_ctx();
85        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
86
87        let p = arr.into_array().fill_null(Scalar::from(255u8)).unwrap();
88        assert_arrays_eq!(
89            p,
90            PrimitiveArray::from_iter([255u8, 255, 255, 255, 255]),
91            &mut ctx
92        );
93        assert!(
94            p.validity()
95                .unwrap()
96                .execute_mask(p.len(), &mut array_session().create_execution_ctx())
97                .unwrap()
98                .all_true()
99        );
100    }
101
102    #[test]
103    fn fill_null_nullable_non_null() {
104        let mut ctx = array_session().create_execution_ctx();
105        let arr = PrimitiveArray::new(
106            buffer![8u8, 10, 12, 14, 16],
107            Validity::Array(BoolArray::from_iter([true, true, true, true, true]).into_array()),
108        );
109        let p = arr.into_array().fill_null(Scalar::from(255u8)).unwrap();
110        assert_arrays_eq!(
111            p,
112            PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]),
113            &mut ctx
114        );
115        assert!(
116            p.validity()
117                .unwrap()
118                .execute_mask(p.len(), &mut array_session().create_execution_ctx())
119                .unwrap()
120                .all_true()
121        );
122    }
123
124    #[test]
125    fn fill_null_non_nullable() {
126        let mut ctx = array_session().create_execution_ctx();
127        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
128        let p = arr.fill_null(Scalar::from(255u8)).unwrap();
129        assert_arrays_eq!(
130            p,
131            PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]),
132            &mut ctx
133        );
134        assert!(
135            p.validity()
136                .unwrap()
137                .execute_mask(p.len(), &mut array_session().create_execution_ctx())
138                .unwrap()
139                .all_true()
140        );
141    }
142}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
