petern48 commented on code in PR #257: URL: https://github.com/apache/sedona-db/pull/257#discussion_r2476234739
########## 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()), Review Comment: ```suggestion Some(st_npoints_doc()), ``` ########## 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()), Review Comment: ```suggestion Some(st_points_doc()), ``` -- 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]
