vortex_array/arrays/primitive/compute/
fill_null.rs

1use std::ops::Not;
2
3use vortex_buffer::BufferMut;
4use vortex_dtype::{Nullability, match_each_native_ptype};
5use vortex_error::{VortexExpect, VortexResult};
6use vortex_scalar::Scalar;
7
8use crate::arrays::primitive::PrimitiveArray;
9use crate::arrays::{ConstantArray, PrimitiveEncoding};
10use crate::compute::FillNullFn;
11use crate::validity::Validity;
12use crate::variants::PrimitiveArrayTrait;
13use crate::{Array, ArrayRef, ToCanonical};
14
15impl FillNullFn<&PrimitiveArray> for PrimitiveEncoding {
16    fn fill_null(&self, array: &PrimitiveArray, fill_value: Scalar) -> VortexResult<ArrayRef> {
17        let result_validity = match fill_value.dtype().nullability() {
18            Nullability::NonNullable => Validity::NonNullable,
19            Nullability::Nullable => Validity::AllValid,
20        };
21
22        Ok(match array.validity() {
23            Validity::NonNullable | Validity::AllValid => {
24                match_each_native_ptype!(array.ptype(), |$T| {
25                    PrimitiveArray::new::<$T>(array.buffer().clone(), result_validity).into_array()
26                })
27            }
28            Validity::AllInvalid => ConstantArray::new(fill_value, array.len()).into_array(),
29            Validity::Array(is_valid) => {
30                // TODO(danking): when we take PrimitiveArray by value, we should mutate in-place
31                let is_invalid = is_valid.to_bool()?.boolean_buffer().not();
32                match_each_native_ptype!(array.ptype(), |$T| {
33                    let mut buffer = BufferMut::copy_from(array.as_slice::<$T>());
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        })
45    }
46}
47
48#[cfg(test)]
49mod test {
50    use vortex_buffer::buffer;
51    use vortex_scalar::Scalar;
52
53    use crate::IntoArray;
54    use crate::array::Array;
55    use crate::arrays::BoolArray;
56    use crate::arrays::primitive::PrimitiveArray;
57    use crate::canonical::ToCanonical;
58    use crate::compute::fill_null;
59    use crate::validity::Validity;
60
61    #[test]
62    fn fill_null_leading_none() {
63        let arr = PrimitiveArray::from_option_iter([None, Some(8u8), None, Some(10), None]);
64        let p = fill_null(&arr, Scalar::from(42u8))
65            .unwrap()
66            .to_primitive()
67            .unwrap();
68        assert_eq!(p.as_slice::<u8>(), vec![42, 8, 42, 10, 42]);
69        assert!(p.validity_mask().unwrap().all_true());
70    }
71
72    #[test]
73    fn fill_null_all_none() {
74        let arr = PrimitiveArray::from_option_iter([Option::<u8>::None, None, None, None, None]);
75
76        let p = fill_null(&arr, Scalar::from(255u8))
77            .unwrap()
78            .to_primitive()
79            .unwrap();
80        assert_eq!(p.as_slice::<u8>(), vec![255, 255, 255, 255, 255]);
81        assert!(p.validity_mask().unwrap().all_true());
82    }
83
84    #[test]
85    fn fill_null_nullable_non_null() {
86        let arr = PrimitiveArray::new(
87            buffer![8u8, 10, 12, 14, 16],
88            Validity::Array(BoolArray::from_iter([true, true, true, true, true]).into_array()),
89        );
90        let p = fill_null(&arr, Scalar::from(255u8))
91            .unwrap()
92            .to_primitive()
93            .unwrap();
94        assert_eq!(p.as_slice::<u8>(), vec![8, 10, 12, 14, 16]);
95        assert!(p.validity_mask().unwrap().all_true());
96    }
97
98    #[test]
99    fn fill_null_non_nullable() {
100        let arr = buffer![8u8, 10, 12, 14, 16].into_array();
101        let p = fill_null(&arr, Scalar::from(255u8))
102            .unwrap()
103            .to_primitive()
104            .unwrap();
105        assert_eq!(p.as_slice::<u8>(), vec![8u8, 10, 12, 14, 16]);
106        assert!(p.validity_mask().unwrap().all_true());
107    }
108}
vortex_array/arrays/primitive/compute/fill_null.rs

vortex_array/arrays/primitive/compute/
fill_null.rs
