datafusion_functions/unicode/

initcap.rs

// 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.

use std::sync::Arc;

use arrow::array::{Array, ArrayRef, AsArray, GenericStringArray, OffsetSizeTrait};
use arrow::buffer::Buffer;
use arrow::datatypes::DataType;

use crate::strings::{GenericStringArrayBuilder, StringViewArrayBuilder};
use datafusion_common::cast::{as_generic_string_array, as_string_view_array};
use datafusion_common::types::logical_string;
use datafusion_common::{Result, ScalarValue, exec_err};
use datafusion_expr::{
    Coercion, ColumnarValue, Documentation, EncodingPreservation, ScalarFunctionArgs,
    ScalarUDFImpl, Signature, TypeSignatureClass, Volatility,
};
use datafusion_macros::user_doc;

#[user_doc(
    doc_section(label = "String Functions"),
    description = "Capitalizes the first character in each word in the input string. \
            Words are delimited by non-alphanumeric characters.",
    syntax_example = "initcap(str)",
    sql_example = r#"```sql
> select initcap('apache datafusion');
+------------------------------------+
| initcap(Utf8("apache datafusion")) |
+------------------------------------+
| Apache Datafusion                  |
+------------------------------------+
```"#,
    standard_argument(name = "str", prefix = "String"),
    related_udf(name = "lower"),
    related_udf(name = "upper")
)]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct InitcapFunc {
    signature: Signature,
}

impl Default for InitcapFunc {
    fn default() -> Self {
        InitcapFunc::new()
    }
}

impl InitcapFunc {
    pub fn new() -> Self {
        Self {
            signature: Signature::coercible(
                vec![
                    Coercion::new_exact(TypeSignatureClass::Native(logical_string()))
                        .with_encoding_preservation(EncodingPreservation::dictionary()),
                ],
                Volatility::Immutable,
            ),
        }
    }
}

impl ScalarUDFImpl for InitcapFunc {
    fn name(&self) -> &str {
        "initcap"
    }

    fn signature(&self) -> &Signature {
        &self.signature
    }

    fn return_type(&self, arg_types: &[DataType]) -> Result<DataType> {
        Ok(arg_types[0].clone())
    }

    fn invoke_with_args(&self, args: ScalarFunctionArgs) -> Result<ColumnarValue> {
        match &args.args[0] {
            ColumnarValue::Scalar(scalar) => {
                Ok(ColumnarValue::Scalar(initcap_scalar(scalar)?))
            }
            ColumnarValue::Array(array) => {
                Ok(ColumnarValue::Array(initcap_array(array)?))
            }
        }
    }

    fn documentation(&self) -> Option<&Documentation> {
        self.doc()
    }
}

fn initcap_scalar(scalar: &ScalarValue) -> Result<ScalarValue> {
    match scalar {
        ScalarValue::Utf8(None)
        | ScalarValue::LargeUtf8(None)
        | ScalarValue::Utf8View(None) => Ok(scalar.clone()),
        ScalarValue::Utf8(Some(s)) => {
            let mut result = String::new();
            initcap_string(s, &mut result);
            Ok(ScalarValue::Utf8(Some(result)))
        }
        ScalarValue::LargeUtf8(Some(s)) => {
            let mut result = String::new();
            initcap_string(s, &mut result);
            Ok(ScalarValue::LargeUtf8(Some(result)))
        }
        ScalarValue::Utf8View(Some(s)) => {
            let mut result = String::new();
            initcap_string(s, &mut result);
            Ok(ScalarValue::Utf8View(Some(result)))
        }
        ScalarValue::Dictionary(key_type, value) => Ok(ScalarValue::Dictionary(
            key_type.clone(),
            Box::new(initcap_scalar(value)?),
        )),
        other => {
            exec_err!(
                "Unsupported data type {:?} for function `initcap`",
                other.data_type()
            )
        }
    }
}

fn initcap_array(array: &ArrayRef) -> Result<ArrayRef> {
    match array.data_type() {
        DataType::Utf8 => initcap::<i32>(&[Arc::clone(array)]),
        DataType::LargeUtf8 => initcap::<i64>(&[Arc::clone(array)]),
        DataType::Utf8View => initcap_utf8view(&[Arc::clone(array)]),
        DataType::Dictionary(_, _) => {
            let dictionary = array.as_any_dictionary();
            let converted = initcap_array(dictionary.values())?;
            Ok(dictionary.with_values(converted))
        }
        other => {
            exec_err!("Unsupported data type {other:?} for function `initcap`")
        }
    }
}

/// Converts the first letter of each word to uppercase and the rest to
/// lowercase. Words are sequences of alphanumeric characters separated by
/// non-alphanumeric characters.
///
/// Example:
/// ```sql
/// initcap('hi THOMAS') = 'Hi Thomas'
/// ```
fn initcap<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
    let string_array = as_generic_string_array::<T>(&args[0])?;

    if string_array.is_ascii() {
        return Ok(initcap_ascii_array(string_array));
    }

    let len = string_array.len();
    let mut builder = GenericStringArrayBuilder::<T>::with_capacity(
        len,
        string_array.value_data().len(),
    );

    let mut container = String::new();
    let nulls = string_array.nulls().cloned();
    if let Some(ref n) = nulls {
        for i in 0..len {
            if n.is_null(i) {
                builder.try_append_placeholder()?;
            } else {
                // SAFETY: not null per check above.
                let s = unsafe { string_array.value_unchecked(i) };
                initcap_string(s, &mut container);
                builder.try_append_value(&container)?;
            }
        }
    } else {
        for i in 0..len {
            // SAFETY: no null buffer means every index is valid.
            let s = unsafe { string_array.value_unchecked(i) };
            initcap_string(s, &mut container);
            builder.try_append_value(&container)?;
        }
    }

    Ok(Arc::new(builder.finish(nulls)?) as ArrayRef)
}

/// Fast path for `Utf8` or `LargeUtf8` arrays that are ASCII-only. We can use a
/// single pass over the buffer and operate directly on bytes.
fn initcap_ascii_array<T: OffsetSizeTrait>(
    string_array: &GenericStringArray<T>,
) -> ArrayRef {
    let offsets = string_array.offsets();
    let src = string_array.value_data();
    let first_offset = offsets.first().unwrap().as_usize();
    let last_offset = offsets.last().unwrap().as_usize();

    // For sliced arrays, only convert the visible bytes, not the entire input
    // buffer.
    let mut out = Vec::with_capacity(last_offset - first_offset);

    for window in offsets.windows(2) {
        let start = window[0].as_usize();
        let end = window[1].as_usize();

        let mut prev_is_alnum = false;
        for &b in &src[start..end] {
            let converted = if prev_is_alnum {
                b.to_ascii_lowercase()
            } else {
                b.to_ascii_uppercase()
            };
            out.push(converted);
            prev_is_alnum = b.is_ascii_alphanumeric();
        }
    }

    let values = Buffer::from_vec(out);

    // Rebase offsets for sliced arrays to reflect that the
    // output only contains the bytes in the visible slice.
    let out_offsets = offsets.clone().subtract(offsets[0]);

    // SAFETY: ASCII case conversion preserves byte length, so the original
    // string boundaries are preserved. `out_offsets` is either identical to
    // the input offsets or a rebased version relative to the compacted values
    // buffer.
    Arc::new(unsafe {
        GenericStringArray::<T>::new_unchecked(
            out_offsets,
            values,
            string_array.nulls().cloned(),
        )
    })
}

fn initcap_utf8view(args: &[ArrayRef]) -> Result<ArrayRef> {
    let string_view_array = as_string_view_array(&args[0])?;
    let len = string_view_array.len();
    let mut builder = StringViewArrayBuilder::with_capacity(len);
    let mut container = String::new();

    let nulls = string_view_array.nulls().cloned();
    if let Some(ref n) = nulls {
        for i in 0..len {
            if n.is_null(i) {
                builder.append_placeholder();
            } else {
                // SAFETY: not null per check above.
                let s = unsafe { string_view_array.value_unchecked(i) };
                initcap_string(s, &mut container);
                builder.append_value(&container);
            }
        }
    } else {
        for i in 0..len {
            // SAFETY: no null buffer means every index is valid.
            let s = unsafe { string_view_array.value_unchecked(i) };
            initcap_string(s, &mut container);
            builder.append_value(&container);
        }
    }

    Ok(Arc::new(builder.finish(nulls)?) as ArrayRef)
}

fn initcap_string(input: &str, container: &mut String) {
    container.clear();
    let mut prev_is_alphanumeric = false;

    if input.is_ascii() {
        container.reserve(input.len());
        // SAFETY: each byte is ASCII, so the result is valid UTF-8.
        let out = unsafe { container.as_mut_vec() };
        for &b in input.as_bytes() {
            if prev_is_alphanumeric {
                out.push(b.to_ascii_lowercase());
            } else {
                out.push(b.to_ascii_uppercase());
            }
            prev_is_alphanumeric = b.is_ascii_alphanumeric();
        }
    } else {
        for c in input.chars() {
            if prev_is_alphanumeric {
                container.extend(c.to_lowercase());
            } else {
                container.extend(c.to_uppercase());
            }
            prev_is_alphanumeric = c.is_alphanumeric();
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::unicode::initcap::InitcapFunc;
    use crate::utils::test::test_function;
    use arrow::array::{Array, ArrayRef, LargeStringArray, StringArray, StringViewArray};
    use arrow::datatypes::DataType::{Utf8, Utf8View};
    use datafusion_common::{Result, ScalarValue};
    use datafusion_expr::{ColumnarValue, ScalarUDFImpl};
    use std::sync::Arc;

    #[test]
    fn test_functions() -> Result<()> {
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::from("hi THOMAS"))],
            Ok(Some("Hi Thomas")),
            &str,
            Utf8,
            StringArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::Utf8(Some(
                "êM ả ñAnDÚ ÁrBOL ОлЕГ ИвАНОВИч ÍslENsku ÞjóðaRiNNaR εΛλΗΝΙκΉ"
                    .to_string()
            )))],
            Ok(Some(
                "Êm Ả Ñandú Árbol Олег Иванович Íslensku Þjóðarinnar Ελληνική"
            )),
            &str,
            Utf8,
            StringArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::from(""))],
            Ok(Some("")),
            &str,
            Utf8,
            StringArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::from(""))],
            Ok(Some("")),
            &str,
            Utf8,
            StringArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::Utf8(None))],
            Ok(None),
            &str,
            Utf8,
            StringArray
        );

        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::Utf8View(Some(
                "hi THOMAS".to_string()
            )))],
            Ok(Some("Hi Thomas")),
            &str,
            Utf8View,
            StringViewArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::Utf8View(Some(
                "hi THOMAS wIth M0re ThAN 12 ChaRs".to_string()
            )))],
            Ok(Some("Hi Thomas With M0re Than 12 Chars")),
            &str,
            Utf8View,
            StringViewArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::Utf8View(Some(
                "đẸp đẼ êM ả ñAnDÚ ÁrBOL ОлЕГ ИвАНОВИч ÍslENsku ÞjóðaRiNNaR εΛλΗΝΙκΉ"
                    .to_string()
            )))],
            Ok(Some(
                "Đẹp Đẽ Êm Ả Ñandú Árbol Олег Иванович Íslensku Þjóðarinnar Ελληνική"
            )),
            &str,
            Utf8View,
            StringViewArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::Utf8View(Some(
                "".to_string()
            )))],
            Ok(Some("")),
            &str,
            Utf8View,
            StringViewArray
        );
        test_function!(
            InitcapFunc::new(),
            vec![ColumnarValue::Scalar(ScalarValue::Utf8View(None))],
            Ok(None),
            &str,
            Utf8View,
            StringViewArray
        );

        Ok(())
    }

    #[test]
    fn test_initcap_ascii_array() -> Result<()> {
        let array = StringArray::from(vec![
            Some("hello world"),
            None,
            Some("foo-bar_baz/baX"),
            Some(""),
            Some("123 abc 456DEF"),
            Some("ALL CAPS"),
            Some("already correct"),
        ]);
        let args: Vec<ArrayRef> = vec![Arc::new(array)];
        let result = super::initcap::<i32>(&args)?;
        let result = result.as_any().downcast_ref::<StringArray>().unwrap();

        assert_eq!(result.len(), 7);
        assert_eq!(result.value(0), "Hello World");
        assert!(result.is_null(1));
        assert_eq!(result.value(2), "Foo-Bar_Baz/Bax");
        assert_eq!(result.value(3), "");
        assert_eq!(result.value(4), "123 Abc 456def");
        assert_eq!(result.value(5), "All Caps");
        assert_eq!(result.value(6), "Already Correct");
        Ok(())
    }

    #[test]
    fn test_initcap_ascii_large_array() -> Result<()> {
        let array = LargeStringArray::from(vec![
            Some("hello world"),
            None,
            Some("foo-bar_baz/baX"),
            Some(""),
            Some("123 abc 456DEF"),
            Some("ALL CAPS"),
            Some("already correct"),
        ]);
        let args: Vec<ArrayRef> = vec![Arc::new(array)];
        let result = super::initcap::<i64>(&args)?;
        let result = result.as_any().downcast_ref::<LargeStringArray>().unwrap();

        assert_eq!(result.len(), 7);
        assert_eq!(result.value(0), "Hello World");
        assert!(result.is_null(1));
        assert_eq!(result.value(2), "Foo-Bar_Baz/Bax");
        assert_eq!(result.value(3), "");
        assert_eq!(result.value(4), "123 Abc 456def");
        assert_eq!(result.value(5), "All Caps");
        assert_eq!(result.value(6), "Already Correct");
        Ok(())
    }

    /// Test that initcap works correctly on a sliced ASCII StringArray.
    #[test]
    fn test_initcap_sliced_ascii_array() -> Result<()> {
        let array = StringArray::from(vec![
            Some("hello world"),
            Some("foo bar"),
            Some("baz qux"),
        ]);
        // Slice to get only the last two elements. The resulting array's
        // offsets are [11, 18, 25] (non-zero start), but value_data still
        // contains the full original buffer.
        let sliced = array.slice(1, 2);
        let args: Vec<ArrayRef> = vec![Arc::new(sliced)];
        let result = super::initcap::<i32>(&args)?;
        let result = result.as_any().downcast_ref::<StringArray>().unwrap();

        assert_eq!(result.len(), 2);
        assert_eq!(result.value(0), "Foo Bar");
        assert_eq!(result.value(1), "Baz Qux");

        // The output values buffer should be compact
        assert_eq!(*result.offsets().first().unwrap(), 0);
        assert_eq!(
            result.value_data().len(),
            *result.offsets().last().unwrap() as usize
        );
        Ok(())
    }

    /// Test that initcap works correctly on a sliced ASCII LargeStringArray.
    #[test]
    fn test_initcap_sliced_ascii_large_array() -> Result<()> {
        let array = LargeStringArray::from(vec![
            Some("hello world"),
            Some("foo bar"),
            Some("baz qux"),
        ]);
        // Slice to get only the last two elements. The resulting array's
        // offsets are [11, 18, 25] (non-zero start), but value_data still
        // contains the full original buffer.
        let sliced = array.slice(1, 2);
        let args: Vec<ArrayRef> = vec![Arc::new(sliced)];
        let result = super::initcap::<i64>(&args)?;
        let result = result.as_any().downcast_ref::<LargeStringArray>().unwrap();

        assert_eq!(result.len(), 2);
        assert_eq!(result.value(0), "Foo Bar");
        assert_eq!(result.value(1), "Baz Qux");

        // The output values buffer should be compact
        assert_eq!(*result.offsets().first().unwrap(), 0);
        assert_eq!(
            result.value_data().len(),
            *result.offsets().last().unwrap() as usize
        );
        Ok(())
    }
}