File ResultHandler.h
-
namespace faiss
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.
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. 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)
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. 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.
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. 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.
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. 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.
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. Definition of inverted lists + a few common classes that implement the interface.
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. 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.
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. In this file are the implementations of extra metrics beyond L2 and inner product
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. Defines a few objects that apply transformations to a set of vectors Often these are pre-processing steps.
-
template<class C>
struct ResultHandler Subclassed by faiss::HeapBlockResultHandler< C >::SingleResultHandler, faiss::RangeSearchBlockResultHandler< C >::SingleResultHandler, faiss::ReservoirTopN< C >, faiss::Top1BlockResultHandler< C >::SingleResultHandler
Public Functions
-
inline virtual ~ResultHandler()
-
inline virtual ~ResultHandler()
-
template<class C>
struct BlockResultHandler Subclassed by faiss::HeapBlockResultHandler< C >, faiss::RangeSearchBlockResultHandler< C >, faiss::ReservoirBlockResultHandler< C >, faiss::Top1BlockResultHandler< C >
-
template<class C>
struct Top1BlockResultHandler : public faiss::BlockResultHandler<C> -
Public Functions
-
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 virtual void end_multiple()
-
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 void end()
series of results for query i is done
-
inline explicit SingleResultHandler(Top1BlockResultHandler &hr)
-
inline virtual void begin_multiple(size_t i0, size_t i1) final
-
template<class C>
struct HeapBlockResultHandler : public faiss::BlockResultHandler<C> -
Public Functions
-
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
-
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 void end()
series of results for query i is done
-
inline explicit SingleResultHandler(HeapBlockResultHandler &hr)
-
inline virtual void begin_multiple(size_t i0_2, size_t i1_2) final
-
template<class C>
struct ReservoirTopN : public faiss::ResultHandler<C> - #include <ResultHandler.h>
Reservoir for a single query.
Subclassed by faiss::ReservoirBlockResultHandler< C >::SingleResultHandler
-
template<class C>
struct ReservoirBlockResultHandler : public faiss::BlockResultHandler<C> -
Public Functions
-
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
Public Members
-
int64_t k
-
size_t capacity
-
std::vector<ReservoirTopN<C>> reservoirs
-
size_t nq
-
size_t i0 = 0
-
size_t i1 = 0
-
struct SingleResultHandler : public faiss::ReservoirTopN<C>
-
inline virtual void begin_multiple(size_t i0_2, size_t i1_2)
-
template<class C>
struct RangeSearchBlockResultHandler : public faiss::BlockResultHandler<C> -
Public Functions
-
inline RangeSearchBlockResultHandler(RangeSearchResult *res, float radius)
-
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 end_multiple()
Public Members
-
RangeSearchResult *res
-
std::vector<RangeSearchPartialResult*> partial_results
-
int pr = 0
-
size_t nq
-
size_t i0 = 0
-
size_t i1 = 0
-
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 void end()
series of results for query i is done
-
inline ~SingleResultHandler()
-
inline explicit SingleResultHandler(RangeSearchBlockResultHandler &rh)
-
inline RangeSearchBlockResultHandler(RangeSearchResult *res, float radius)
-
template<class C>