pwrliang commented on code in PR #645: URL: https://github.com/apache/sedona-db/pull/645#discussion_r2890725938
########## rust/sedona-spatial-join/src/index/default_spatial_index.rs: ########## @@ -0,0 +1,2032 @@ +// 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::{ + ops::Range, + sync::{ + atomic::{AtomicUsize, Ordering}, + Arc, + }, +}; + +use arrow_array::RecordBatch; +use arrow_schema::SchemaRef; +use datafusion_common::{DataFusionError, Result}; +use datafusion_common_runtime::JoinSet; +use float_next_after::NextAfter; +use geo::BoundingRect; +use geo_index::rtree::{ + distance::{DistanceMetric, GeometryAccessor}, + util::f64_box_to_f32, +}; +use geo_index::rtree::{sort::HilbertSort, RTree, RTreeBuilder, RTreeIndex}; +use geo_index::IndexableNum; +use geo_types::Rect; +use parking_lot::Mutex; +use sedona_expr::statistics::GeoStatistics; +use sedona_geo::to_geo::item_to_geometry; +use wkb::reader::Wkb; + +use crate::index::spatial_index::DISTANCE_TOLERANCE; +use crate::index::SpatialIndex; +use crate::{ + evaluated_batch::EvaluatedBatch, + index::{ + knn_adapter::{KnnComponents, SedonaKnnAdapter}, + IndexQueryResult, QueryResultMetrics, + }, + operand_evaluator::{create_operand_evaluator, distance_value_at, OperandEvaluator}, + refine::{create_refiner, IndexQueryResultRefiner}, + spatial_predicate::SpatialPredicate, +}; +use arrow::array::BooleanBufferBuilder; +use async_trait::async_trait; +use sedona_common::{option::SpatialJoinOptions, sedona_internal_err, ExecutionMode}; + +struct DefaultSpatialIndexInner { + pub(crate) schema: SchemaRef, + pub(crate) options: SpatialJoinOptions, + + /// The spatial predicate evaluator for the spatial predicate. + pub(crate) evaluator: Arc<dyn OperandEvaluator>, + + /// The refiner for refining the index query results. + pub(crate) refiner: Arc<dyn IndexQueryResultRefiner>, + + /// R-tree index for the geometry batches. It takes MBRs as query windows and returns + /// data indexes. These data indexes should be translated using `data_id_to_batch_pos` to get + /// the original geometry batch index and row index, or translated using `prepared_geom_idx_vec` + /// to get the prepared geometries array index. + pub(crate) rtree: RTree<f32>, + + /// Indexed batches containing evaluated geometry arrays. It contains the original record + /// batches and geometry arrays obtained by evaluating the geometry expression on the build side. + pub(crate) indexed_batches: Vec<EvaluatedBatch>, + /// An array for translating rtree data index to geometry batch index and row index + pub(crate) data_id_to_batch_pos: Vec<(i32, i32)>, + + /// An array for translating rtree data index to consecutive index. Each geometry may be indexed by + /// multiple boxes, so there could be multiple data indexes for the same geometry. A mapping for + /// squashing the index makes it easier for persisting per-geometry auxiliary data for evaluating + /// the spatial predicate. This is extensively used by the spatial predicate evaluators for storing + /// prepared geometries. + pub(crate) geom_idx_vec: Vec<usize>, + + /// Shared bitmap builders for visited build side indices, one per batch + pub(crate) visited_build_side: Option<Mutex<Vec<BooleanBufferBuilder>>>, + + /// Counter of running probe-threads, potentially able to update `bitmap`. + /// Each time a probe thread finished probing the index, it will decrement the counter. + /// The last finished probe thread will produce the extra output batches for unmatched + /// build side when running left-outer joins. See also [`report_probe_completed`]. + pub(crate) probe_threads_counter: AtomicUsize, + + /// Shared KNN components (distance metrics and geometry cache) for efficient KNN queries + pub(crate) knn_components: Option<KnnComponents>, +} + +#[derive(Clone)] +pub struct DefaultSpatialIndex { + inner: Arc<DefaultSpatialIndexInner>, +} + +impl DefaultSpatialIndex { + pub(crate) fn empty( + spatial_predicate: SpatialPredicate, + schema: SchemaRef, + options: SpatialJoinOptions, + probe_threads_counter: AtomicUsize, + ) -> Self { + let evaluator = create_operand_evaluator(&spatial_predicate, options.clone()); + let refiner = create_refiner( + options.spatial_library, + &spatial_predicate, + options.clone(), + 0, + GeoStatistics::empty(), + ); + let rtree = RTreeBuilder::<f32>::new(0).finish::<HilbertSort>(); + let knn_components = matches!(spatial_predicate, SpatialPredicate::KNearestNeighbors(_)) + .then(|| KnnComponents::new(0, &[]).unwrap()); + Self { + inner: Arc::new(DefaultSpatialIndexInner { + schema, + options, + evaluator, + refiner, + rtree, + data_id_to_batch_pos: Vec::new(), + indexed_batches: Vec::new(), + geom_idx_vec: Vec::new(), + visited_build_side: None, + probe_threads_counter, + knn_components, + }), + } + } + #[allow(clippy::too_many_arguments)] + pub fn new( + schema: SchemaRef, + options: SpatialJoinOptions, + evaluator: Arc<dyn OperandEvaluator>, + refiner: Arc<dyn IndexQueryResultRefiner>, + rtree: RTree<f32>, + indexed_batches: Vec<EvaluatedBatch>, + data_id_to_batch_pos: Vec<(i32, i32)>, + geom_idx_vec: Vec<usize>, + visited_build_side: Option<Mutex<Vec<BooleanBufferBuilder>>>, + probe_threads_counter: AtomicUsize, + knn_components: Option<KnnComponents>, + ) -> Self { + Self { Review Comment: I have declared it as pub(crate) -- 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]
