Struct ntree::NTree

pub struct NTree<R, P> { /* fields omitted */ }

A quadtree-like structure, but for arbitrary arity.

Regions can split themselves into arbitrary numbers of splits, allowing this structure to be used to index data by any number of attributes and quickly query for data that falls within a specific range.

Methods

impl<P, R: Region<P>> NTree<R, P>

fn new(region: R, size: u8) -> NTree<R, P>

Create a new n-tree which contains points within the region and whose buckets are limited to the passed-in size.

The number of regions returned by region.split() dictates the arity of the tree.

fn insert(&mut self, point: P) -> bool

Insert a point into the n-tree, returns true if the point is within the n-tree and was inserted and false if not.

fn range_query<'t, 'q>(&'t self, query: &'q R) -> RangeQuery<'t, 'q, R, P>

Get all the points which within the queried region.

Finds all points which are located in regions overlapping the passed in region, then filters out all points which are not strictly within the region.

fn contains(&self, point: &P) -> bool

Is the point contained in the n-tree?

fn nearby<'a>(&'a self, point: &P) -> Option<&'a [P]>

Get all the points nearby a specified point.

This will return no more than bucket_limit points.