Struct KDTreeMetadata

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

Common metadata to describe a KDTree

You can use the metadata to infer the total byte size of a tree given the provided criteria. See data_buffer_length.

Implementations

impl<N: IndexableNum> KDTreeMetadata<N>

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

Construct a new KDTreeMetadata from a number of items and node size.

pub fn from_slice(data: &[u8]) -> Result<Self, GeoIndexError>

Construct a new KDTreeMetadata from an existing byte slice conforming to the “kdbush ABI”, such as what [KDTreeBuilder] generates.

pub fn node_size(&self) -> u16

The maximum number of items per node.

pub fn num_items(&self) -> u32

The number of items indexed in the tree.

pub fn data_buffer_length(&self) -> usize

The number of bytes that a KDTree with this metadata would have.

use geo_index::kdtree::KDTreeMetadata;

let metadata = KDTreeMetadata::<f64>::new(25000, 16);
assert_eq!(metadata.data_buffer_length(), 450_008);

pub fn coords_slice<'a>(&self, data: &'a [u8]) -> &'a [N]

Access the slice of coordinates from the data buffer this metadata represents.

pub fn indices_slice<'a>(&self, data: &'a [u8]) -> Indices<'a>

Access the slice of indices from the data buffer this metadata represents.

Trait Implementations

impl<N: Clone + IndexableNum> Clone for KDTreeMetadata<N>

fn clone(&self) -> KDTreeMetadata<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<N: PartialEq + IndexableNum> PartialEq for KDTreeMetadata<N>

fn eq(&self, other: &KDTreeMetadata<N>) -> 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<N: Copy + IndexableNum> Copy for KDTreeMetadata<N>

impl<N: IndexableNum> StructuralPartialEq for KDTreeMetadata<N>