Struct ball_tree::Query

pub struct Query<'tree, P, V> { /* private fields */ }

A context for repeated nearest-neighbor queries that internally re-uses memory across queries.

Implementations

impl<'tree, P: Point, V> Query<'tree, P, V>

pub fn nn<'query>( &'query mut self, point: &'query P ) -> Iter<'tree, 'query, P, V>

Given a point, return an Iterator that yields neighbors from closest to farthest. To get the K nearest neighbors, simply take K from the iterator.

The neighbor, its distance, and associated value are returned.

pub fn nn_within<'query>( &'query mut self, point: &'query P, max_radius: f64 ) -> Iter<'tree, 'query, P, V>

The same as nn but only consider neighbors whose distance is <= max_radius.

pub fn allocated_size(&self) -> usize

Return the size in bytes of the memory this Query is keeping internally to avoid allocation.

pub fn deallocate_memory(&mut self)

The Query object re-uses memory internally to avoid allocation. This method deallocates that memory.

Trait Implementations

impl<'tree, P: Clone, V: Clone> Clone for Query<'tree, P, V>

fn clone(&self) -> Query<'tree, P, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tree, P: Debug, V: Debug> Debug for Query<'tree, P, V>

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

Formats the value using the given formatter.