Struct MultiHop 

pub struct MultiHop<DP, T, S>
where
    DP: DataProvider,
{ /* private fields */ }

A built-in helper for benchmarking filtered K-nearest neighbors search using the multi-hop search method.

This is intended to be used in conjunction with search::search or search::search_all and provides some basic additional metrics for the latter. Result aggregation for search::search_all is provided by the search::graph::knn::Aggregator type (same aggregator as search::graph::knn::KNN).

The provided implementation of Search accepts graph::search::Knn and returns search::graph::knn::Metrics as additional output.

Implementations

impl<DP, T, S> MultiHop<DP, T, S>

where DP: DataProvider,

pub fn new( index: Arc<DiskANNIndex<DP>>, queries: Arc<Matrix<T>>, strategy: Strategy<S>, labels: Arc<[Arc<dyn QueryLabelProvider<DP::InternalId>>]>, ) -> Result<Arc<Self>>

Construct a new MultiHop searcher.

If strategy is one of the container variants of Strategy, its length must match the number of rows in queries. If this is the case, then the strategies will have a querywise correspondence (see search::SearchResults) with the query matrix.

Additionally, the length of labels must match the number of rows in queries and will be used in querywise correspondence with queries.

Errors

Returns an error under the following conditions.

1. The number of elements in strategy is not compatible with the number of rows in queries.

2. The number of label providers in labels is not equal to the number of rows in queries.

Trait Implementations

impl<DP, T: Debug, S: Debug> Debug for MultiHop<DP, T, S>

where DP: DataProvider + Debug, DP::InternalId: Debug,

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

Formats the value using the given formatter.

impl<DP, T, S> Search for MultiHop<DP, T, S>

where DP: DataProvider<Context: Default, ExternalId: Id>, S: for<'a> DefaultSearchStrategy<DP, &'a [T], DP::ExternalId> + Clone + AsyncFriendly, T: AsyncFriendly + Clone,

type Id = <DP as DataProvider>::ExternalId

The identifier for the type returned by search. These are canonically the unique IDs associated with indexed vectors.

type Parameters = Knn

Custom input search parameters.

type Output = Metrics

Custom output parameters. This augments the standard metrics collected by search and allows implementation-specific data to be returned.

fn num_queries(&self) -> usize

The number of queries that can be searched. The machinery in search and search_all will invoke Search::search for each index in 0..N where N is the returned value of this method.

fn id_count(&self, parameters: &Self::Parameters) -> IdCount

Provide a hint for the number of IDs returned for each query. This is used to optimize internal buffer allocations.

async fn search<O>( &self, parameters: &Self::Parameters, buffer: &mut O, index: usize, ) -> ANNResult<Self::Output>

where O: SearchOutputBuffer<DP::ExternalId> + Send,

Perform a search for the query identified by index using parameters. The results must be written into buffer. Customized output is returned.