Struct BoxIndex 

pub struct BoxIndex<T: BoxIndexAccessor + Clone> {
    pub bbox: BBox,
    /* private fields */
}

BoxIndex

Description

An Index for points and rectangles

A really fast static spatial index for 2D points and rectangles in JavaScript. Uses either a fast simple Hilbert curve algorithm or a more complex Hilbert curve (S2) algorithm.

This is a partial port/rust port of the flatbush codebase. The port is designed to work with this library and also S2 cells.

The default hilbert curve ported is simpler and originally designed for simpler datasets. This library also provides the S2 hilbert curve for cm precision of the Earth using S2 cells.

Usage

use gistools::data_structures::{BoxIndex, BoxIndexAccessor};
use gistools::proj::Coords;
use s2json::BBox;

// Test item
#[derive(Debug, Clone, PartialEq)]
struct Item {
    pub id: usize,
    pub min_x: f64,
    pub min_y: f64,
    pub max_x: f64,
    pub max_y: f64,
}
// define how to access the min_x, min_y, max_x, and max_y properties
impl BoxIndexAccessor for Item {
    fn bbox(&self) -> BBox {
        BBox::new(self.min_x, self.min_y, self.max_x, self.max_y)
    }
}

// create the index
let mut index = BoxIndex::<Item>::new(vec![], None);

// make a bounding box query
let items = index.search(&BBox::new(40.0, 40.0, 60.0, 60.0), None::<fn(&Item) -> bool>);

// make a k-nearest-neighbors query
let items =
    index.neighbors(Coords::new_xy(50., 50.), Some(3), None, None::<fn(&Item) -> bool>);

Links

• https://github.com/mourner/flatbush

Fields

bbox: BBox

full bounding box of the index

Implementations

impl<T: BoxIndexAccessor + Clone> BoxIndex<T>

pub fn new(items: Vec<T>, node_size: Option<usize>) -> Self

Create a BoxIndex index that will hold a given number of items.

Parameters

• items: The items to index. Requires the item type to implement BoxIndexAccessor.
• accessor: A function for accessing the min_x, min_y, max_x, and max_y properties of the items.
• [node_size]: Size of the tree node (16 by default).

pub fn index(&mut self)

Perform indexing of the added rectangles/points after all data has been added about the items.

pub fn search( &self, bbox: &BBox, filter_fn: Option<impl Fn(&T) -> bool>, ) -> Vec<T>

Search the index by a bounding box.

Parameters

• min_x: The minimum x coordinate of the query point.
• min_y: The minimum y coordinate of the query point.
• max_x: The maximum x coordinate of the query point.
• max_y: The maximum y coordinate of the query point.
• [filter_fn]: An optional function that is called on every found item; if supplied, only items for which this function returns true will be included in the results array.

Returns

An array of indices of items intersecting or touching the given bounding box.

pub fn neighbors<P: GetXY>( &self, p: P, max_results: Option<usize>, max_distance: Option<f64>, filter_fn: Option<impl Fn(&T) -> bool>, ) -> Vec<T>

Search items in order of distance from the given point.

Parameters

• x: The x coordinate of the query point.
• y: The y coordinate of the query point.
• [max_results]: The maximum number of results to return.
• [max_distance]: The maximum distance to search.
• [filter_fn]: An optional function for filtering the results.

Returns

An array of indices of items found.

pub fn take(&mut self) -> Vec<T>

Get the items that have been added to the index. If taken, this index will be empty.

Trait Implementations

impl<T: Clone + BoxIndexAccessor + Clone> Clone for BoxIndex<T>

fn clone(&self) -> BoxIndex<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + BoxIndexAccessor + Clone> Debug for BoxIndex<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: PartialEq + BoxIndexAccessor + Clone> PartialEq for BoxIndex<T>

fn eq(&self, other: &BoxIndex<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: BoxIndexAccessor + Clone> StructuralPartialEq for BoxIndex<T>