File ResultHandler.h

Defines

DISPATCH_C_SEL(C, use_sel)

DISPATCH_C_SEL(C, use_sel)

namespace faiss

Implementation of k-means clustering with many variants.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

IDSelector is intended to define a subset of vectors to handle (for removal or as subset to search)

PQ4 SIMD packing and accumulation functions

The basic kernel accumulates nq query vectors with bbs = nb * 2 * 16 vectors and produces an output matrix for that. It is interesting for nq * nb <= 4, otherwise register spilling becomes too large.

The implementation of these functions is spread over 3 cpp files to reduce parallel compile times. Templates are instantiated explicitly.

This file contains callbacks for kernels that compute distances.

Throughout the library, vectors are provided as float * pointers. Most algorithms can be optimized when several vectors are processed (added/searched) together in a batch. In this case, they are passed in as a matrix. When n vectors of size d are provided as float * x, component j of vector i is

x[ i * d + j ]

where 0 <= i < n and 0 <= j < d. In other words, matrices are always compact. When specifying the size of the matrix, we call it an n*d matrix, which implies a row-major storage.

I/O functions can read/write to a filename, a file handle or to an object that abstracts the medium.

The read functions return objects that should be deallocated with delete. All references within these objectes are owned by the object.

Definition of inverted lists + a few common classes that implement the interface.

Since IVF (inverted file) indexes are of so much use for large-scale use cases, we group a few functions related to them in this small library. Most functions work both on IndexIVFs and IndexIVFs embedded within an IndexPreTransform.

In this file are the implementations of extra metrics beyond L2 and inner product

Implements a few neural net layers, mainly to support QINCo

Defines a few objects that apply transformations to a set of vectors Often these are pre-processing steps.

Functions

template<class Consumer, class ...Types> Consumer::T dispatch_knn_ResultHandler(size_t nx, float *vals, int64_t *ids, size_t k, MetricType metric, const IDSelector *sel, Consumer &consumer, Types... args)

template<class Consumer, class ...Types> Consumer::T dispatch_range_ResultHandler(RangeSearchResult *res, float radius, MetricType metric, const IDSelector *sel, Consumer &consumer, Types... args)

Variables

FAISS_API int distance_compute_min_k_reservoir

template<class C> struct ResultHandler

Subclassed by faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler, faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler, faiss::ReservoirTopN< C >, faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler

Public Functions

virtual bool add_result(typename C::T dis, typename C::TI idx) = 0

inline virtual ~ResultHandler()

Public Members

C::T threshold = C::neutral()

template<class C, bool use_sel = false> struct BlockResultHandler

Public Functions

inline explicit BlockResultHandler(size_t nq, const IDSelector *sel = nullptr)

inline virtual void begin_multiple(size_t i0_2, size_t i1_2)

inline virtual void add_results(size_t, size_t, const typename C::T*)

inline virtual void end_multiple()

inline virtual ~BlockResultHandler()

inline bool is_in_selection(idx_t i) const

Public Members

size_t nq

const IDSelector *sel

size_t i0 = 0

size_t i1 = 0

template<class C, bool use_sel = false> struct Top1BlockResultHandler : public faiss::BlockResultHandler<C, false>

Public Types

using T = typename C::T

using TI = typename C::TI

Public Functions

inline Top1BlockResultHandler(size_t nq, T *dis_tab, TI *ids_tab, const IDSelector *sel = nullptr)

inline virtual void begin_multiple(size_t i0, size_t i1) final: begin

inline void add_results(size_t j0, size_t j1, const T *dis_tab_2) final: add results for query i0..i1 and j0..j1

inline void add_result(const size_t i, const T dis, const TI idx)

inline virtual void add_results(size_t, size_t, const typename C::T*)

inline virtual void end_multiple()

inline bool is_in_selection(idx_t i) const

Public Members

T *dis_tab

TI *ids_tab

size_t nq

const IDSelector *sel

size_t i0

size_t i1

struct SingleResultHandler : public faiss::ResultHandler<C>

Public Functions

inline explicit SingleResultHandler(Top1BlockResultHandler &hr)

inline void begin(const size_t current_idx_2): begin results for query # i

inline virtual bool add_result(T dis, TI idx) final: add one result for query i

inline void end(): series of results for query i is done

Public Members

Top1BlockResultHandler &hr

TI min_idx

size_t current_idx = 0

C::T threshold = C::neutral()

template<class C, bool use_sel = false> struct HeapBlockResultHandler : public faiss::BlockResultHandler<C, false>

Public Types

using T = typename C::T

using TI = typename C::TI

Public Functions

inline HeapBlockResultHandler(size_t nq, T *heap_dis_tab, TI *heap_ids_tab, size_t k, const IDSelector *sel = nullptr)

inline virtual void begin_multiple(size_t i0_2, size_t i1_2) final: begin

inline void add_results(size_t j0, size_t j1, const T *dis_tab) final: add results for query i0..i1 and j0..j1

inline virtual void end_multiple() final: series of results for queries i0..i1 is done

inline virtual void add_results(size_t, size_t, const typename C::T*)

inline bool is_in_selection(idx_t i) const

Public Members

T *heap_dis_tab

TI *heap_ids_tab

int64_t k

size_t nq

const IDSelector *sel

size_t i0

size_t i1

struct SingleResultHandler : public faiss::ResultHandler<C>

Public Functions

inline explicit SingleResultHandler(HeapBlockResultHandler &hr)

inline void begin(size_t i): begin results for query # i

inline virtual bool add_result(T dis, TI idx) final: add one result for query i

inline void end(): series of results for query i is done

Public Members

HeapBlockResultHandler &hr

size_t k

T *heap_dis

TI *heap_ids

C::T threshold = C::neutral()

template<class C> struct ReservoirTopN : public faiss::ResultHandler<C>

#include <ResultHandler.h>

Reservoir for a single query.

Subclassed by faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler

Public Types

using T = typename C::T

using TI = typename C::TI

Public Functions

inline ReservoirTopN()

inline ReservoirTopN(size_t n, size_t capacity, T *vals, TI *ids)

inline virtual bool add_result(T val, TI id) final

inline void add(T val, TI id)

inline void shrink_fuzzy()

inline void shrink()

inline void to_result(T *heap_dis, TI *heap_ids) const

Public Members

T *vals

TI *ids

size_t i

size_t n

size_t capacity

C::T threshold = C::neutral()

template<class C, bool use_sel = false> struct ReservoirBlockResultHandler : public faiss::BlockResultHandler<C, false>

Public Types

using T = typename C::T

using TI = typename C::TI

Public Functions

inline ReservoirBlockResultHandler(size_t nq, T *heap_dis_tab, TI *heap_ids_tab, size_t k, const IDSelector *sel = nullptr)

inline virtual void begin_multiple(size_t i0_2, size_t i1_2): begin

inline void add_results(size_t j0, size_t j1, const T *dis_tab): add results for query i0..i1 and j0..j1

inline virtual void end_multiple() final: series of results for queries i0..i1 is done

inline virtual void add_results(size_t, size_t, const typename C::T*)

inline bool is_in_selection(idx_t i) const

Public Members

T *heap_dis_tab

TI *heap_ids_tab

int64_t k

size_t capacity

std::vector<T> reservoir_dis

std::vector<TI> reservoir_ids

std::vector<ReservoirTopN<C>> reservoirs

size_t nq

const IDSelector *sel

size_t i0

size_t i1

struct SingleResultHandler : public faiss::ReservoirTopN<C>

Public Types

using T = typename C::T

using TI = typename C::TI

Public Functions

inline explicit SingleResultHandler(ReservoirBlockResultHandler &hr)

inline void begin(size_t qno_2): begin results for query # i

inline void end(): series of results for query qno is done

inline virtual bool add_result(T val, TI id) final

inline void add(T val, TI id)

inline void shrink_fuzzy()

inline void shrink()

inline void to_result(T *heap_dis, TI *heap_ids) const

Public Members

ReservoirBlockResultHandler &hr

std::vector<T> reservoir_dis

std::vector<TI> reservoir_ids

size_t qno

T *vals

TI *ids

size_t i

size_t n

size_t capacity

C::T threshold = C::neutral()

template<class C, bool use_sel = false> struct RangeSearchBlockResultHandler : public faiss::BlockResultHandler<C, false>

Public Types

using T = typename C::T

using TI = typename C::TI

Public Functions

inline RangeSearchBlockResultHandler(RangeSearchResult *res, float radius, const IDSelector *sel = nullptr)

inline virtual void begin_multiple(size_t i0_2, size_t i1_2): begin

inline void add_results(size_t j0, size_t j1, const T *dis_tab): add results for query i0..i1 and j0..j1

inline ~RangeSearchBlockResultHandler()

inline virtual void add_results(size_t, size_t, const typename C::T*)

inline virtual void end_multiple()

inline bool is_in_selection(idx_t i) const

Public Members

RangeSearchResult *res

T radius

std::vector<RangeSearchPartialResult*> partial_results

std::vector<size_t> j0s

int pr = 0

size_t nq

const IDSelector *sel

size_t i0

size_t i1

struct SingleResultHandler : public faiss::ResultHandler<C>

Public Functions

inline explicit SingleResultHandler(RangeSearchBlockResultHandler &rh)

inline void begin(size_t i): begin results for query # i

inline virtual bool add_result(T dis, TI idx) final: add one result for query i

inline void end(): series of results for query i is done

inline ~SingleResultHandler()

Public Members

RangeSearchPartialResult pres

RangeQueryResult *qr = nullptr

C::T threshold = C::neutral()