paleolimbot commented on code in PR #257: URL: https://github.com/apache/sedona-db/pull/257#discussion_r2476279255
########## rust/sedona-functions/src/st_points.rs: ########## @@ -0,0 +1,411 @@ +// 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 arrow_array::builder::{BinaryBuilder, UInt64Builder}; +use arrow_schema::DataType; +use datafusion_common::error::Result; +use datafusion_expr::{ + scalar_doc_sections::DOC_SECTION_OTHER, ColumnarValue, Documentation, Volatility, +}; +use geo_traits::{ + CoordTrait, GeometryCollectionTrait, GeometryTrait, LineStringTrait, MultiLineStringTrait, + MultiPointTrait, MultiPolygonTrait, PointTrait, PolygonTrait, +}; +use sedona_common::sedona_internal_err; +use sedona_expr::scalar_udf::{SedonaScalarKernel, SedonaScalarUDF}; +use sedona_geometry::{ + error::SedonaGeometryError, + wkb_factory::{ + write_wkb_coord_trait, write_wkb_multipoint_header, write_wkb_point_header, + WKB_MIN_PROBABLE_BYTES, + }, +}; +use sedona_schema::{ + datatypes::{SedonaType, WKB_GEOMETRY}, + matchers::ArgMatcher, +}; +use std::{io::Write, sync::Arc}; + +use crate::executor::WkbExecutor; + +/// ST_Points() scalar UDF +/// +/// Native implementation to get all the points of a geometry as MULTIPOINT +pub fn st_points_udf() -> SedonaScalarUDF { + SedonaScalarUDF::new( + "st_points", + vec![Arc::new(STPoints)], + Volatility::Immutable, + Some(st_npoints_doc()), + ) +} + +fn st_points_doc() -> Documentation { + Documentation::builder( + DOC_SECTION_OTHER, + "Returns all the points of a geometry as MULTIPOINT.", + "ST_Points (geom: Geometry)", + ) + .with_argument("geom", "geometry: Input geometry") + .with_sql_example("SELECT ST_Points(ST_GeomFromWKT('LINESTRING(0 1, 2 3, 4 5)'))") + .build() +} + +#[derive(Debug)] +struct STPoints; + +impl SedonaScalarKernel for STPoints { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new(vec![ArgMatcher::is_geometry()], WKB_GEOMETRY); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + 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(), + ); + + executor.execute_wkb_void(|maybe_wkb| { + if let Some(wkb) = maybe_wkb { + // We need to know the number of points before actually writing the points. + let n_points = count_wkb_points_recursively(&wkb); + + if write_wkb_multipoint_header(&mut builder, wkb.dim(), n_points).is_err() { + return sedona_internal_err!("Failed to write WKB point header"); + }; + + if write_wkb_points_recursively(&mut builder, &wkb).is_err() { + return sedona_internal_err!("Failed to write WKB point header"); + }; + + builder.append_value([]); + } else { + builder.append_null(); + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) + } +} + +/// ST_NPoints() scalar UDF +/// +/// Native implementation to count all the points of a geometry +pub fn st_npoints_udf() -> SedonaScalarUDF { + SedonaScalarUDF::new( + "st_npoints", + vec![Arc::new(STNPoints)], + Volatility::Immutable, + Some(st_points_doc()), + ) +} + +fn st_npoints_doc() -> Documentation { + Documentation::builder( + DOC_SECTION_OTHER, + "Returns the count of the points of a geometry.", + "ST_Points (geom: Geometry)", + ) + .with_argument("geom", "geometry: Input geometry") + .with_sql_example("SELECT ST_NPoints(ST_GeomFromWKT('LINESTRING(0 1, 2 3, 4 5)'))") + .build() +} + +#[derive(Debug)] +struct STNPoints; + +impl SedonaScalarKernel for STNPoints { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new( + vec![ArgMatcher::is_geometry()], + SedonaType::Arrow(DataType::UInt64), + ); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + arg_types: &[SedonaType], + args: &[ColumnarValue], + ) -> Result<ColumnarValue> { + let executor = WkbExecutor::new(arg_types, args); + let mut builder = UInt64Builder::with_capacity(executor.num_iterations()); + + executor.execute_wkb_void(|maybe_wkb| { + if let Some(wkb) = maybe_wkb { + builder.append_value(count_wkb_points_recursively(&wkb) as u64); + } else { + builder.append_null(); + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) + } +} + +fn count_wkb_points_recursively<'a>(wkb: &'a wkb::reader::Wkb<'a>) -> usize { + match wkb.as_type() { + geo_traits::GeometryType::Point(point) => { + if point.is_empty() { + 0 + } else { + 1 + } + } + geo_traits::GeometryType::LineString(line_string) => line_string.num_coords(), + geo_traits::GeometryType::Polygon(polygon) => { + let mut n = match polygon.exterior() { + Some(ring) => ring.num_coords(), + None => 0, + }; + n += polygon.interiors().map(|r| r.num_coords()).sum::<usize>(); + + n + } + geo_traits::GeometryType::MultiPoint(multi_point) => { + multi_point.points().filter(|p| !p.is_empty()).count() + } + geo_traits::GeometryType::MultiLineString(multi_line_string) => multi_line_string + .line_strings() + .map(|l| l.num_coords()) + .sum(), + geo_traits::GeometryType::MultiPolygon(multi_polygon) => { + let mut n = 0; + for polygon in multi_polygon.polygons() { + n += match polygon.exterior() { + Some(ring) => ring.num_coords(), + None => 0, + }; + n += polygon.interiors().map(|r| r.num_coords()).sum::<usize>(); + } + n + } + geo_traits::GeometryType::GeometryCollection(geometry_collection) => { + let mut n = 0; + for geometry in geometry_collection.geometries() { + n += count_wkb_points_recursively(geometry); + } + n + } + _ => 0, + } +} + +fn write_wkb_point_from_coord( + buf: &mut impl Write, + coord: impl CoordTrait<T = f64>, +) -> Result<(), SedonaGeometryError> { + write_wkb_point_header(buf, coord.dim())?; + write_wkb_coord_trait(buf, &coord) +} + +fn write_wkb_points_from_coords( + buf: &mut impl Write, + coords: impl Iterator<Item = impl CoordTrait<T = f64>>, +) -> Result<(), SedonaGeometryError> { + for coord in coords { + write_wkb_point_from_coord(buf, coord)?; + } + Ok(()) +} + +fn write_wkb_points_recursively<'a>( + buf: &mut impl Write, + wkb: &'a wkb::reader::Wkb<'a>, +) -> Result<(), SedonaGeometryError> { + match wkb.as_type() { + geo_traits::GeometryType::Point(point) => { + if let Some(coord) = point.coord() { + write_wkb_point_from_coord(buf, coord)? + } + } + geo_traits::GeometryType::LineString(line_string) => { + write_wkb_points_from_coords(buf, line_string.coords())?; + } + geo_traits::GeometryType::Polygon(polygon) => { + if let Some(ring) = polygon.exterior() { + write_wkb_points_from_coords(buf, ring.coords())? + } + for ring in polygon.interiors() { + write_wkb_points_from_coords(buf, ring.coords())?; + } + } + geo_traits::GeometryType::MultiPoint(multi_point) => { + for point in multi_point.points() { + if let Some(coord) = point.coord() { + write_wkb_point_from_coord(buf, coord)? + } + } + } + geo_traits::GeometryType::MultiLineString(multi_line_string) => { + for line_string in multi_line_string.line_strings() { + write_wkb_points_from_coords(buf, line_string.coords())?; + } + } + geo_traits::GeometryType::MultiPolygon(multi_polygon) => { + for polygon in multi_polygon.polygons() { + if let Some(ring) = polygon.exterior() { + write_wkb_points_from_coords(buf, ring.coords())? + } + for ring in polygon.interiors() { + write_wkb_points_from_coords(buf, ring.coords())?; + } + } + } + geo_traits::GeometryType::GeometryCollection(geometry_collection) => { + for geometry in geometry_collection.geometries() { + write_wkb_points_recursively(buf, geometry)?; + } + } + _ => {} + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use std::sync::Arc; + + use datafusion_expr::ScalarUDF; + use rstest::rstest; + use sedona_schema::datatypes::WKB_VIEW_GEOMETRY; + use sedona_testing::{ + compare::assert_array_equal, create::create_array, testers::ScalarUdfTester, + }; + + use super::*; + + #[test] + fn udf_metadata() { + let st_points_udf: ScalarUDF = st_points_udf().into(); + assert_eq!(st_points_udf.name(), "st_points"); + assert!(st_points_udf.documentation().is_some()); + + let st_npoints_udf: ScalarUDF = st_npoints_udf().into(); + assert_eq!(st_npoints_udf.name(), "st_npoints"); + assert!(st_npoints_udf.documentation().is_some()); + } + + #[rstest] + fn udf(#[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType) { + use arrow_array::UInt64Array; + + let tester_points = ScalarUdfTester::new(st_points_udf().into(), vec![sedona_type.clone()]); + let tester_npoints = + ScalarUdfTester::new(st_npoints_udf().into(), vec![sedona_type.clone()]); + + let input = create_array( + &[ + // 2d + Some("POINT (1 2)"), + Some("LINESTRING (1 2, 3 4, 5 6)"), + Some("POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0))"), + Some("POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0), (1 1, 3 1, 1 3, 1 1))"), + // Some("MULTIPOINT (1 2, EMPTY, 3 4, 5 6)"), // TODO: cannot parse EMPTY? + Some("MULTILINESTRING ((1 2, 3 4), (5 6, 7 8))"), + Some("MULTIPOLYGON (((0 0, 10 0, 10 10, 0 10, 0 0)), ((0 0, 5 0, 0 5, 0 0), (1 1, 3 1, 1 3, 1 1)))"), + Some("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING EMPTY, LINESTRING (3 4, 5 6))"), + // 3d and 4d + Some("LINESTRING Z (1 2 3, 4 5 6, 7 8 9)"), + Some("LINESTRING M (1 2 3, 4 5 6, 7 8 9)"), + Some("LINESTRING ZM (1 2 3 4, 5 6 7 8, 9 0 1 2)"), + // empty + Some("POINT EMPTY"), + Some("LINESTRING EMPTY"), + Some("POLYGON EMPTY"), + Some("MULTIPOINT EMPTY"), + Some("MULTILINESTRING EMPTY"), + Some("MULTIPOLYGON EMPTY"), + Some("GEOMETRYCOLLECTION EMPTY"), + // null + None, + ], + &sedona_type, + ); + + let expected_points = create_array( + &[ + Some("MULTIPOINT (1 2)"), + Some("MULTIPOINT (1 2, 3 4, 5 6)"), + Some("MULTIPOINT (0 0, 10 0, 10 10, 0 10, 0 0)"), + Some("MULTIPOINT (0 0, 10 0, 10 10, 0 10, 0 0, 1 1, 3 1, 1 3, 1 1)"), + // Some("MULTIPOINT (1 2, 3 4, 5 6)"), Review Comment: ```suggestion ``` ########## rust/sedona-functions/src/st_points.rs: ########## @@ -0,0 +1,411 @@ +// 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 arrow_array::builder::{BinaryBuilder, UInt64Builder}; +use arrow_schema::DataType; +use datafusion_common::error::Result; +use datafusion_expr::{ + scalar_doc_sections::DOC_SECTION_OTHER, ColumnarValue, Documentation, Volatility, +}; +use geo_traits::{ + CoordTrait, GeometryCollectionTrait, GeometryTrait, LineStringTrait, MultiLineStringTrait, + MultiPointTrait, MultiPolygonTrait, PointTrait, PolygonTrait, +}; +use sedona_common::sedona_internal_err; +use sedona_expr::scalar_udf::{SedonaScalarKernel, SedonaScalarUDF}; +use sedona_geometry::{ + error::SedonaGeometryError, + wkb_factory::{ + write_wkb_coord_trait, write_wkb_multipoint_header, write_wkb_point_header, + WKB_MIN_PROBABLE_BYTES, + }, +}; +use sedona_schema::{ + datatypes::{SedonaType, WKB_GEOMETRY}, + matchers::ArgMatcher, +}; +use std::{io::Write, sync::Arc}; + +use crate::executor::WkbExecutor; + +/// ST_Points() scalar UDF +/// +/// Native implementation to get all the points of a geometry as MULTIPOINT +pub fn st_points_udf() -> SedonaScalarUDF { + SedonaScalarUDF::new( + "st_points", + vec![Arc::new(STPoints)], + Volatility::Immutable, + Some(st_npoints_doc()), + ) +} + +fn st_points_doc() -> Documentation { + Documentation::builder( + DOC_SECTION_OTHER, + "Returns all the points of a geometry as MULTIPOINT.", + "ST_Points (geom: Geometry)", + ) + .with_argument("geom", "geometry: Input geometry") + .with_sql_example("SELECT ST_Points(ST_GeomFromWKT('LINESTRING(0 1, 2 3, 4 5)'))") + .build() +} + +#[derive(Debug)] +struct STPoints; + +impl SedonaScalarKernel for STPoints { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new(vec![ArgMatcher::is_geometry()], WKB_GEOMETRY); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + 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(), + ); + + executor.execute_wkb_void(|maybe_wkb| { + if let Some(wkb) = maybe_wkb { + // We need to know the number of points before actually writing the points. + let n_points = count_wkb_points_recursively(&wkb); + + if write_wkb_multipoint_header(&mut builder, wkb.dim(), n_points).is_err() { + return sedona_internal_err!("Failed to write WKB point header"); + }; + + if write_wkb_points_recursively(&mut builder, &wkb).is_err() { + return sedona_internal_err!("Failed to write WKB point header"); + }; + + builder.append_value([]); + } else { + builder.append_null(); + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) + } +} + +/// ST_NPoints() scalar UDF +/// +/// Native implementation to count all the points of a geometry +pub fn st_npoints_udf() -> SedonaScalarUDF { + SedonaScalarUDF::new( + "st_npoints", + vec![Arc::new(STNPoints)], + Volatility::Immutable, + Some(st_points_doc()), + ) +} + +fn st_npoints_doc() -> Documentation { + Documentation::builder( + DOC_SECTION_OTHER, + "Returns the count of the points of a geometry.", + "ST_Points (geom: Geometry)", + ) + .with_argument("geom", "geometry: Input geometry") + .with_sql_example("SELECT ST_NPoints(ST_GeomFromWKT('LINESTRING(0 1, 2 3, 4 5)'))") + .build() +} + +#[derive(Debug)] +struct STNPoints; + +impl SedonaScalarKernel for STNPoints { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new( + vec![ArgMatcher::is_geometry()], + SedonaType::Arrow(DataType::UInt64), + ); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + arg_types: &[SedonaType], + args: &[ColumnarValue], + ) -> Result<ColumnarValue> { + let executor = WkbExecutor::new(arg_types, args); + let mut builder = UInt64Builder::with_capacity(executor.num_iterations()); + + executor.execute_wkb_void(|maybe_wkb| { + if let Some(wkb) = maybe_wkb { + builder.append_value(count_wkb_points_recursively(&wkb) as u64); + } else { + builder.append_null(); + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) + } +} + +fn count_wkb_points_recursively<'a>(wkb: &'a wkb::reader::Wkb<'a>) -> usize { + match wkb.as_type() { + geo_traits::GeometryType::Point(point) => { + if point.is_empty() { + 0 + } else { + 1 + } + } + geo_traits::GeometryType::LineString(line_string) => line_string.num_coords(), + geo_traits::GeometryType::Polygon(polygon) => { + let mut n = match polygon.exterior() { + Some(ring) => ring.num_coords(), + None => 0, + }; + n += polygon.interiors().map(|r| r.num_coords()).sum::<usize>(); + + n + } + geo_traits::GeometryType::MultiPoint(multi_point) => { + multi_point.points().filter(|p| !p.is_empty()).count() + } + geo_traits::GeometryType::MultiLineString(multi_line_string) => multi_line_string + .line_strings() + .map(|l| l.num_coords()) + .sum(), + geo_traits::GeometryType::MultiPolygon(multi_polygon) => { + let mut n = 0; + for polygon in multi_polygon.polygons() { + n += match polygon.exterior() { + Some(ring) => ring.num_coords(), + None => 0, + }; + n += polygon.interiors().map(|r| r.num_coords()).sum::<usize>(); + } + n + } + geo_traits::GeometryType::GeometryCollection(geometry_collection) => { + let mut n = 0; + for geometry in geometry_collection.geometries() { + n += count_wkb_points_recursively(geometry); + } + n + } + _ => 0, + } +} + +fn write_wkb_point_from_coord( + buf: &mut impl Write, + coord: impl CoordTrait<T = f64>, +) -> Result<(), SedonaGeometryError> { + write_wkb_point_header(buf, coord.dim())?; + write_wkb_coord_trait(buf, &coord) +} + +fn write_wkb_points_from_coords( + buf: &mut impl Write, + coords: impl Iterator<Item = impl CoordTrait<T = f64>>, +) -> Result<(), SedonaGeometryError> { + for coord in coords { + write_wkb_point_from_coord(buf, coord)?; + } + Ok(()) +} + +fn write_wkb_points_recursively<'a>( + buf: &mut impl Write, + wkb: &'a wkb::reader::Wkb<'a>, +) -> Result<(), SedonaGeometryError> { + match wkb.as_type() { + geo_traits::GeometryType::Point(point) => { + if let Some(coord) = point.coord() { + write_wkb_point_from_coord(buf, coord)? + } + } + geo_traits::GeometryType::LineString(line_string) => { + write_wkb_points_from_coords(buf, line_string.coords())?; + } + geo_traits::GeometryType::Polygon(polygon) => { + if let Some(ring) = polygon.exterior() { + write_wkb_points_from_coords(buf, ring.coords())? + } + for ring in polygon.interiors() { + write_wkb_points_from_coords(buf, ring.coords())?; + } + } + geo_traits::GeometryType::MultiPoint(multi_point) => { + for point in multi_point.points() { + if let Some(coord) = point.coord() { + write_wkb_point_from_coord(buf, coord)? + } + } + } + geo_traits::GeometryType::MultiLineString(multi_line_string) => { + for line_string in multi_line_string.line_strings() { + write_wkb_points_from_coords(buf, line_string.coords())?; + } + } + geo_traits::GeometryType::MultiPolygon(multi_polygon) => { + for polygon in multi_polygon.polygons() { + if let Some(ring) = polygon.exterior() { + write_wkb_points_from_coords(buf, ring.coords())? + } + for ring in polygon.interiors() { + write_wkb_points_from_coords(buf, ring.coords())?; + } + } + } + geo_traits::GeometryType::GeometryCollection(geometry_collection) => { + for geometry in geometry_collection.geometries() { + write_wkb_points_recursively(buf, geometry)?; + } + } + _ => {} + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use std::sync::Arc; + + use datafusion_expr::ScalarUDF; + use rstest::rstest; + use sedona_schema::datatypes::WKB_VIEW_GEOMETRY; + use sedona_testing::{ + compare::assert_array_equal, create::create_array, testers::ScalarUdfTester, + }; + + use super::*; + + #[test] + fn udf_metadata() { + let st_points_udf: ScalarUDF = st_points_udf().into(); + assert_eq!(st_points_udf.name(), "st_points"); + assert!(st_points_udf.documentation().is_some()); + + let st_npoints_udf: ScalarUDF = st_npoints_udf().into(); + assert_eq!(st_npoints_udf.name(), "st_npoints"); + assert!(st_npoints_udf.documentation().is_some()); + } + + #[rstest] + fn udf(#[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType) { + use arrow_array::UInt64Array; + + let tester_points = ScalarUdfTester::new(st_points_udf().into(), vec![sedona_type.clone()]); + let tester_npoints = + ScalarUdfTester::new(st_npoints_udf().into(), vec![sedona_type.clone()]); + + let input = create_array( + &[ + // 2d + Some("POINT (1 2)"), + Some("LINESTRING (1 2, 3 4, 5 6)"), + Some("POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0))"), + Some("POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0), (1 1, 3 1, 1 3, 1 1))"), + // Some("MULTIPOINT (1 2, EMPTY, 3 4, 5 6)"), // TODO: cannot parse EMPTY? Review Comment: The wkt crate won't parse this but you're right that it can happen. This shares a code path with POINT EMPTY so I don't think we need to test. ```suggestion ``` ########## rust/sedona-functions/src/st_points.rs: ########## @@ -0,0 +1,411 @@ +// 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 arrow_array::builder::{BinaryBuilder, UInt64Builder}; +use arrow_schema::DataType; +use datafusion_common::error::Result; +use datafusion_expr::{ + scalar_doc_sections::DOC_SECTION_OTHER, ColumnarValue, Documentation, Volatility, +}; +use geo_traits::{ + CoordTrait, GeometryCollectionTrait, GeometryTrait, LineStringTrait, MultiLineStringTrait, + MultiPointTrait, MultiPolygonTrait, PointTrait, PolygonTrait, +}; +use sedona_common::sedona_internal_err; +use sedona_expr::scalar_udf::{SedonaScalarKernel, SedonaScalarUDF}; +use sedona_geometry::{ + error::SedonaGeometryError, + wkb_factory::{ + write_wkb_coord_trait, write_wkb_multipoint_header, write_wkb_point_header, + WKB_MIN_PROBABLE_BYTES, + }, +}; +use sedona_schema::{ + datatypes::{SedonaType, WKB_GEOMETRY}, + matchers::ArgMatcher, +}; +use std::{io::Write, sync::Arc}; + +use crate::executor::WkbExecutor; + +/// ST_Points() scalar UDF +/// +/// Native implementation to get all the points of a geometry as MULTIPOINT +pub fn st_points_udf() -> SedonaScalarUDF { + SedonaScalarUDF::new( + "st_points", + vec![Arc::new(STPoints)], + Volatility::Immutable, + Some(st_npoints_doc()), + ) +} + +fn st_points_doc() -> Documentation { + Documentation::builder( + DOC_SECTION_OTHER, + "Returns all the points of a geometry as MULTIPOINT.", + "ST_Points (geom: Geometry)", + ) + .with_argument("geom", "geometry: Input geometry") + .with_sql_example("SELECT ST_Points(ST_GeomFromWKT('LINESTRING(0 1, 2 3, 4 5)'))") + .build() +} + +#[derive(Debug)] +struct STPoints; + +impl SedonaScalarKernel for STPoints { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new(vec![ArgMatcher::is_geometry()], WKB_GEOMETRY); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + 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(), + ); + + executor.execute_wkb_void(|maybe_wkb| { + if let Some(wkb) = maybe_wkb { + // We need to know the number of points before actually writing the points. + let n_points = count_wkb_points_recursively(&wkb); + + if write_wkb_multipoint_header(&mut builder, wkb.dim(), n_points).is_err() { + return sedona_internal_err!("Failed to write WKB point header"); + }; + + if write_wkb_points_recursively(&mut builder, &wkb).is_err() { + return sedona_internal_err!("Failed to write WKB point header"); + }; + + builder.append_value([]); + } else { + builder.append_null(); + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) + } +} + +/// ST_NPoints() scalar UDF +/// +/// Native implementation to count all the points of a geometry +pub fn st_npoints_udf() -> SedonaScalarUDF { + SedonaScalarUDF::new( + "st_npoints", + vec![Arc::new(STNPoints)], + Volatility::Immutable, + Some(st_points_doc()), + ) +} + +fn st_npoints_doc() -> Documentation { + Documentation::builder( + DOC_SECTION_OTHER, + "Returns the count of the points of a geometry.", + "ST_Points (geom: Geometry)", + ) + .with_argument("geom", "geometry: Input geometry") + .with_sql_example("SELECT ST_NPoints(ST_GeomFromWKT('LINESTRING(0 1, 2 3, 4 5)'))") + .build() +} + +#[derive(Debug)] +struct STNPoints; + +impl SedonaScalarKernel for STNPoints { + fn return_type(&self, args: &[SedonaType]) -> Result<Option<SedonaType>> { + let matcher = ArgMatcher::new( + vec![ArgMatcher::is_geometry()], + SedonaType::Arrow(DataType::UInt64), + ); + + matcher.match_args(args) + } + + fn invoke_batch( + &self, + arg_types: &[SedonaType], + args: &[ColumnarValue], + ) -> Result<ColumnarValue> { + let executor = WkbExecutor::new(arg_types, args); + let mut builder = UInt64Builder::with_capacity(executor.num_iterations()); + + executor.execute_wkb_void(|maybe_wkb| { + if let Some(wkb) = maybe_wkb { + builder.append_value(count_wkb_points_recursively(&wkb) as u64); + } else { + builder.append_null(); + } + + Ok(()) + })?; + + executor.finish(Arc::new(builder.finish())) + } +} + +fn count_wkb_points_recursively<'a>(wkb: &'a wkb::reader::Wkb<'a>) -> usize { + match wkb.as_type() { + geo_traits::GeometryType::Point(point) => { + if point.is_empty() { + 0 + } else { + 1 + } + } + geo_traits::GeometryType::LineString(line_string) => line_string.num_coords(), + geo_traits::GeometryType::Polygon(polygon) => { + let mut n = match polygon.exterior() { + Some(ring) => ring.num_coords(), + None => 0, + }; + n += polygon.interiors().map(|r| r.num_coords()).sum::<usize>(); + + n + } + geo_traits::GeometryType::MultiPoint(multi_point) => { + multi_point.points().filter(|p| !p.is_empty()).count() + } + geo_traits::GeometryType::MultiLineString(multi_line_string) => multi_line_string + .line_strings() + .map(|l| l.num_coords()) + .sum(), + geo_traits::GeometryType::MultiPolygon(multi_polygon) => { + let mut n = 0; + for polygon in multi_polygon.polygons() { + n += match polygon.exterior() { + Some(ring) => ring.num_coords(), + None => 0, + }; + n += polygon.interiors().map(|r| r.num_coords()).sum::<usize>(); + } + n + } + geo_traits::GeometryType::GeometryCollection(geometry_collection) => { + let mut n = 0; + for geometry in geometry_collection.geometries() { + n += count_wkb_points_recursively(geometry); + } + n + } + _ => 0, + } +} + +fn write_wkb_point_from_coord( + buf: &mut impl Write, + coord: impl CoordTrait<T = f64>, +) -> Result<(), SedonaGeometryError> { + write_wkb_point_header(buf, coord.dim())?; + write_wkb_coord_trait(buf, &coord) +} + +fn write_wkb_points_from_coords( + buf: &mut impl Write, + coords: impl Iterator<Item = impl CoordTrait<T = f64>>, +) -> Result<(), SedonaGeometryError> { + for coord in coords { + write_wkb_point_from_coord(buf, coord)?; + } + Ok(()) +} + +fn write_wkb_points_recursively<'a>( + buf: &mut impl Write, + wkb: &'a wkb::reader::Wkb<'a>, +) -> Result<(), SedonaGeometryError> { + match wkb.as_type() { + geo_traits::GeometryType::Point(point) => { + if let Some(coord) = point.coord() { + write_wkb_point_from_coord(buf, coord)? + } + } + geo_traits::GeometryType::LineString(line_string) => { + write_wkb_points_from_coords(buf, line_string.coords())?; + } + geo_traits::GeometryType::Polygon(polygon) => { + if let Some(ring) = polygon.exterior() { + write_wkb_points_from_coords(buf, ring.coords())? + } + for ring in polygon.interiors() { + write_wkb_points_from_coords(buf, ring.coords())?; + } + } + geo_traits::GeometryType::MultiPoint(multi_point) => { + for point in multi_point.points() { + if let Some(coord) = point.coord() { + write_wkb_point_from_coord(buf, coord)? + } + } + } + geo_traits::GeometryType::MultiLineString(multi_line_string) => { + for line_string in multi_line_string.line_strings() { + write_wkb_points_from_coords(buf, line_string.coords())?; + } + } + geo_traits::GeometryType::MultiPolygon(multi_polygon) => { + for polygon in multi_polygon.polygons() { + if let Some(ring) = polygon.exterior() { + write_wkb_points_from_coords(buf, ring.coords())? + } + for ring in polygon.interiors() { + write_wkb_points_from_coords(buf, ring.coords())?; + } + } + } + geo_traits::GeometryType::GeometryCollection(geometry_collection) => { + for geometry in geometry_collection.geometries() { + write_wkb_points_recursively(buf, geometry)?; + } + } + _ => {} + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use std::sync::Arc; + + use datafusion_expr::ScalarUDF; + use rstest::rstest; + use sedona_schema::datatypes::WKB_VIEW_GEOMETRY; + use sedona_testing::{ + compare::assert_array_equal, create::create_array, testers::ScalarUdfTester, + }; + + use super::*; + + #[test] + fn udf_metadata() { + let st_points_udf: ScalarUDF = st_points_udf().into(); + assert_eq!(st_points_udf.name(), "st_points"); + assert!(st_points_udf.documentation().is_some()); + + let st_npoints_udf: ScalarUDF = st_npoints_udf().into(); + assert_eq!(st_npoints_udf.name(), "st_npoints"); + assert!(st_npoints_udf.documentation().is_some()); + } + + #[rstest] + fn udf(#[values(WKB_GEOMETRY, WKB_VIEW_GEOMETRY)] sedona_type: SedonaType) { + use arrow_array::UInt64Array; + + let tester_points = ScalarUdfTester::new(st_points_udf().into(), vec![sedona_type.clone()]); + let tester_npoints = + ScalarUdfTester::new(st_npoints_udf().into(), vec![sedona_type.clone()]); + + let input = create_array( + &[ + // 2d + Some("POINT (1 2)"), + Some("LINESTRING (1 2, 3 4, 5 6)"), + Some("POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0))"), + Some("POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0), (1 1, 3 1, 1 3, 1 1))"), + // Some("MULTIPOINT (1 2, EMPTY, 3 4, 5 6)"), // TODO: cannot parse EMPTY? + Some("MULTILINESTRING ((1 2, 3 4), (5 6, 7 8))"), + Some("MULTIPOLYGON (((0 0, 10 0, 10 10, 0 10, 0 0)), ((0 0, 5 0, 0 5, 0 0), (1 1, 3 1, 1 3, 1 1)))"), + Some("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING EMPTY, LINESTRING (3 4, 5 6))"), + // 3d and 4d + Some("LINESTRING Z (1 2 3, 4 5 6, 7 8 9)"), + Some("LINESTRING M (1 2 3, 4 5 6, 7 8 9)"), + Some("LINESTRING ZM (1 2 3 4, 5 6 7 8, 9 0 1 2)"), + // empty + Some("POINT EMPTY"), + Some("LINESTRING EMPTY"), + Some("POLYGON EMPTY"), + Some("MULTIPOINT EMPTY"), + Some("MULTILINESTRING EMPTY"), + Some("MULTIPOLYGON EMPTY"), + Some("GEOMETRYCOLLECTION EMPTY"), + // null + None, + ], + &sedona_type, + ); + + let expected_points = create_array( + &[ + Some("MULTIPOINT (1 2)"), + Some("MULTIPOINT (1 2, 3 4, 5 6)"), + Some("MULTIPOINT (0 0, 10 0, 10 10, 0 10, 0 0)"), + Some("MULTIPOINT (0 0, 10 0, 10 10, 0 10, 0 0, 1 1, 3 1, 1 3, 1 1)"), + // Some("MULTIPOINT (1 2, 3 4, 5 6)"), + Some("MULTIPOINT (1 2, 3 4, 5 6, 7 8)"), + Some("MULTIPOINT (0 0, 10 0, 10 10, 0 10, 0 0, 0 0, 5 0, 0 5, 0 0, 1 1, 3 1, 1 3, 1 1)"), + Some("MULTIPOINT (1 2, 3 4, 5 6)"), + // 3d and 4d + Some("MULTIPOINT Z (1 2 3, 4 5 6, 7 8 9)"), + Some("MULTIPOINT M (1 2 3, 4 5 6, 7 8 9)"), + Some("MULTIPOINT ZM (1 2 3 4, 5 6 7 8, 9 0 1 2)"), + // empty returns empty + Some("MULTIPOINT EMPTY"), + Some("MULTIPOINT EMPTY"), + Some("MULTIPOINT EMPTY"), + Some("MULTIPOINT EMPTY"), + Some("MULTIPOINT EMPTY"), + Some("MULTIPOINT EMPTY"), + Some("MULTIPOINT EMPTY"), + // null + None, + ], + &WKB_GEOMETRY, + ); + + let result_points = tester_points.invoke_array(input.clone()).unwrap(); + assert_array_equal(&result_points, &expected_points); + + let expected_npoints: Arc<dyn arrow_array::Array> = Arc::new(UInt64Array::from(vec![ + Some(1), + Some(3), + Some(5), + Some(9), + // Some("MULTIPOINT (1 2, 3 4, 5 6)"), Review Comment: ```suggestion ``` -- 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]
