文件 IndexBinaryFlat.h
-
namespace faiss
实现了多种变体的 k-means 聚类。
版权所有 (c) Facebook, Inc. 及其附属公司。
此源代码已根据 MIT 许可证获得许可，该许可证位于此源树的根目录中的 LICENSE 文件中。
IDSelector 旨在定义要处理的向量子集（用于删除或作为搜索的子集）
PQ4 SIMD 封装和累积函数
基本内核将 nq 个查询向量与 bbs = nb * 2 * 16 个向量累积，并为此生成一个输出矩阵。 对于 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 IndexBinaryFlat : public faiss::IndexBinary
- #include <IndexBinaryFlat.h>
Index，它存储完整的向量并执行穷举搜索。
公共函数
-
virtual void add(idx_t n, const uint8_t *x) override
向索引添加维度为 d 的 n 个向量。
向量会被隐式分配标签 ntotal .. ntotal + n - 1
- 参数:
x – 输入矩阵，大小为 n * d / 8
-
virtual void reset() override
从数据库中移除所有元素。
-
virtual void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
查询索引中维度为 d 的 n 个向量。
最多返回 k 个向量。 如果查询的结果不足，则结果数组会用 -1 填充。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
labels – NN 的输出标签，大小为 n*k
distances – 输出成对距离，大小为 n*k
-
virtual void range_search(idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override
查询索引中维度为 d 的 n 个向量。
返回所有距离 < radius 的向量。 请注意，许多索引未实现 range_search（仅 k-NN 搜索是强制性的）。 距离转换为 float 以重用 RangeSearchResult 结构，但它们是整数。 按照惯例，仅返回距离 < radius（严格比较）的距离，即 radius = 0 不返回任何结果，1 仅返回完全相同的向量。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
radius – 搜索半径
result – 结果表
-
virtual void reconstruct(idx_t key, uint8_t *recons) const override
重构存储的向量。
此函数可能未为某些索引定义。
- 参数:
key – 要重构的向量的 ID
recons – 重构的向量（大小为 d / 8）
-
virtual size_t remove_ids(const IDSelector &sel) override
移除一些 ID。 请注意，由于索引结构的原因，此操作的语义与通常的语义不同：新 ID 会发生偏移。
-
inline IndexBinaryFlat()
公共成员
-
bool use_heap = true
在扫描倒排列表时，选择使用堆还是计数来选择 k 个最小值。
-
size_t query_batch_size = 32
-
ApproxTopK_mode_t approx_topk_mode = ApproxTopK_mode_t::EXACT_TOPK
-
virtual void add(idx_t n, const uint8_t *x) override
-
struct IndexBinaryFlat : public faiss::IndexBinary