文件 IndexFastScan.h
-
namespace faiss
实现了具有多种变体的 k-means 聚类。
版权所有 (c) Facebook, Inc. 及其附属公司。
此源代码根据 MIT 许可证授权，该许可证位于此源树的根目录中的 LICENSE 文件中。
IDSelector 旨在定义要处理的向量子集（用于删除或作为搜索子集）
PQ4 SIMD 打包和累加函数
基本内核使用 bbs = nb * 2 * 16 向量累加 nq 查询向量，并生成一个输出矩阵。它对于 nq * nb <= 4 很有用，否则寄存器溢出变得太大。
这些函数的实现分布在 3 个 cpp 文件中，以减少并行编译时间。 模板被显式实例化。
此文件包含用于计算距离的内核的回调。
在整个库中，向量以 float * 指针的形式提供。 当在一批中一起处理（添加/搜索）多个向量时，大多数算法都可以得到优化。 在这种情况下，它们作为矩阵传递。 当大小为 d 的 n 个向量以 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
定义了一些对向量集应用转换的对象 通常这些是预处理步骤。
变量
- FAISS_API FastScanStats FastScan_stats
-
struct IndexFastScan : public faiss::Index
- #include <IndexFastScan.h>
IndexPQ 和 IndexAQ 的快速扫描版本。 目前适用于 4 位 PQ 和 AQ。
代码不是顺序存储的，而是分组为大小为 bbs 的块。 这使得可以使用 SIMD 指令快速计算距离。 尾随代码（为完成最后一个代码而添加的填充代码）是垃圾。
实现：12：阻塞循环，在 Q 上具有内部循环 qbs 13：相同，具有用于存储结果的储层累加器 14：没有带有堆累加器的 qbs 15：没有带有储层累加器的 qbs
被以下类继承：faiss::IndexAdditiveQuantizerFastScan, faiss::IndexPQFastScan
公共函数
-
void init_fastscan(int d, size_t M, size_t nbits, MetricType metric, int bbs)
-
IndexFastScan()
-
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 add(idx_t n, const float *x) override
向索引添加维度为 d 的 n 个向量。
向量被隐式地分配标签 ntotal .. ntotal + n - 1。此函数将输入向量切分成小于 blocksize_add 的块，并调用 add_core。
- 参数:
n – 向量的数量
x – 输入矩阵，大小为 n * d
-
template<bool is_max>
void search_dispatch_implem(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const
-
template<class Cfloat>
void search_implem_234(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const
-
template<class C>
void search_implem_12(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const
-
template<class C>
void search_implem_14(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const
-
virtual void reconstruct(idx_t key, float *recons) const override
重建一个存储的向量 (如果是有损编码，则重建一个近似向量)
对于某些索引，此函数可能未定义
- 参数:
key – 要重建的向量的ID
recons – 重建的向量 (大小为 d)
-
virtual size_t remove_ids(const IDSelector &sel) override
从索引中删除ID。并非所有索引都支持。返回已删除的元素数量。
-
CodePacker *get_CodePacker() const
-
void init_fastscan(int d, size_t M, size_t nbits, MetricType metric, int bbs)
-
struct FastScanStats