Apache DataFusion SQL Query Engine
Document decimal AVG wrapping arithmetic (#23685)
sakshichitnis2767502a364c28
diff --git a/datafusion/functions-aggregate-common/src/aggregate/avg_distinct/decimal.rs b/datafusion/functions-aggregate-common/src/aggregate/avg_distinct/decimal.rsindex 1b2fb01189..d9e06d3952 100644--- a/datafusion/functions-aggregate-common/src/aggregate/avg_distinct/decimal.rs+++ b/datafusion/functions-aggregate-common/src/aggregate/avg_distinct/decimal.rs@@ -65,6 +65,19 @@ impl<I: DecimalType + Debug, S: DecimalType + Debug> DecimalDistinctAvgAccumulat}}+/// Adds a distinct input value to AVG's widened intermediate sum.+/// Wrapping is intentional because the caller selects `S` with the same+/// `avg_sum_data_type` headroom contract as the non-distinct AVG path.+#[inline]+fn add_avg_distinct_sum<I, S>(sum: S::Native, value: I::Native) -> S::Native+where+ I: ArrowNumericType,+ S: ArrowNumericType,+ I::Native: Into<S::Native>,+{+ sum.add_wrapping(value.into())+}+impl<I, S> Accumulator for DecimalDistinctAvgAccumulator<I, S>whereI: DecimalType + ArrowNumericType + Debug,@@ -95,7 +108,7 @@ where// overflow the input's native width (mirrors the non-distinct path).let mut sum = S::Native::usize_as(0);for value in self.sum_accumulator.distinct_values() {- sum = sum.add_wrapping(value.into());+ sum = add_avg_distinct_sum::<I, S>(sum, value);}let Some(count) = S::Native::from_usize(count) else {diff --git a/datafusion/functions-aggregate/src/average.rs b/datafusion/functions-aggregate/src/average.rsindex e5030bf39e..89b6330852 100644--- a/datafusion/functions-aggregate/src/average.rs+++ b/datafusion/functions-aggregate/src/average.rs@@ -700,6 +700,29 @@ where/// Wraps on overflow, matching the `sum` aggregate and [`arrow::compute::sum`]./// [`avg_sum_data_type`] gives `S` enough headroom that this is unreachable for/// any realistic row count.+#[inline]+fn add_avg_sum<I, S>(sum: S::Native, value: I::Native) -> S::Native+where+ I: ArrowNumericType,+ S: ArrowNumericType,+ I::Native: Into<S::Native>,+{+ sum.add_wrapping(value.into())+}++/// Subtracts a value already represented by AVG's widened state. The wrapping+/// operation is intentional because `avg_sum_data_type` reserves the+/// documented headroom for the intermediate sum.+#[inline]+fn sub_avg_sum<I, S>(sum: S::Native, value: I::Native) -> S::Native+where+ I: ArrowNumericType,+ S: ArrowNumericType,+ I::Native: Into<S::Native>,+{+ sum.sub_wrapping(value.into())+}+fn decimal_sum_as<I, S>(values: &PrimitiveArray<I>) -> Option<S::Native>whereI: DecimalType + ArrowNumericType,@@ -714,11 +737,11 @@ wherelet mut sum = S::Native::default();if values.null_count() == 0 {for value in values.values() {- sum = sum.add_wrapping((*value).into());+ sum = add_avg_sum::<I, S>(sum, *value);}} else {for value in values.iter().flatten() {- sum = sum.add_wrapping(value.into());+ sum = add_avg_sum::<I, S>(sum, value);}}@@ -738,7 +761,7 @@ whereif let Some(x) = decimal_sum_as::<I, S>(values) {let v = self.sum.unwrap_or_default();- self.sum = Some(v.add_wrapping(x));+ self.sum = Some(add_avg_sum::<S, S>(v, x));}Ok(())}@@ -774,7 +797,7 @@ where// sums are summedif let Some(x) = sum(states[1].as_primitive::<S>()) {let v = self.sum.unwrap_or_default();- self.sum = Some(v.add_wrapping(x));+ self.sum = Some(add_avg_sum::<S, S>(v, x));}Ok(())}@@ -783,7 +806,7 @@ whereself.count -= (values.len() - values.null_count()) as u64;if let Some(x) = decimal_sum_as::<I, S>(values) {let v = self.sum.unwrap_or_default();- self.sum = Some(v.sub_wrapping(x));+ self.sum = Some(sub_avg_sum::<S, S>(v, x));}Ok(())}@@ -990,7 +1013,7 @@ where|group_index, new_value| {// SAFETY: group_index is guaranteed to be in boundslet sum = unsafe { self.sums.get_unchecked_mut(group_index) };- *sum = sum.add_wrapping(new_value.into());+ *sum = add_avg_sum::<I, S>(*sum, new_value);self.counts[group_index] += 1;},@@ -1090,7 +1113,7 @@ where|group_index, new_value: <S as ArrowPrimitiveType>::Native| {// SAFETY: group_index is guaranteed to be in boundslet sum = unsafe { self.sums.get_unchecked_mut(group_index) };- *sum = sum.add_wrapping(new_value);+ *sum = add_avg_sum::<S, S>(*sum, new_value);},);