Skip to main content

Range

diskann_benchmark_core::search::graph::range

Struct Range

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

Expand description

A built-in helper for benchmarking the range search method [graph::DiskANNIndex::range_search].

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 Aggregator type.

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

Implementations§

impl<DP, T, S> Range<DP, T, S>
where DP: DataProvider,

pub fn new( index: Arc<DiskANNIndex<DP>>, queries: Arc<Matrix<T>>, strategy: Strategy<S>, ) -> Result<Arc<Self>>

Construct a new Range 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.

§Errors

Returns an error if the number of elements in strategy is not compatible with the number of rows in queries.

Trait Implementations§

impl<DP, T: Debug, S: Debug> Debug for Range<DP, T, S>
where DP: DataProvider + Debug,

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

Formats the value using the given formatter. Read more

impl<DP, T, S> Search for Range<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 = Range

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.

Auto Trait Implementations§

impl<DP, T, S> Freeze for Range<DP, T, S>
where S: Freeze,

impl<DP, T, S> !RefUnwindSafe for Range<DP, T, S>

impl<DP, T, S> Send for Range<DP, T, S>
where S: Send, T: Sync + Send,

impl<DP, T, S> Sync for Range<DP, T, S>
where S: Sync, T: Sync + Send,

impl<DP, T, S> Unpin for Range<DP, T, S>
where S: Unpin,

impl<DP, T, S> UnsafeUnpin for Range<DP, T, S>
where S: UnsafeUnpin,

impl<DP, T, S> !UnwindSafe for Range<DP, T, S>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> DispatchRule<T> for T

type Error = Infallible

Errors that can occur during convert.

fn try_match(_from: &T) -> Result<MatchScore, FailureScore>

Attempt to match the value From to the type represented by Self. Read more

fn convert(from: T) -> Result<T, <T as DispatchRule<T>>::Error>

Perform the actual conversion. Read more

fn description(f: &mut Formatter<'_>, from: Option<&T>) -> Result<(), Error>

Write a description of the dispatch rule and outcome to the formatter. Read more

fn try_match_verbose<'a>( from: &'a From, ) -> Result<MatchScore, TaggedFailureScore<'a>>
where Self: 'a,

The equivalent of try_match but returns a reason for a failed score. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> AsyncFriendly for T
where T: Send + Sync + 'static,