Struct TopK 

pub struct TopK { /* private fields */ }

Collects the k best (smallest-score) neighbors from a stream of candidates in O(N log k) time and O(k) memory.

Never materializes all candidate distances — suitable for a brute-force scan over an arbitrarily large store, or for bounding a graph beam.

Implementations

impl TopK

pub fn new(k: usize) -> Self

Create a collector retaining up to k neighbors.

k == 0 yields a collector that keeps nothing.

pub fn offer(&mut self, candidate: Neighbor)

Offer a candidate. Kept only if it ranks among the best k seen so far.

pub fn worst_score(&self) -> Option<f32>

The current worst (largest) retained score, or None if empty.

Useful as a beam-search cutoff: once k neighbors are held, any candidate not better than this can be skipped.

pub fn is_full(&self) -> bool

Whether the collector is full (holds exactly k neighbors).

pub fn len(&self) -> usize

Number of neighbors currently retained.

pub fn is_empty(&self) -> bool

Whether no neighbors are retained.

pub fn into_sorted_vec(self) -> Vec<Neighbor>

Consume the collector, returning neighbors sorted ascending (best first).

Trait Implementations

impl Debug for TopK

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

Formats the value using the given formatter.