vortex_array/arrays/decimal/compute/
fill_null.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::cmp::max;
5use std::ops::Not;
6
7use vortex_buffer::BitBuffer;
8use vortex_error::VortexExpect;
9use vortex_error::VortexResult;
10
11use super::cast::upcast_decimal_values;
12use crate::ArrayRef;
13use crate::ExecutionCtx;
14use crate::IntoArray;
15use crate::arrays::BoolArray;
16use crate::arrays::DecimalVTable;
17use crate::arrays::decimal::DecimalArray;
18use crate::dtype::NativeDecimalType;
19use crate::match_each_decimal_value_type;
20use crate::scalar::DecimalValue;
21use crate::scalar::Scalar;
22use crate::scalar_fn::fns::fill_null::FillNullKernel;
23use crate::validity::Validity;
24use crate::vtable::ValidityHelper;
25
26impl FillNullKernel for DecimalVTable {
27    fn fill_null(
28        array: &DecimalArray,
29        fill_value: &Scalar,
30        ctx: &mut ExecutionCtx,
31    ) -> VortexResult<Option<ArrayRef>> {
32        let result_validity = Validity::from(fill_value.dtype().nullability());
33
34        Ok(Some(match array.validity() {
35            Validity::Array(is_valid) => {
36                let is_invalid = is_valid
37                    .clone()
38                    .execute::<BoolArray>(ctx)?
39                    .to_bit_buffer()
40                    .not();
41                let decimal_scalar = fill_value.as_decimal();
42                let decimal_value = decimal_scalar
43                    .decimal_value()
44                    .vortex_expect("fill_null requires a non-null fill value");
45                match_each_decimal_value_type!(array.values_type(), |T| {
46                    fill_invalid_positions::<T>(
47                        array,
48                        &is_invalid,
49                        &decimal_value,
50                        result_validity,
51                    )?
52                })
53            }
54            _ => unreachable!("checked in entry point"),
55        }))
56    }
57}
58
59fn fill_invalid_positions<T: NativeDecimalType>(
60    array: &DecimalArray,
61    is_invalid: &BitBuffer,
62    decimal_value: &DecimalValue,
63    result_validity: Validity,
64) -> VortexResult<ArrayRef> {
65    match decimal_value.cast::<T>() {
66        Some(fill_val) => fill_buffer::<T>(array, is_invalid, fill_val, result_validity),
67        None => {
68            let target = max(array.values_type(), decimal_value.decimal_type());
69            let upcasted = upcast_decimal_values(array, target)?;
70            match_each_decimal_value_type!(upcasted.values_type(), |U| {
71                fill_invalid_positions::<U>(&upcasted, is_invalid, decimal_value, result_validity)
72            })
73        }
74    }
75}
76
77fn fill_buffer<T: NativeDecimalType>(
78    array: &DecimalArray,
79    is_invalid: &BitBuffer,
80    fill_val: T,
81    result_validity: Validity,
82) -> VortexResult<ArrayRef> {
83    let mut buffer = array.buffer::<T>().into_mut();
84    for invalid_index in is_invalid.set_indices() {
85        buffer[invalid_index] = fill_val;
86    }
87    Ok(DecimalArray::new(buffer.freeze(), array.decimal_dtype(), result_validity).into_array())
88}
89
90#[cfg(test)]
91mod tests {
92    use vortex_buffer::buffer;
93
94    use crate::arrays::decimal::DecimalArray;
95    use crate::assert_arrays_eq;
96    use crate::builtins::ArrayBuiltins;
97    use crate::canonical::ToCanonical;
98    use crate::dtype::DecimalDType;
99    use crate::dtype::Nullability;
100    use crate::scalar::DecimalValue;
101    use crate::scalar::Scalar;
102    use crate::validity::Validity;
103
104    #[test]
105    fn fill_null_leading_none() {
106        let decimal_dtype = DecimalDType::new(19, 2);
107        let arr = DecimalArray::from_option_iter(
108            [None, Some(800i128), None, Some(1000i128), None],
109            decimal_dtype,
110        );
111        let p = arr
112            .to_array()
113            .fill_null(Scalar::decimal(
114                DecimalValue::I128(4200i128),
115                DecimalDType::new(19, 2),
116                Nullability::NonNullable,
117            ))
118            .unwrap()
119            .to_decimal();
120        assert_arrays_eq!(
121            p,
122            DecimalArray::from_iter([4200, 800, 4200, 1000, 4200], decimal_dtype)
123        );
124        assert_eq!(
125            p.buffer::<i128>().as_slice(),
126            vec![4200, 800, 4200, 1000, 4200]
127        );
128        assert!(p.validity_mask().unwrap().all_true());
129    }
130
131    #[test]
132    fn fill_null_all_none() {
133        let decimal_dtype = DecimalDType::new(19, 2);
134
135        let arr = DecimalArray::from_option_iter(
136            [Option::<i128>::None, None, None, None, None],
137            decimal_dtype,
138        );
139
140        let p = arr
141            .to_array()
142            .fill_null(Scalar::decimal(
143                DecimalValue::I128(25500i128),
144                DecimalDType::new(19, 2),
145                Nullability::NonNullable,
146            ))
147            .unwrap()
148            .to_decimal();
149        assert_arrays_eq!(
150            p,
151            DecimalArray::from_iter([25500, 25500, 25500, 25500, 25500], decimal_dtype)
152        );
153    }
154
155    /// fill_null with a value that overflows the array's storage type should upcast the array.
156    #[test]
157    fn fill_null_overflow_upcasts() {
158        let decimal_dtype = DecimalDType::new(3, 0);
159        let arr = DecimalArray::from_option_iter([None, Some(10i8), None], decimal_dtype);
160        // i8 max is 127, so 200 doesn't fit — the array should be widened to i16.
161        let result = arr
162            .to_array()
163            .fill_null(Scalar::decimal(
164                DecimalValue::I128(200i128),
165                DecimalDType::new(3, 0),
166                Nullability::NonNullable,
167            ))
168            .unwrap()
169            .to_decimal();
170        assert_arrays_eq!(
171            result,
172            DecimalArray::from_iter([200i16, 10, 200], decimal_dtype)
173        );
174    }
175
176    #[test]
177    fn fill_null_non_nullable() {
178        let decimal_dtype = DecimalDType::new(19, 2);
179
180        let arr = DecimalArray::new(
181            buffer![800i128, 1000i128, 1200i128, 1400i128, 1600i128],
182            decimal_dtype,
183            Validity::NonNullable,
184        );
185        let p = arr
186            .to_array()
187            .fill_null(Scalar::decimal(
188                DecimalValue::I128(25500i128),
189                DecimalDType::new(19, 2),
190                Nullability::NonNullable,
191            ))
192            .unwrap()
193            .to_decimal();
194        assert_arrays_eq!(
195            p,
196            DecimalArray::from_iter([800i128, 1000, 1200, 1400, 1600], decimal_dtype)
197        );
198    }
199}
vortex_array/arrays/decimal/compute/fill_null.rs

vortex_array/arrays/decimal/compute/
fill_null.rs
