Struct KDTreeIndex 

pub struct KDTreeIndex<IX: IndexValue> {
    pub kdbush: Option<KDBush>,
    /* private fields */
}

A very fast static spatial index for 2D points based on a flat KD-tree.

Operates only the centroid coordinate, not on envelopes / bounding boxes.

Example

use polars::prelude::UInt64Chunked;
use h3ron::H3Cell;
use h3ron_polars::{AsH3CellChunked, NamedFromIndexes};
use h3ron_polars::spatial_index::BuildKDTreeIndex;

let uc = UInt64Chunked::new_from_indexes(
    "",
    vec![
        H3Cell::from_coordinate((45.5, 45.5).into(), 7).unwrap(),
        H3Cell::from_coordinate((-60.5, -60.5).into(), 7).unwrap(),
        H3Cell::from_coordinate((120.5, 70.5).into(), 7).unwrap(),
    ],
);

let idx = uc.h3cell().kdtree_index();

Fields

kdbush: Option<KDBush>

Trait Implementations

impl<IX> SpatialIndex<IX, CoordinateSIKind> for KDTreeIndex<IX>

where IX: CoordinateIndexable + IndexValue,

fn h3indexchunked(&self) -> IndexChunked<'_, IX>

fn envelopes_intersect_impl(&self, rect: &Rect) -> MutableBitmap

internal

fn envelopes_within_distance( &self, coord: Coord, distance: f64, ) -> BooleanChunked

The envelope of the indexed elements is with distance of the given Coord coord.

fn envelopes_intersect(&self, rect: &Rect) -> BooleanChunked

The envelope of the indexed elements has some overlap with the given rect