Struct TopK 

pub struct TopK { /* private fields */ }

A bounded top-k heap with the pinned tie-break.

Ordering is descending score then ascending document id, matching crate::fts::search exactly. The threshold this exposes is what every pruning decision is made against.

Implementations

impl TopK

pub fn new(capacity: usize) -> Self

Creates a heap holding at most capacity entries.

pub fn offer(&mut self, doc: GlobalDocId, score: f64)

Offers one scored document.

Insertion into a sorted array, not a sort on every offer. For k of order one hundred that is strictly less work, and it reproduces the pinned tie-break exactly: the comparator is the same one, and the scan stops at the first entry the newcomer does not precede, which is where a stable sort would have placed it.

pub fn threshold(&self) -> f64

Returns the current k-th best score, or zero while not yet full.

Returning zero rather than negative infinity while the heap is filling is deliberate: BM25 scores are non-negative, so zero already admits everything, and it keeps the threshold monotone.

pub fn is_full(&self) -> bool

Returns true when the heap holds capacity entries.

pub fn into_hits(self) -> Vec<ScoredDoc>

Consumes the heap into ranked results.

Trait Implementations

impl Clone for TopK

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopK

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

Formats the value using the given formatter.

impl Default for TopK

fn default() -> Self

Returns the “default value” for a type.