Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve performance of REPEAT functions #12015

Merged
merged 4 commits into from
Aug 16, 2024
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 @@ -151,3 +151,8 @@ required-features = ["string_expressions"]
harness = false
name = "pad"
required-features = ["unicode_expressions"]

[[bench]]
harness = false
name = "repeat"
required-features = ["string_expressions"]
129 changes: 129 additions & 0 deletions datafusion/functions/benches/repeat.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
// 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::array::{ArrayRef, Int64Array, OffsetSizeTrait};
use arrow::util::bench_util::{
create_string_array_with_len, create_string_view_array_with_len,
};
use criterion::{black_box, criterion_group, criterion_main, Criterion};
use datafusion_expr::ColumnarValue;
use datafusion_functions::string;
use std::sync::Arc;

fn create_args<O: OffsetSizeTrait>(
size: usize,
str_len: usize,
repeat_times: i64,
use_string_view: bool,
) -> Vec<ColumnarValue> {
let number_array = Arc::new(Int64Array::from(
(0..size).map(|_| repeat_times).collect::<Vec<_>>(),
));

if use_string_view {
let string_array =
Arc::new(create_string_view_array_with_len(size, 0.1, str_len, false));
vec![
ColumnarValue::Array(string_array),
ColumnarValue::Array(number_array),
]
} else {
let string_array =
Arc::new(create_string_array_with_len::<O>(size, 0.1, str_len));

vec![
ColumnarValue::Array(string_array),
ColumnarValue::Array(Arc::clone(&number_array) as ArrayRef),
]
}
}

fn criterion_benchmark(c: &mut Criterion) {
let lower = string::lower();
tlm365 marked this conversation as resolved.
Show resolved Hide resolved
for size in [1024, 8192] {
// REPEAT 3 TIMES
let repeat_times = 5;
let mut group = c.benchmark_group(format!("repeat {} times", repeat_times));

let args = create_args::<i32>(size, 32, repeat_times, true);
group.bench_function(
&format!(
"repeat_string_view [size={}, repeat_times={}]",
size, repeat_times
),
|b| b.iter(|| black_box(lower.invoke(&args))),
);

let args = create_args::<i32>(size, 32, repeat_times, false);
group.bench_function(
&format!(
"repeat_string [size={}, repeat_times={}]",
size, repeat_times
),
|b| b.iter(|| black_box(lower.invoke(&args))),
);

let args = create_args::<i64>(size, 32, repeat_times, false);
group.bench_function(
&format!(
"repeat_large_string [size={}, repeat_times={}]",
size, repeat_times
),
|b| b.iter(|| black_box(lower.invoke(&args))),
);

group.finish();

// REPEAT 30 TIMES
let repeat_times = 50;
let mut group = c.benchmark_group(format!("repeat {} times", repeat_times));

let args = create_args::<i32>(size, 32, repeat_times, true);
group.bench_function(
&format!(
"repeat_string_view [size={}, repeat_times={}]",
size, repeat_times
),
|b| b.iter(|| black_box(lower.invoke(&args))),
);

let args = create_args::<i32>(size, 32, repeat_times, false);
group.bench_function(
&format!(
"repeat_string [size={}, repeat_times={}]",
size, repeat_times
),
|b| b.iter(|| black_box(lower.invoke(&args))),
);

let args = create_args::<i64>(size, 32, repeat_times, false);
group.bench_function(
&format!(
"repeat_large_string [size={}, repeat_times={}]",
size, repeat_times
),
|b| b.iter(|| black_box(lower.invoke(&args))),
);

group.finish();
}
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);
91 changes: 54 additions & 37 deletions datafusion/functions/src/string/repeat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@
use std::any::Any;
use std::sync::Arc;

use arrow::array::{ArrayRef, GenericStringArray, OffsetSizeTrait, StringArray};
use arrow::array::{
ArrayAccessor, ArrayIter, ArrayRef, AsArray, GenericStringArray,
GenericStringBuilder, Int64Array, OffsetSizeTrait, StringViewArray,
};
use arrow::datatypes::DataType;
use arrow::datatypes::DataType::{Int64, LargeUtf8, Utf8, Utf8View};

use datafusion_common::cast::{
as_generic_string_array, as_int64_array, as_string_view_array,
};
use datafusion_common::cast::as_int64_array;
use datafusion_common::{exec_err, Result};
use datafusion_expr::TypeSignature::*;
use datafusion_expr::{ColumnarValue, Volatility};
Expand All @@ -44,7 +46,6 @@ impl Default for RepeatFunc {

impl RepeatFunc {
pub fn new() -> Self {
use DataType::*;
Self {
signature: Signature::one_of(
vec![
Expand Down Expand Up @@ -79,50 +80,66 @@ impl ScalarUDFImpl for RepeatFunc {
}

fn invoke(&self, args: &[ColumnarValue]) -> Result<ColumnarValue> {
match args[0].data_type() {
DataType::Utf8View => make_scalar_function(repeat_utf8view, vec![])(args),
DataType::Utf8 => make_scalar_function(repeat::<i32>, vec![])(args),
DataType::LargeUtf8 => make_scalar_function(repeat::<i64>, vec![])(args),
other => exec_err!("Unsupported data type {other:?} for function repeat. Expected Utf8, Utf8View or LargeUtf8"),
}
make_scalar_function(repeat, vec![])(args)
}
}

/// Repeats string the specified number of times.
/// repeat('Pg', 4) = 'PgPgPgPg'
fn repeat<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
let string_array = as_generic_string_array::<T>(&args[0])?;
fn repeat(args: &[ArrayRef]) -> Result<ArrayRef> {
let number_array = as_int64_array(&args[1])?;

let result = string_array
.iter()
.zip(number_array.iter())
.map(|(string, number)| repeat_common(string, number))
.collect::<GenericStringArray<T>>();

Ok(Arc::new(result) as ArrayRef)
match args[0].data_type() {
Utf8View => {
let string_view_array = args[0].as_string_view();
repeat_impl::<i32, &StringViewArray>(string_view_array, number_array)
}
Utf8 => {
let string_array = args[0].as_string::<i32>();
repeat_impl::<i32, &GenericStringArray<i32>>(string_array, number_array)
}
LargeUtf8 => {
let string_array = args[0].as_string::<i64>();
repeat_impl::<i64, &GenericStringArray<i64>>(string_array, number_array)
}
other => exec_err!(
"Unsupported data type {other:?} for function repeat. \
Expected Utf8, Utf8View or LargeUtf8."
),
}
}

fn repeat_utf8view(args: &[ArrayRef]) -> Result<ArrayRef> {
let string_view_array = as_string_view_array(&args[0])?;
let number_array = as_int64_array(&args[1])?;

let result = string_view_array
fn repeat_impl<'a, T, S>(string_array: S, number_array: &Int64Array) -> Result<ArrayRef>
where
T: OffsetSizeTrait,
S: StringArrayType<'a>,
{
let mut builder: GenericStringBuilder<T> = GenericStringBuilder::new();
string_array
.iter()
.zip(number_array.iter())
.map(|(string, number)| repeat_common(string, number))
.collect::<StringArray>();

Ok(Arc::new(result) as ArrayRef)
.for_each(|(string, number)| match (string, number) {
Copy link
Contributor

Choose a reason for hiding this comment

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

👏 -- very nice

(Some(string), Some(number)) if number >= 0 => {
builder.append_value(string.repeat(number as usize))
}
(Some(_), Some(_)) => builder.append_value(""),
_ => builder.append_null(),
});
let array = builder.finish();

Ok(Arc::new(array) as ArrayRef)
}

fn repeat_common(string: Option<&str>, number: Option<i64>) -> Option<String> {
match (string, number) {
(Some(string), Some(number)) if number >= 0 => {
Some(string.repeat(number as usize))
}
(Some(_), Some(_)) => Some("".to_string()),
_ => None,
trait StringArrayType<'a>: ArrayAccessor<Item = &'a str> + Sized {
tlm365 marked this conversation as resolved.
Show resolved Hide resolved
fn iter(&self) -> ArrayIter<Self>;
}
impl<'a, O: OffsetSizeTrait> StringArrayType<'a> for &'a GenericStringArray<O> {
fn iter(&self) -> ArrayIter<Self> {
GenericStringArray::<O>::iter(self)
}
}
impl<'a> StringArrayType<'a> for &'a StringViewArray {
fn iter(&self) -> ArrayIter<Self> {
StringViewArray::iter(self)
}
}

Expand Down