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    use crate::canonical::ToCanonical;
61    use crate::scalar::Scalar;
62    use crate::validity::Validity;
63
64    #[test]
65    fn fill_null_leading_none() {
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            .to_primitive();
72        assert_arrays_eq!(p, PrimitiveArray::from_iter([42u8, 8, 42, 10, 42]));
73        assert!(
74            p.as_ref()
75                .validity()
76                .unwrap()
77                .to_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
78                .unwrap()
79                .all_true()
80        );
81    }
82
83    #[test]
84    fn fill_null_all_none() {
85        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
86
87        let p = arr
88            .into_array()
89            .fill_null(Scalar::from(255u8))
90            .unwrap()
91            .to_primitive();
92        assert_arrays_eq!(p, PrimitiveArray::from_iter([255u8, 255, 255, 255, 255]));
93        assert!(
94            p.as_ref()
95                .validity()
96                .unwrap()
97                .to_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
98                .unwrap()
99                .all_true()
100        );
101    }
102
103    #[test]
104    fn fill_null_nullable_non_null() {
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
110            .into_array()
111            .fill_null(Scalar::from(255u8))
112            .unwrap()
113            .to_primitive();
114        assert_arrays_eq!(p, PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]));
115        assert!(
116            p.as_ref()
117                .validity()
118                .unwrap()
119                .to_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
120                .unwrap()
121                .all_true()
122        );
123    }
124
125    #[test]
126    fn fill_null_non_nullable() {
127        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
128        let p = arr.fill_null(Scalar::from(255u8)).unwrap().to_primitive();
129        assert_arrays_eq!(p, PrimitiveArray::from_iter([8u8, 10, 12, 14, 16]));
130        assert!(
131            p.as_ref()
132                .validity()
133                .unwrap()
134                .to_mask(p.as_ref().len(), &mut LEGACY_SESSION.create_execution_ctx())
135                .unwrap()
136                .all_true()
137        );
138    }
139}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
