SubhamSinghal commented on code in PR #22459: URL: https://github.com/apache/datafusion/pull/22459#discussion_r3292341134
########## datafusion/functions-nested/src/array_add.rs: ########## @@ -0,0 +1,274 @@ +// 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. + +//! [`ScalarUDFImpl`] definitions for array_add function. + +use crate::utils::make_scalar_function; +use arrow::array::{ + Array, ArrayRef, Float64Array, GenericListArray, NullBufferBuilder, + OffsetBufferBuilder, OffsetSizeTrait, +}; +use arrow::buffer::NullBuffer; +use arrow::datatypes::{ + DataType, + DataType::{FixedSizeList, LargeList, List, Null}, + Field, +}; +use datafusion_common::cast::{as_float64_array, as_generic_list_array}; +use datafusion_common::utils::{ListCoercion, coerced_type_with_base_type_only}; +use datafusion_common::{ + Result, exec_err, not_impl_err, plan_err, utils::take_function_args, +}; +use datafusion_expr::{ + ColumnarValue, Documentation, ScalarFunctionArgs, ScalarUDFImpl, Signature, + Volatility, +}; +use datafusion_macros::user_doc; +use std::sync::Arc; + +make_udf_expr_and_func!( + ArrayAdd, + array_add, + array1 array2, + "returns the element-wise sum of two numeric arrays.", + array_add_udf +); + +#[user_doc( + doc_section(label = "Array Functions"), + description = "Returns the element-wise sum of two numeric arrays of equal length, computed as `array1[i] + array2[i]` per position. NULL is propagated per element: if either input element at position `i` is NULL, the corresponding output element is NULL (positions are preserved). Returns NULL if either entire input array is NULL. Errors if the per-row lengths differ. Returns an empty array if both inputs are empty.", + syntax_example = "array_add(array1, array2)", + sql_example = r#"```sql +> select array_add([1.0, 2.0, 3.0], [10.0, 20.0, 30.0]); ++---------------------------------------------------------+ +| array_add(List([1.0,2.0,3.0]),List([10.0,20.0,30.0])) | ++---------------------------------------------------------+ +| [11.0, 22.0, 33.0] | ++---------------------------------------------------------+ +```"#, + argument( + name = "array1", + description = "Array expression. Can be a constant, column, or function, and any combination of array operators." + ), + argument( + name = "array2", + description = "Array expression. Can be a constant, column, or function, and any combination of array operators." + ) +)] +#[derive(Debug, PartialEq, Eq, Hash)] +pub struct ArrayAdd { + signature: Signature, + aliases: Vec<String>, +} + +impl Default for ArrayAdd { + fn default() -> Self { + Self::new() + } +} + +impl ArrayAdd { + pub fn new() -> Self { + Self { + signature: Signature::user_defined(Volatility::Immutable), + aliases: vec!["list_add".to_string()], + } + } +} + +impl ScalarUDFImpl for ArrayAdd { + fn name(&self) -> &str { + "array_add" + } + + fn signature(&self) -> &Signature { + &self.signature + } + + fn return_type(&self, arg_types: &[DataType]) -> Result<DataType> { + // After `coerce_types`, both args share the same List/LargeList<Float64> shape. + Ok(arg_types[0].clone()) + } + + fn coerce_types(&self, arg_types: &[DataType]) -> Result<Vec<DataType>> { Review Comment: @Jefffrey I have added more checks like 1. List of List is handled upfront. List<List<field>> throws error as non numeric 2. Decimal128 and Decimal256 types throws error as downcasting it would loose precision. 3. throws error if element type is non-numeric to avoid automatic typecasting of boolean or string type to numeric. Let me know if I should get rid of these checks. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
