Struct KDTreeBuilder 

pub struct KDTreeBuilder<N: IndexableNum> { /* private fields */ }

A builder to create an KDTree.

Implementations

impl<N: IndexableNum> KDTreeBuilder<N>

pub fn new(num_items: u32) -> Self

Create a new builder with the provided number of items and the default node size.

pub fn new_with_node_size(num_items: u32, node_size: u16) -> Self

Create a new builder with the provided number of items and node size.

pub fn from_metadata(metadata: KDTreeMetadata<N>) -> Self

Create a new builder with the provided metadata

pub fn metadata(&self) -> &KDTreeMetadata<N>

Access the underlying KDTreeMetadata of this instance.

pub fn add(&mut self, x: N, y: N) -> u32

Add a point to the KDTree.

This returns a positional index that provides a lookup back into the original data.

pub fn add_coord(&mut self, coord: &impl CoordTrait<T = N>) -> u32

Add a coord to the KDTree.

This returns a positional index that provides a lookup back into the original data.

pub fn add_point( &mut self, point: &impl PointTrait<T = N>, ) -> Result<u32, GeoIndexError>

Add a point to the KDTree.

This returns a positional index that provides a lookup back into the original data.

Errors

• If the point is empty.

pub fn finish(self) -> KDTree<N>

Consume this builder, perfoming the k-d sort and generating a KDTree ready for queries.

Trait Implementations

impl<N: Debug + IndexableNum> Debug for KDTreeBuilder<N>

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

Formats the value using the given formatter.