文件 IndexBinary.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
定义了一些将转换应用于一组向量的对象 通常这些是预处理步骤。
-
struct IndexBinary
- #include <IndexBinary.h>
二进制索引的抽象结构。
支持添加顶点和搜索它们。
所有查询都是对称的，因为代码和向量之间没有区别。
被 faiss::IndexBinaryFlat、faiss::IndexBinaryFromFloat、faiss::IndexBinaryHNSW、faiss::IndexBinaryHash、faiss::IndexBinaryIVF、faiss::IndexBinaryMultiHash、faiss::gpu::GpuIndexBinaryFlat 继承
公共函数
-
explicit IndexBinary(idx_t d = 0, MetricType metric = METRIC_L2)
-
virtual ~IndexBinary()
-
virtual void train(idx_t n, const uint8_t *x)
在具有代表性的向量集上执行训练。
- 参数:
n – 训练向量的数量
x – 训练向量，大小为 n * d / 8
-
virtual void add(idx_t n, const uint8_t *x) = 0
将维度为 d 的 n 个向量添加到索引。
向量隐式地分配了标签 ntotal .. ntotal + n - 1
- 参数:
x – 输入矩阵，大小为 n * d / 8
-
virtual void add_with_ids(idx_t n, const uint8_t *x, const idx_t *xids)
与 add 相同，但存储 xids 而不是顺序 id。
默认实现断言失败，因为并非所有索引都支持它。
- 参数:
xids – 如果非空，则为要为向量存储的 ID（大小为 n）
-
virtual void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params = nullptr) const = 0
将维度为 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
将维度为 d 的 n 个向量查询到索引。
返回所有距离 < radius 的向量。 请注意，许多索引未实现 range_search（只有 k-NN 搜索是强制性的）。 距离转换为浮点数以重用 RangeSearchResult 结构，但它们是整数。 按照惯例，仅返回距离 < radius（严格比较）的距离，即。 radius = 0 不返回任何结果，1 仅返回完全相同的向量。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
radius – 搜索半径
result – 结果表
-
void assign(idx_t n, const uint8_t *x, idx_t *labels, idx_t k = 1) const
返回与查询 x 最接近的 k 个向量的索引。
此函数与搜索相同，但仅返回邻居的标签。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
labels – NN 的输出标签，大小为 n*k
-
virtual void reset() = 0
从数据库中删除所有元素。
-
virtual size_t remove_ids(const IDSelector &sel)
从索引中移除 ID。并非所有索引都支持。
-
virtual void reconstruct(idx_t key, uint8_t *recons) const
重构存储的向量。
对于某些索引，可能未定义此函数。
- 参数:
key – 要重构的向量的 ID
recons – 重构的向量（大小为 d / 8）
-
virtual void reconstruct_n(idx_t i0, idx_t ni, uint8_t *recons) const
重构向量 i0 到 i0 + ni - 1。
对于某些索引，可能未定义此函数。
- 参数:
recons – 重构的向量（大小为 ni * d / 8）
-
virtual void search_and_reconstruct(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params = nullptr) const
类似于 search，但也为搜索结果重构存储的向量（或者在有损编码的情况下进行近似）。
如果查询的结果不足，则结果数组会填充 -1。
- 参数:
recons – 重构的向量大小 (n, k, d)
-
void display() const
显示实际的类名和更多信息。
-
virtual void merge_from(IndexBinary &otherIndex, idx_t add_id = 0)
将条目从另一个数据集移动到 self。在输出时，other 为空。 add_id 被添加到所有移动的 id（对于连续 id，这将是 this->ntotal）
-
virtual void check_compatible_for_merge(const IndexBinary &otherIndex) const
检查两个索引是否兼容（即，它们以相同的方式进行训练并具有相同的参数）。否则抛出异常。
-
virtual size_t sa_code_size() const
生成的代码的大小，以字节为单位
-
virtual void add_sa_codes(idx_t n, const uint8_t *codes, const idx_t *xids)
与 IndexBinary 的 add_with_ids 相同。
-
explicit IndexBinary(idx_t d = 0, MetricType metric = METRIC_L2)
-
struct IndexBinary