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::LEGACY_SESSION;
55    use crate::VortexSessionExecute;
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    #[expect(deprecated)]
61    use crate::canonical::ToCanonical as _;
62    use crate::scalar::Scalar;
63    use crate::validity::Validity;
64
65    #[test]
66    fn fill_null_leading_none() {
67        let arr = PrimitiveArray::from_option_iter([None, Some(8u8), None, Some(10), None]);
68        #[expect(deprecated)]
69        let p = arr
70            .into_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!(
76            p.as_ref()
77                .validity()
78                .unwrap()
79                .execute_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
80                .unwrap()
81                .all_true()
82        );
83    }
84
85    #[test]
86    fn fill_null_all_none() {
87        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
88
89        #[expect(deprecated)]
90        let p = arr
91            .into_array()
92            .fill_null(Scalar::from(255u8))
93            .unwrap()
94            .to_primitive();
95        assert_arrays_eq!(p, PrimitiveArray::from_iter([255u8, 255, 255, 255, 255]));
96        assert!(
97            p.as_ref()
98                .validity()
99                .unwrap()
100                .execute_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
101                .unwrap()
102                .all_true()
103        );
104    }
105
106    #[test]
107    fn fill_null_nullable_non_null() {
108        let arr = PrimitiveArray::new(
109            buffer![8u8, 10, 12, 14, 16],
110            Validity::Array(BoolArray::from_iter([true, true, true, true, true]).into_array()),
111        );
112        #[expect(deprecated)]
113        let p = arr
114            .into_array()
115            .fill_null(Scalar::from(255u8))
116            .unwrap()
117            .to_primitive();
118        assert_arrays_eq!(p, PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]));
119        assert!(
120            p.as_ref()
121                .validity()
122                .unwrap()
123                .execute_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
124                .unwrap()
125                .all_true()
126        );
127    }
128
129    #[test]
130    fn fill_null_non_nullable() {
131        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
132        #[expect(deprecated)]
133        let p = arr.fill_null(Scalar::from(255u8)).unwrap().to_primitive();
134        assert_arrays_eq!(p, PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]));
135        assert!(
136            p.as_ref()
137                .validity()
138                .unwrap()
139                .execute_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
140                .unwrap()
141                .all_true()
142        );
143    }
144}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
