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
68            .into_array()
69            .fill_null(Scalar::from(42u8))
70            .unwrap()
71            .execute::<PrimitiveArray>(&mut ctx)
72            .unwrap();
73        assert_arrays_eq!(
74            p,
75            PrimitiveArray::from_iter([42u8, 8, 42, 10, 42]),
76            &mut ctx
77        );
78        assert!(
79            p.as_ref()
80                .validity()
81                .unwrap()
82                .execute_mask(
83                    p.as_ref().len(),
84                    &mut array_session().create_execution_ctx()
85                )
86                .unwrap()
87                .all_true()
88        );
89    }
90
91    #[test]
92    fn fill_null_all_none() {
93        let mut ctx = array_session().create_execution_ctx();
94        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
95
96        let p = arr
97            .into_array()
98            .fill_null(Scalar::from(255u8))
99            .unwrap()
100            .execute::<PrimitiveArray>(&mut ctx)
101            .unwrap();
102        assert_arrays_eq!(
103            p,
104            PrimitiveArray::from_iter([255u8, 255, 255, 255, 255]),
105            &mut ctx
106        );
107        assert!(
108            p.as_ref()
109                .validity()
110                .unwrap()
111                .execute_mask(
112                    p.as_ref().len(),
113                    &mut array_session().create_execution_ctx()
114                )
115                .unwrap()
116                .all_true()
117        );
118    }
119
120    #[test]
121    fn fill_null_nullable_non_null() {
122        let mut ctx = array_session().create_execution_ctx();
123        let arr = PrimitiveArray::new(
124            buffer![8u8, 10, 12, 14, 16],
125            Validity::Array(BoolArray::from_iter([true, true, true, true, true]).into_array()),
126        );
127        let p = arr
128            .into_array()
129            .fill_null(Scalar::from(255u8))
130            .unwrap()
131            .execute::<PrimitiveArray>(&mut ctx)
132            .unwrap();
133        assert_arrays_eq!(
134            p,
135            PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]),
136            &mut ctx
137        );
138        assert!(
139            p.as_ref()
140                .validity()
141                .unwrap()
142                .execute_mask(
143                    p.as_ref().len(),
144                    &mut array_session().create_execution_ctx()
145                )
146                .unwrap()
147                .all_true()
148        );
149    }
150
151    #[test]
152    fn fill_null_non_nullable() {
153        let mut ctx = array_session().create_execution_ctx();
154        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
155        let p = arr
156            .fill_null(Scalar::from(255u8))
157            .unwrap()
158            .execute::<PrimitiveArray>(&mut ctx)
159            .unwrap();
160        assert_arrays_eq!(
161            p,
162            PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]),
163            &mut ctx
164        );
165        assert!(
166            p.as_ref()
167                .validity()
168                .unwrap()
169                .execute_mask(
170                    p.as_ref().len(),
171                    &mut array_session().create_execution_ctx()
172                )
173                .unwrap()
174                .all_true()
175        );
176    }
177}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
