Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions datafusion/functions/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -320,3 +320,8 @@ required-features = ["math_expressions"]
harness = false
name = "floor_ceil"
required-features = ["math_expressions"]

[[bench]]
harness = false
name = "round"
required-features = ["math_expressions"]
154 changes: 154 additions & 0 deletions datafusion/functions/benches/round.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

extern crate criterion;

use arrow::datatypes::{DataType, Field, Float32Type, Float64Type};
use arrow::util::bench_util::create_primitive_array;
use criterion::{Criterion, SamplingMode, criterion_group, criterion_main};
use datafusion_common::ScalarValue;
use datafusion_common::config::ConfigOptions;
use datafusion_expr::{ColumnarValue, ScalarFunctionArgs};
use datafusion_functions::math::round;
use std::hint::black_box;
use std::sync::Arc;
use std::time::Duration;

fn criterion_benchmark(c: &mut Criterion) {
let round_fn = round();
let config_options = Arc::new(ConfigOptions::default());

for size in [1024, 4096, 8192] {
let mut group = c.benchmark_group(format!("round size={size}"));
group.sampling_mode(SamplingMode::Flat);
group.sample_size(10);
group.measurement_time(Duration::from_secs(10));

// Float64 array benchmark
let f64_array = Arc::new(create_primitive_array::<Float64Type>(size, 0.1));
let batch_len = f64_array.len();
let f64_args = vec![
ColumnarValue::Array(f64_array),
ColumnarValue::Scalar(ScalarValue::Int32(Some(2))),
];

group.bench_function("round_f64_array", |b| {
b.iter(|| {
let args_cloned = f64_args.clone();
black_box(
round_fn
.invoke_with_args(ScalarFunctionArgs {
args: args_cloned,
arg_fields: vec![
Field::new("a", DataType::Float64, true).into(),
Field::new("b", DataType::Int32, false).into(),
],
number_rows: batch_len,
return_field: Field::new("f", DataType::Float64, true).into(),
config_options: Arc::clone(&config_options),
})
.unwrap(),
)
})
});

// Float32 array benchmark
let f32_array = Arc::new(create_primitive_array::<Float32Type>(size, 0.1));
let f32_args = vec![
ColumnarValue::Array(f32_array),
ColumnarValue::Scalar(ScalarValue::Int32(Some(2))),
];

group.bench_function("round_f32_array", |b| {
b.iter(|| {
let args_cloned = f32_args.clone();
black_box(
round_fn
.invoke_with_args(ScalarFunctionArgs {
args: args_cloned,
arg_fields: vec![
Field::new("a", DataType::Float32, true).into(),
Field::new("b", DataType::Int32, false).into(),
],
number_rows: batch_len,
return_field: Field::new("f", DataType::Float32, true).into(),
config_options: Arc::clone(&config_options),
})
.unwrap(),
)
})
});

// Scalar benchmark (the optimization we added)
let scalar_f64_args = vec![
ColumnarValue::Scalar(ScalarValue::Float64(Some(std::f64::consts::PI))),
ColumnarValue::Scalar(ScalarValue::Int32(Some(2))),
];

group.bench_function("round_f64_scalar", |b| {
b.iter(|| {
let args_cloned = scalar_f64_args.clone();
black_box(
round_fn
.invoke_with_args(ScalarFunctionArgs {
args: args_cloned,
arg_fields: vec![
Field::new("a", DataType::Float64, false).into(),
Field::new("b", DataType::Int32, false).into(),
],
number_rows: 1,
return_field: Field::new("f", DataType::Float64, false)
.into(),
config_options: Arc::clone(&config_options),
})
.unwrap(),
)
})
});

let scalar_f32_args = vec![
ColumnarValue::Scalar(ScalarValue::Float32(Some(std::f32::consts::PI))),
ColumnarValue::Scalar(ScalarValue::Int32(Some(2))),
];

group.bench_function("round_f32_scalar", |b| {
b.iter(|| {
let args_cloned = scalar_f32_args.clone();
black_box(
round_fn
.invoke_with_args(ScalarFunctionArgs {
args: args_cloned,
arg_fields: vec![
Field::new("a", DataType::Float32, false).into(),
Field::new("b", DataType::Int32, false).into(),
],
number_rows: 1,
return_field: Field::new("f", DataType::Float32, false)
.into(),
config_options: Arc::clone(&config_options),
})
.unwrap(),
)
})
});

group.finish();
}
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);
54 changes: 53 additions & 1 deletion datafusion/functions/src/math/round.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ use arrow::error::ArrowError;
use datafusion_common::types::{
NativeType, logical_float32, logical_float64, logical_int32,
};
use datafusion_common::{Result, ScalarValue, exec_err};
use datafusion_common::{DataFusionError, Result, ScalarValue, exec_err};
use datafusion_expr::sort_properties::{ExprProperties, SortProperties};
use datafusion_expr::{
Coercion, ColumnarValue, Documentation, ScalarFunctionArgs, ScalarUDFImpl, Signature,
Expand Down Expand Up @@ -141,6 +141,58 @@ impl ScalarUDFImpl for RoundFunc {
&default_decimal_places
};

// Scalar fast path for float types - avoid array conversion overhead
if let (ColumnarValue::Scalar(value_scalar), ColumnarValue::Scalar(dp_scalar)) =
(&args.args[0], decimal_places)
{
// Extract decimal places as i32
// Note: decimal_places is coerced to Int32 by the signature, so the non-Int32
// arm should be unreachable in normal execution. We fall through to the array
// path as a safety measure.
let dp = match dp_scalar {
ScalarValue::Int32(Some(dp)) => *dp,
ScalarValue::Int32(None) => {
// Return type depends on input type, but for null dp we return null
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fails to take into account decimals

return match value_scalar {
ScalarValue::Float32(_) => {
Ok(ColumnarValue::Scalar(ScalarValue::Float32(None)))
}
_ => Ok(ColumnarValue::Scalar(ScalarValue::Float64(None))),
};
}
_ => {
// Unreachable in normal execution due to type coercion
return round_columnar(
&args.args[0],
decimal_places,
args.number_rows,
);
}
};

match value_scalar {
ScalarValue::Float64(Some(v)) => {
return round_float(*v, dp)
.map(|r| ColumnarValue::Scalar(ScalarValue::Float64(Some(r))))
.map_err(DataFusionError::from);
}
ScalarValue::Float64(None) => {
return Ok(ColumnarValue::Scalar(ScalarValue::Float64(None)));
}
ScalarValue::Float32(Some(v)) => {
return round_float(*v, dp)
.map(|r| ColumnarValue::Scalar(ScalarValue::Float32(Some(r))))
.map_err(DataFusionError::from);
}
ScalarValue::Float32(None) => {
return Ok(ColumnarValue::Scalar(ScalarValue::Float32(None)));
}
// TODO: Add scalar fast path for decimal types
// For decimals and other types: fall through to array path
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there anything stopping us from supporting decimals as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The round_decimal function requires the scale parameter from the decimal type (e.g., Decimal128(precision, scale)), which makes extracting and processing scalars more involved than for floats.

For float scalars, we just call round_float(*v, dp) directly. For decimals, we'd need to:

  • Extract the native value from ScalarValue::Decimal128 (or other decimal variants)
  • Get the scale from the type
  • Call round_decimal(value, scale, dp)
  • Reconstruct the ScalarValue with precision/scale

If you're comfortable with these changes in this PR for the decimal then I can introduce these as well. What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should do it in this PR

_ => {}
}
}

round_columnar(&args.args[0], decimal_places, args.number_rows)
}

Expand Down