paleolimbot commented on code in PR #268: URL: https://github.com/apache/sedona-db/pull/268#discussion_r2492121857
########## rust/sedona-raster-functions/src/rs_size.rs: ########## @@ -0,0 +1,128 @@ +// 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, vec}; + +use crate::executor::RasterExecutor; +use arrow_array::builder::UInt64Builder; +use arrow_schema::DataType; +use datafusion_common::error::Result; +use datafusion_expr::{ + scalar_doc_sections::DOC_SECTION_OTHER, ColumnarValue, Documentation, Volatility, +}; +use sedona_expr::scalar_udf::{SedonaScalarKernel, SedonaScalarUDF}; +use sedona_raster::traits::RasterRef; +use sedona_schema::{datatypes::SedonaType, matchers::ArgMatcher}; + +/// RS_Width() scalar UDF implementation +/// +/// Extract the width of the raster +pub fn rs_width_udf() -> SedonaScalarUDF { + SedonaScalarUDF::new( + "rs_width", + vec![Arc::new(RsWidth {})], + Volatility::Immutable, + Some(rs_width_doc()), + ) +} + +fn rs_width_doc() -> Documentation { + Documentation::builder( + DOC_SECTION_OTHER, + "Return the width component of a raster".to_string(), + "RS_Width(raster: Raster)".to_string(), + ) + .with_argument("raster", "Raster: Input raster") + .with_sql_example("SELECT RS_Width(raster)".to_string()) + .build() +} + +#[derive(Debug)] +struct RsWidth {} + +impl SedonaScalarKernel for RsWidth { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new( + vec![ArgMatcher::is_raster()], + SedonaType::Arrow(DataType::UInt64), + ); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + arg_types: &[SedonaType], + args: &[ColumnarValue], + ) -> Result<ColumnarValue> { + let executor = RasterExecutor::new(arg_types, args); + let mut builder = UInt64Builder::with_capacity(executor.num_iterations()); + + executor.execute_raster_void(|_i, raster_opt| { + match raster_opt { + None => builder.append_null(), + Some(raster) => { + let width = raster.metadata().width(); + builder.append_value(width); + } + } + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use arrow_array::{Array, UInt64Array}; + use datafusion_expr::ScalarUDF; + use sedona_schema::datatypes::RASTER; + use sedona_testing::rasters::generate_test_rasters; + + #[test] + fn udf_size() { + let udf: ScalarUDF = rs_width_udf().into(); + assert_eq!(udf.name(), "rs_width"); + assert!(udf.documentation().is_some()); + } + + #[test] + fn udf_invoke() { + // 3 rasters, second one is null + let rasters = generate_test_rasters(3, Some(1)).unwrap(); + + // Create the UDF and invoke it + let kernel = RsWidth {}; + let args = [ColumnarValue::Array(Arc::new(rasters))]; + let arg_types = vec![RASTER]; + + let result = kernel.invoke_batch(&arg_types, &args).unwrap(); Review Comment: No need to do it here, but we should add a parser like we have for Geometry to the `ScalarUdfTester` so that we can write things like `tester.invoke_scalar("[[1, 2, 3], [4, 5, 6], [7, 8, 9]]")` (or maybe we already have a convention in Sedona Java for this) -- 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]
