paleolimbot commented on code in PR #462: URL: https://github.com/apache/sedona-db/pull/462#discussion_r2631423183
########## rust/sedona-geo/src/st_concavehull.rs: ########## @@ -0,0 +1,419 @@ +// 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::builder::BinaryBuilder; +use datafusion_common::error::Result; +use datafusion_common::{cast::as_float64_array, DataFusionError}; +use datafusion_expr::ColumnarValue; +use geo::{ConcaveHull, CoordsIter, Geometry, GeometryCollection, Point, Polygon}; +use geo_traits::to_geo::{ToGeoGeometry, ToGeoPoint}; +use geo_traits::{GeometryCollectionTrait, GeometryTrait, MultiPointTrait, PointTrait}; +use sedona_expr::scalar_udf::{ScalarKernelRef, SedonaScalarKernel}; +use sedona_functions::executor::WkbExecutor; +use sedona_geometry::is_empty; +use sedona_geometry::wkb_factory::WKB_MIN_PROBABLE_BYTES; +use sedona_schema::datatypes::SedonaType; +use sedona_schema::{datatypes::WKB_GEOMETRY, matchers::ArgMatcher}; +use wkb::reader::Wkb; +use wkb::writer::{write_geometry, WriteOptions}; + +use crate::to_geo::item_to_geometry; + +/// ST_ConcaveHull implementation using [ConcaveHull] +/// +/// Geo returns a Polygon for every concave hull computation +/// whereas the Geos implementation returns a MultiPolygon for +/// certain geometries concave hull computation. +pub fn st_concavehull_impl() -> ScalarKernelRef { + Arc::new(STConcaveHull {}) +} + +#[derive(Debug)] +struct STConcaveHull {} + +impl SedonaScalarKernel for STConcaveHull { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new( + vec![ArgMatcher::is_geometry(), ArgMatcher::is_numeric()], + WKB_GEOMETRY, + ); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + arg_types: &[SedonaType], + args: &[ColumnarValue], + ) -> Result<ColumnarValue> { + invoke_batch_impl(arg_types, args) + } +} + +fn invoke_batch_impl(arg_types: &[SedonaType], args: &[ColumnarValue]) -> Result<ColumnarValue> { + let executor = WkbExecutor::new(arg_types, args); + let mut builder = BinaryBuilder::with_capacity( + executor.num_iterations(), + WKB_MIN_PROBABLE_BYTES * executor.num_iterations(), + ); + + // Extract Args + let pct_convex_val = args[1] + .cast_to(&arrow_schema::DataType::Float64, None)? + .to_array(executor.num_iterations())?; + let pct_convex_array = as_float64_array(&pct_convex_val)?; + let mut pct_convex_iter = pct_convex_array.iter(); + + executor.execute_wkb_void(|maybe_wkb| { + match (maybe_wkb, pct_convex_iter.next().unwrap()) { + (Some(wkb), Some(pct_convex)) => { + invoke_scalar(&wkb, pct_convex, &mut builder)?; + builder.append_value([]); + } + _ => builder.append_null(), + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) +} + +fn invoke_scalar(geom: &Wkb, pct_convex: f64, writer: &mut impl std::io::Write) -> Result<()> { + if is_empty::is_geometry_empty(geom).map_err(|e| DataFusionError::Execution(e.to_string()))? { + write_geometry(writer, &Polygon::<f64>::empty(), &write_opts()) + .map_err(|e| DataFusionError::Execution(e.to_string()))?; + return Ok(()); + } + compute_and_write_hull(&normalize_geometry(geom)?, pct_convex, writer) +} + +fn write_opts() -> WriteOptions { + WriteOptions { + endianness: wkb::Endianness::LittleEndian, + } +} + +fn normalize_geometry(geom: &Wkb) -> Result<Geometry> { + match geom.as_type() { + geo_traits::GeometryType::GeometryCollection(gc) => { + let filtered: Vec<Geometry> = gc + .geometries() + .filter(|g| !is_empty::is_geometry_empty(g).unwrap_or(true)) + .map(|g| g.to_geometry()) + .collect(); + Ok(Geometry::GeometryCollection(GeometryCollection::new_from( + filtered, + ))) + } + + geo_traits::GeometryType::MultiPoint(mp) => { + let filtered: Vec<geo_types::Point> = mp + .points() + .filter_map(|pt| pt.coord().map(|_| pt.to_point())) + .collect(); + Ok(Geometry::MultiPoint(geo_types::MultiPoint::new(filtered))) + } + + geo_traits::GeometryType::LineString(ls) => item_to_geometry(ls), + geo_traits::GeometryType::MultiLineString(mls) => item_to_geometry(mls), + geo_traits::GeometryType::Polygon(pgn) => item_to_geometry(pgn), + geo_traits::GeometryType::MultiPolygon(mpgn) => item_to_geometry(mpgn), + geo_traits::GeometryType::Point(pt) => item_to_geometry(pt), + + _ => Err(DataFusionError::Execution( + "Unsupported geometry type".to_string(), + )), + } +} + +fn compute_and_write_hull( + geom: &Geometry, + pct_convex: f64, + writer: &mut impl std::io::Write, +) -> Result<()> { + match geom.as_type() { + geo_traits::GeometryType::Point(pt) => wkb::writer::write_point(writer, pt, &write_opts()) + .map_err(|e| DataFusionError::Execution(e.to_string()))?, + + geo_traits::GeometryType::MultiPoint(mpt) => { + let hull = geo_types::MultiPoint::new( + mpt.points() + .filter(|pt| pt.coord().is_some()) + .copied() + .collect::<Vec<Point>>(), + ) + .concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::LineString(ls) => { + let hull = ls.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::Polygon(pgn) => { + let hull = pgn.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::MultiLineString(mls) => { + let hull = mls.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::MultiPolygon(mpgn) => { + let hull = mpgn.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::GeometryCollection(gcn) => { + let coords: Vec<geo_types::Coord> = gcn + .geometries() + .flat_map(|geom| geom.coords_iter()) + .collect(); + + let multi_point = geo_types::MultiPoint::new( + coords.into_iter().map(geo_types::Point::from).collect(), + ); + + let hull = multi_point.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + _ => { + return Err(DataFusionError::Execution( + "Unsupported geometry type for concave hull".to_string(), + )) + } + } + + Ok(()) +} + +fn write_concave_hull<W: std::io::Write>( + writer: &mut W, + hull: impl GeometryTrait<T = f64>, +) -> Result<()> { + wkb::writer::write_geometry(writer, &hull, &write_opts()) + .map_err(|e| DataFusionError::Execution(e.to_string()))?; + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use arrow_schema::DataType; + use datafusion_common::ScalarValue; + use rstest::rstest; + use sedona_expr::scalar_udf::SedonaScalarUDF; + use sedona_schema::datatypes::{WKB_GEOMETRY, WKB_VIEW_GEOMETRY}; + use sedona_testing::{ + compare::assert_scalar_equal_wkb_geometry_topologically, testers::ScalarUdfTester, + }; + + /// Helper to initialize the UDF tester to avoid boilerplate in every test. + fn create_tester(sedona_type: SedonaType) -> ScalarUdfTester { + let udf = SedonaScalarUDF::from_kernel("st_concavehull", st_concavehull_impl()); + ScalarUdfTester::new( + udf.into(), + vec![sedona_type, SedonaType::Arrow(DataType::Float64)], + ) + } + + #[rstest] + fn test_return_type(#[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType) { + let tester = create_tester(sedona_type); + assert_eq!(tester.return_type().unwrap(), WKB_GEOMETRY); + } + + #[rstest] + fn test_null_inputs(#[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType) { + let tester = create_tester(sedona_type); + let result = tester + .invoke_scalar_scalar(ScalarValue::Null, ScalarValue::Null) + .unwrap(); + assert!(result.is_null()); + } + + #[rstest] + #[case::point("POINT EMPTY")] + #[case::linestring("LINESTRING EMPTY")] + #[case::polygon("POLYGON EMPTY")] + #[case::multipoint("MULTIPOINT EMPTY")] + #[case::multilinestring("MULTILINESTRING EMPTY")] + #[case::multipolygon("MULTIPOLYGON EMPTY")] + #[case::collection("GEOMETRYCOLLECTION EMPTY")] + fn test_empty_geometries( + #[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType, + #[case] input_wkt: &str, + ) { + let tester = create_tester(sedona_type); + // Empty geometries should result in an empty Polygon + let result = tester.invoke_scalar_scalar(input_wkt, 0.1).unwrap(); + assert_scalar_equal_wkb_geometry_topologically(&result, Some("POLYGON EMPTY")); + } + + #[rstest] + // ========================================================================= + // Differing Geometry Types, Identical Percentage (0.1) + // ========================================================================= + + // Point + #[case("POINT (2.5 3.1)", 0.1, "POINT (2.5 3.1)")] Review Comment: We haven't tested most functions in this type of parameterized way so far, and I am not sure we should start doing so unless there's a reason I haven't considered. The reason that I don't like this is that it's harder in the IDE to debug a specific case when there are more than a few cases. In Python the IDE makes this a bit easier. Also, ```rust let result = tester.invoke_scalar_scalar("LINESTRING (50 50, 150 150, 150 50)", 0.1).unwrap(); assert_scalar_equal_wkb_geometry_topologically(result, "POLYGON ((50 50, 150 150, 150 50, 50 50))"); ``` ...is not meaningfully more verbose than the case statements you have here. ########## rust/sedona-geo/src/st_concavehull.rs: ########## @@ -0,0 +1,419 @@ +// 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::builder::BinaryBuilder; +use datafusion_common::error::Result; +use datafusion_common::{cast::as_float64_array, DataFusionError}; +use datafusion_expr::ColumnarValue; +use geo::{ConcaveHull, CoordsIter, Geometry, GeometryCollection, Point, Polygon}; +use geo_traits::to_geo::{ToGeoGeometry, ToGeoPoint}; +use geo_traits::{GeometryCollectionTrait, GeometryTrait, MultiPointTrait, PointTrait}; +use sedona_expr::scalar_udf::{ScalarKernelRef, SedonaScalarKernel}; +use sedona_functions::executor::WkbExecutor; +use sedona_geometry::is_empty; +use sedona_geometry::wkb_factory::WKB_MIN_PROBABLE_BYTES; +use sedona_schema::datatypes::SedonaType; +use sedona_schema::{datatypes::WKB_GEOMETRY, matchers::ArgMatcher}; +use wkb::reader::Wkb; +use wkb::writer::{write_geometry, WriteOptions}; + +use crate::to_geo::item_to_geometry; + +/// ST_ConcaveHull implementation using [ConcaveHull] +/// +/// Geo returns a Polygon for every concave hull computation +/// whereas the Geos implementation returns a MultiPolygon for +/// certain geometries concave hull computation. +pub fn st_concavehull_impl() -> ScalarKernelRef { + Arc::new(STConcaveHull {}) +} + +#[derive(Debug)] +struct STConcaveHull {} + +impl SedonaScalarKernel for STConcaveHull { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new( + vec![ArgMatcher::is_geometry(), ArgMatcher::is_numeric()], + WKB_GEOMETRY, + ); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + arg_types: &[SedonaType], + args: &[ColumnarValue], + ) -> Result<ColumnarValue> { + invoke_batch_impl(arg_types, args) + } +} + +fn invoke_batch_impl(arg_types: &[SedonaType], args: &[ColumnarValue]) -> Result<ColumnarValue> { + let executor = WkbExecutor::new(arg_types, args); + let mut builder = BinaryBuilder::with_capacity( + executor.num_iterations(), + WKB_MIN_PROBABLE_BYTES * executor.num_iterations(), + ); + + // Extract Args + let pct_convex_val = args[1] + .cast_to(&arrow_schema::DataType::Float64, None)? + .to_array(executor.num_iterations())?; + let pct_convex_array = as_float64_array(&pct_convex_val)?; + let mut pct_convex_iter = pct_convex_array.iter(); + + executor.execute_wkb_void(|maybe_wkb| { + match (maybe_wkb, pct_convex_iter.next().unwrap()) { + (Some(wkb), Some(pct_convex)) => { + invoke_scalar(&wkb, pct_convex, &mut builder)?; + builder.append_value([]); + } + _ => builder.append_null(), + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) +} + +fn invoke_scalar(geom: &Wkb, pct_convex: f64, writer: &mut impl std::io::Write) -> Result<()> { + if is_empty::is_geometry_empty(geom).map_err(|e| DataFusionError::Execution(e.to_string()))? { + write_geometry(writer, &Polygon::<f64>::empty(), &write_opts()) + .map_err(|e| DataFusionError::Execution(e.to_string()))?; + return Ok(()); + } + compute_and_write_hull(&normalize_geometry(geom)?, pct_convex, writer) +} + +fn write_opts() -> WriteOptions { + WriteOptions { + endianness: wkb::Endianness::LittleEndian, + } +} + +fn normalize_geometry(geom: &Wkb) -> Result<Geometry> { + match geom.as_type() { + geo_traits::GeometryType::GeometryCollection(gc) => { + let filtered: Vec<Geometry> = gc + .geometries() + .filter(|g| !is_empty::is_geometry_empty(g).unwrap_or(true)) + .map(|g| g.to_geometry()) + .collect(); + Ok(Geometry::GeometryCollection(GeometryCollection::new_from( + filtered, + ))) + } + + geo_traits::GeometryType::MultiPoint(mp) => { + let filtered: Vec<geo_types::Point> = mp + .points() + .filter_map(|pt| pt.coord().map(|_| pt.to_point())) + .collect(); + Ok(Geometry::MultiPoint(geo_types::MultiPoint::new(filtered))) + } + + geo_traits::GeometryType::LineString(ls) => item_to_geometry(ls), + geo_traits::GeometryType::MultiLineString(mls) => item_to_geometry(mls), + geo_traits::GeometryType::Polygon(pgn) => item_to_geometry(pgn), + geo_traits::GeometryType::MultiPolygon(mpgn) => item_to_geometry(mpgn), + geo_traits::GeometryType::Point(pt) => item_to_geometry(pt), + + _ => Err(DataFusionError::Execution( + "Unsupported geometry type".to_string(), + )), + } +} + +fn compute_and_write_hull( + geom: &Geometry, + pct_convex: f64, + writer: &mut impl std::io::Write, +) -> Result<()> { + match geom.as_type() { + geo_traits::GeometryType::Point(pt) => wkb::writer::write_point(writer, pt, &write_opts()) + .map_err(|e| DataFusionError::Execution(e.to_string()))?, + + geo_traits::GeometryType::MultiPoint(mpt) => { + let hull = geo_types::MultiPoint::new( + mpt.points() + .filter(|pt| pt.coord().is_some()) + .copied() + .collect::<Vec<Point>>(), + ) + .concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::LineString(ls) => { + let hull = ls.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::Polygon(pgn) => { + let hull = pgn.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::MultiLineString(mls) => { + let hull = mls.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::MultiPolygon(mpgn) => { + let hull = mpgn.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + geo_traits::GeometryType::GeometryCollection(gcn) => { + let coords: Vec<geo_types::Coord> = gcn + .geometries() + .flat_map(|geom| geom.coords_iter()) + .collect(); + + let multi_point = geo_types::MultiPoint::new( + coords.into_iter().map(geo_types::Point::from).collect(), + ); + + let hull = multi_point.concave_hull(pct_convex); + write_concave_hull(writer, hull)?; + } + + _ => { + return Err(DataFusionError::Execution( + "Unsupported geometry type for concave hull".to_string(), + )) + } + } + + Ok(()) +} + +fn write_concave_hull<W: std::io::Write>( + writer: &mut W, + hull: impl GeometryTrait<T = f64>, +) -> Result<()> { + wkb::writer::write_geometry(writer, &hull, &write_opts()) + .map_err(|e| DataFusionError::Execution(e.to_string()))?; + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use arrow_schema::DataType; + use datafusion_common::ScalarValue; + use rstest::rstest; + use sedona_expr::scalar_udf::SedonaScalarUDF; + use sedona_schema::datatypes::{WKB_GEOMETRY, WKB_VIEW_GEOMETRY}; + use sedona_testing::{ + compare::assert_scalar_equal_wkb_geometry_topologically, testers::ScalarUdfTester, + }; + + /// Helper to initialize the UDF tester to avoid boilerplate in every test. + fn create_tester(sedona_type: SedonaType) -> ScalarUdfTester { + let udf = SedonaScalarUDF::from_kernel("st_concavehull", st_concavehull_impl()); + ScalarUdfTester::new( + udf.into(), + vec![sedona_type, SedonaType::Arrow(DataType::Float64)], + ) + } + + #[rstest] + fn test_return_type(#[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType) { + let tester = create_tester(sedona_type); + assert_eq!(tester.return_type().unwrap(), WKB_GEOMETRY); + } + + #[rstest] + fn test_null_inputs(#[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType) { + let tester = create_tester(sedona_type); + let result = tester + .invoke_scalar_scalar(ScalarValue::Null, ScalarValue::Null) + .unwrap(); + assert!(result.is_null()); + } + + #[rstest] + #[case::point("POINT EMPTY")] + #[case::linestring("LINESTRING EMPTY")] + #[case::polygon("POLYGON EMPTY")] + #[case::multipoint("MULTIPOINT EMPTY")] + #[case::multilinestring("MULTILINESTRING EMPTY")] + #[case::multipolygon("MULTIPOLYGON EMPTY")] + #[case::collection("GEOMETRYCOLLECTION EMPTY")] + fn test_empty_geometries( + #[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType, + #[case] input_wkt: &str, + ) { + let tester = create_tester(sedona_type); + // Empty geometries should result in an empty Polygon + let result = tester.invoke_scalar_scalar(input_wkt, 0.1).unwrap(); + assert_scalar_equal_wkb_geometry_topologically(&result, Some("POLYGON EMPTY")); + } Review Comment: In other functions we test this as an array of input -> array of output. Is there a reason we use a parameterized version here? We also probably don't need to test the output topologically for the empties (although it's not hurting to do so!) -- 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]
