Struct Tree2D 

pub struct Tree2D<C, V> { /* private fields */ }

Two-dimensional tree that maps a location given by [C; 2] to a value V.

References

• https://en.wikipedia.org/wiki/K-d_tree

Implementations

impl Tree2D<i64, String>

pub fn write(&self, writer: impl Write) -> Result<()>

Available on crate feature std only.

Writes the tree into a stream in RGC format.

RGC is an internal format of this crate that uses columnar storage to compress the data.

pub fn read(reader: impl Read) -> Result<Self>

Available on crate feature std only.

Reads a tree from the stream in RGC format.

RGC format

RGC is an internal format of this crate that uses columnar storage to compress the data. To obtain a file in such a format you can use CLI utility provided in the Git repo. You can use any OSM-PBF file as an input.

In the following script europe-latest.osm.pbf (32 GiB) is used as an input. CLI utiliy extracts names from each node, compresses them, and produces other.rgc.zst and settlements.rgc.zst. The total size of the resulting files is around 200 MiB.

cargo run --bin geo-coding-cli --release -- convert europe-latest.osm.pbf

impl<C: Ord + Copy + Default, V: Default> Tree2D<C, V>

pub fn from_nodes(nodes: Vec<([C; 2], V)>) -> Self

Create a new tree from the given nodes.

The nodes are recursively subdividded into two groups: one that is behind and one that is in front of the plane that goes through the median node. The plane alternates between x = 0 and y = 0 for each layer of the tree.

The values are moved from the vector without copying.

pub fn find_nearest<D>( &self, location: &[C; 2], max_distance: D, max_neighbours: usize, calc_distance: impl FnMut(&[C; 2], &[C; 2]) -> D, ) -> Vec<(D, &[C; 2], &V)>

where D: Ord + Copy + Display,

Returns up to max_neighbours nodes within max_distance that are closest to the location.

The distance between nodes is computed using calc_distance.

pub fn iter(&self) -> impl Iterator<Item = (&[C; 2], &V)>

Returns an iterator over nodes.

pub fn len(&self) -> usize

Returns the number of nodes.

pub fn is_empty(&self) -> bool

Returns true if the tree is empty.

Trait Implementations

impl<C: Debug, V: Debug> Debug for Tree2D<C, V>

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

Formats the value using the given formatter.

impl<C: PartialEq, V: PartialEq> PartialEq for Tree2D<C, V>

fn eq(&self, other: &Tree2D<C, V>) -> 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<C: Eq, V: Eq> Eq for Tree2D<C, V>

impl<C, V> StructuralPartialEq for Tree2D<C, V>