Struct CellIndex 

pub struct CellIndex { /* private fields */ }

The index.

Implementations

impl CellIndex

pub fn new(w: f64, arc: f64) -> Self

Build an index with band width w and target sector arc arc, both in hyperbolic units. Measured on 5 461 nodes: 0.5 / 0.5 gives 1 184 cells with a largest cell of 43 (the fixed buckets gave 26 cells and 1 462). Both are stored so cells stay reproducible.

pub fn parameters(&self) -> (f64, f64)

Band width and target arc this index was built with.

pub fn len(&self) -> usize

Live node count.

pub fn is_empty(&self) -> bool

Whether the index holds no nodes.

pub fn cell_count(&self) -> usize

Number of materialised cells — occupancy diagnostics.

pub fn cell_of(&self, point: &HyperbolicPoint) -> CellId

The cell a point belongs to. Comparisons and one division; no transcendental.

pub fn insert(&self, unique_id: &str, point: &HyperbolicPoint)

Register a node. Re-registering an id moves it to its new cell.

pub fn remove(&self, unique_id: &str)

Drop a node.

pub fn knn( &self, query: &HyperbolicPoint, k: usize, ) -> Vec<(String, FixedPoint)>

The k nearest nodes to query, ascending by (distance, unique_id).

pub fn within_radius( &self, centre: &HyperbolicPoint, radius: FixedPoint, ) -> Vec<(String, FixedPoint)>

Every node within radius (hyperbolic) of centre.

Trait Implementations

impl Default for CellIndex

fn default() -> Self

Returns the “default value” for a type.