Struct SearchResults 

pub struct SearchResults<T>(/* private fields */);

A collection of scored values, sorted in descending order by score.

Implementations

impl<T> SearchResults<T>

pub fn new() -> SearchResults<T>

Create an empty collection of scored values.

pub fn from_min_heap( queue: &mut BinaryHeap<Reverse<Scored<T>>>, ) -> SearchResults<T>

Create a collection of search results from a min-heap of scored values.

pub fn push(&mut self, scored: Scored<T>)

Add a new scored value to this collection.

The score provided must be less than or equal to every other score in this collection, otherwise this method will panic.

pub fn normalize(&mut self)

Normalizes the scores in this collection such that all scores are in the range [0, 1] where the top result always has score 1.0.

This operation is idempotent and does not change the ordering of results.

pub fn rescore<F: FnMut(&T) -> f64>(&mut self, rescore: F)

Recomputes the scores in this collection using the given function.

The results are then re-sorted according to the new scores.

pub fn trim(&mut self, size: usize)

Trim this collection so that it contains at most the first size results.

pub fn len(&self) -> usize

Returns the number of results in this collection.

pub fn is_empty(&self) -> bool

Returns true if and only if this collection is empty.

pub fn as_slice(&self) -> &[Scored<T>]

Return a slice of search results in order.

pub fn into_vec(self) -> Vec<Scored<T>>

Consume this collection and return the underlying sorted sequence of scored values.

Trait Implementations

impl<T: Clone> Clone for SearchResults<T>

fn clone(&self) -> SearchResults<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SearchResults<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for SearchResults<T>

fn default() -> SearchResults<T>

Returns the “default value” for a type.

impl<T> IntoIterator for SearchResults<T>

type IntoIter = IntoIter<Scored<T>>

Which kind of iterator are we turning this into?

type Item = Scored<T>

The type of the elements being iterated over.

fn into_iter(self) -> IntoIter<Scored<T>>

Creates an iterator from a value.