文件 IndexRefine.h
-
namespace faiss
实现具有许多变体的 k-means 聚类。
版权所有 (c) Facebook, Inc. 及其附属公司。
此源代码根据 MIT 许可获得许可，该许可位于此源树的根目录中的 LICENSE 文件中。
IDSelector 旨在定义要处理的向量子集（用于删除或作为搜索的子集）
PQ4 SIMD 打包和累积函数
基本内核使用 bbs = nb * 2 * 16 向量累积 nq 查询向量，并生成该向量的输出矩阵。 它对于 nq * nb <= 4 很有用，否则寄存器溢出将变得太大。
这些函数的实现分布在 3 个 cpp 文件中，以减少并行编译时间。 模板被显式实例化。
此文件包含用于计算距离的内核的回调。
在整个库中，向量以 float * 指针的形式提供。 当多个向量一起分批处理（添加/搜索）时，大多数算法可以得到优化。 在这种情况下，它们作为矩阵传入。 当 n 个大小为 d 的向量作为 float * x 提供时，向量 i 的分量 j 为
x[ i * d + j ]
其中 0 <= i < n 且 0 <= j < d。 换句话说，矩阵始终是紧凑的。 指定矩阵的大小时，我们称其为 n*d 矩阵，这意味着行优先存储。
I/O 函数可以读取/写入到文件名、文件句柄或抽象介质的对象。
读取函数返回应使用 delete 释放的对象。 这些对象中的所有引用都归该对象所有。
倒排列表的定义 + 一些实现该接口的常见类。
由于 IVF（倒排文件）索引对于大规模用例非常有用，因此我们将与它们相关的一些函数分组到这个小型库中。 大多数函数都可以在 IndexIVF 和嵌入在 IndexPreTransform 中的 IndexIVF 上工作。
在此文件中，实现了 L2 和内积之外的额外度量
实现了一些神经网络层，主要用于支持 QINCo
定义了一些将转换应用于向量集的对象，这些通常是预处理步骤。
-
struct IndexRefineSearchParameters : public faiss::SearchParameters
公共函数
-
virtual ~IndexRefineSearchParameters() = default
-
virtual ~IndexRefineSearchParameters() = default
-
struct IndexRefine : public faiss::Index
- #include <IndexRefine.h>
索引，它在 base_index (一个快速索引) 中查询，并使用精确搜索来优化结果，希望能够改进结果。
公共函数
-
IndexRefine()
-
virtual void train(idx_t n, const float *x) override
对有代表性的向量集执行训练
- 参数：
n – 训练向量的数量
x – 训练向量，大小为 n * d
-
virtual void add(idx_t n, const float *x) override
将维度为 d 的 n 个向量添加到索引。
向量隐式分配标签 ntotal .. ntotal + n - 1。此函数将输入向量切分为小于 blocksize_add 的块，并调用 add_core。
- 参数：
n – 向量的数量
x – 输入矩阵，大小为 n * d
-
virtual void reset() override
从数据库中删除所有元素。
-
virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
向索引查询维度为 d 的 n 个向量。
最多返回 k 个向量。 如果查询结果不足，则结果数组将填充 -1。
- 参数：
n – 向量的数量
x – 要搜索的输入向量，大小为 n * d
k – 提取的向量数
distances – 输出成对距离，大小为 n*k
labels – 输出 NN 的标签，大小为 n*k
-
virtual void reconstruct(idx_t key, float *recons) const override
重建存储的向量 (如果是有损编码，则是近似值)
此函数可能未为某些索引定义
- 参数：
key – 要重建的向量的 ID
recons – 重建的向量 (大小为 d)
-
virtual size_t sa_code_size() const override
生成的代码的大小 (以字节为单位)
-
virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override
编码一组向量
- 参数：
n – 向量的数量
x – 输入向量，大小为 n * d
bytes – 输出编码的向量，大小为 n * sa_code_size()
-
virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override
sa_decode 从 index_refine 解码，假设它更准确
-
~IndexRefine() override
-
IndexRefine()
-
struct IndexRefineFlat : public faiss::IndexRefine
- #include <IndexRefine.h>
精炼索引是 IndexFlat 的版本。 它有一个额外的构造函数，它接受一个要添加到 flat 精炼索引的元素表。
公共函数
-
IndexRefineFlat()
-
virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
向索引查询维度为 d 的 n 个向量。
最多返回 k 个向量。 如果查询结果不足，则结果数组将填充 -1。
- 参数：
n – 向量的数量
x – 要搜索的输入向量，大小为 n * d
k – 提取的向量数
distances – 输出成对距离，大小为 n*k
labels – 输出 NN 的标签，大小为 n*k
-
virtual void train(idx_t n, const float *x) override
对有代表性的向量集执行训练
- 参数：
n – 训练向量的数量
x – 训练向量，大小为 n * d
-
virtual void add(idx_t n, const float *x) override
将维度为 d 的 n 个向量添加到索引。
向量隐式分配标签 ntotal .. ntotal + n - 1。此函数将输入向量切分为小于 blocksize_add 的块，并调用 add_core。
- 参数：
n – 向量的数量
x – 输入矩阵，大小为 n * d
-
virtual void reset() override
从数据库中删除所有元素。
-
virtual void reconstruct(idx_t key, float *recons) const override
重建存储的向量 (如果是有损编码，则是近似值)
此函数可能未为某些索引定义
- 参数：
key – 要重建的向量的 ID
recons – 重建的向量 (大小为 d)
-
virtual size_t sa_code_size() const override
生成的代码的大小 (以字节为单位)
-
virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override
编码一组向量
- 参数：
n – 向量的数量
x – 输入向量，大小为 n * d
bytes – 输出编码的向量，大小为 n * sa_code_size()
-
IndexRefineFlat()
-
struct IndexRefineSearchParameters : public faiss::SearchParameters