Skip to main content

VectorTopK

Struct VectorTopK 

Source
pub struct VectorTopK<K> { /* private fields */ }
Expand description

Bounded deterministic lower-is-better vector hit accumulator.

This is the streaming form of exact_vector_top_k. It keeps only the current best k hits in memory, so graph-layer exact scans can avoid materializing every candidate before ranking.

Implementations§

Source§

impl<K: Ord> VectorTopK<K>

Source

pub fn new(k: usize) -> Self

Construct an empty accumulator that will retain at most k hits.

Source

pub const fn k(&self) -> usize

Return the configured result cap.

Source

pub fn len(&self) -> usize

Return the number of retained hits.

Source

pub fn is_empty(&self) -> bool

Return true when no hits are retained.

Source

pub fn push_distance(&mut self, key: K, distance: f64)

Push one candidate distance into the accumulator.

distance must be a finite lower-is-better score produced by VectorMetric::distance or an equivalent metric kernel. Ties are deterministic: lower distance wins, then lower key wins.

Source

pub fn into_hits(self) -> Vec<VectorSearchHit<K>>

Return retained hits sorted best-first.

Trait Implementations§

Source§

impl<K: Debug> Debug for VectorTopK<K>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<K> Freeze for VectorTopK<K>

§

impl<K> RefUnwindSafe for VectorTopK<K>
where K: RefUnwindSafe,

§

impl<K> Send for VectorTopK<K>
where K: Send,

§

impl<K> Sync for VectorTopK<K>
where K: Sync,

§

impl<K> Unpin for VectorTopK<K>
where K: Unpin,

§

impl<K> UnsafeUnpin for VectorTopK<K>

§

impl<K> UnwindSafe for VectorTopK<K>
where K: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.