文件 IndexBinaryHash.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
定义一些对一组向量应用变换的对象。通常，这些是预处理步骤。
变量
- FAISS_API IndexBinaryHashStats indexBinaryHash_stats
-
struct IndexBinaryHash : public faiss::IndexBinary
- #include <IndexBinaryHash.h>
仅使用 b 个前导位作为哈希值
公共类型
-
using InvertedListMap = std::unordered_map<idx_t, InvertedList>
公共函数
-
IndexBinaryHash(int d, int b)
-
IndexBinaryHash()
-
virtual void reset() override
从数据库中移除所有元素。
-
virtual void add(idx_t n, const uint8_t *x) override
将 n 个维度为 d 的向量添加到索引。
向量被隐式地分配标签 ntotal .. ntotal + n - 1
- 参数：
x – 输入矩阵，大小为 n * d / 8
-
virtual void add_with_ids(idx_t n, const uint8_t *x, const idx_t *xids) override
与 add 相同，但存储 xids 而不是顺序 ids。
默认实现会断言失败，因为它并非所有索引都支持。
- 参数：
xids – 如果非空，则为要存储的向量的 ids（大小为 n）
-
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 搜索是强制性的）。 距离被转换为浮点数以重用 RangeSearchResult 结构，但它们是整数。 按照惯例，只返回距离 < radius（严格比较）的距离，即radius = 0 不返回任何结果，1 只返回完全相同的向量。
- 参数：
x – 要搜索的输入向量，大小为 n * d / 8
radius – 搜索半径
result – 结果表
-
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 – NNs 的输出标签，大小为 n*k
distances – 输出成对距离，大小为 n*k
-
void display() const
-
size_t hashtable_size() const
-
struct InvertedList
-
using InvertedListMap = std::unordered_map<idx_t, InvertedList>
-
struct IndexBinaryHashStats
-
struct IndexBinaryMultiHash : public faiss::IndexBinary
- #include <IndexBinaryHash.h>
仅使用 b 个前导位作为哈希值
公共函数
-
IndexBinaryMultiHash(int d, int nhash, int b)
-
IndexBinaryMultiHash()
-
~IndexBinaryMultiHash()
-
virtual void reset() override
从数据库中移除所有元素。
-
virtual void add(idx_t n, const uint8_t *x) override
将 n 个维度为 d 的向量添加到索引。
向量被隐式地分配标签 ntotal .. ntotal + n - 1
- 参数：
x – 输入矩阵，大小为 n * d / 8
-
范围搜索函数：在指定半径内搜索向量。
查询索引中维度为 d 的 n 个向量。
返回所有距离 < radius 的向量。 请注意，许多索引未实现 range_search（只有 k-NN 搜索是强制性的）。 距离被转换为浮点数以重用 RangeSearchResult 结构，但它们是整数。 按照惯例，只返回距离 < radius（严格比较）的距离，即radius = 0 不返回任何结果，1 只返回完全相同的向量。
- 参数：
x – 要搜索的输入向量，大小为 n * d / 8
radius – 搜索半径
result – 结果表
-
搜索函数：搜索最近邻向量。
查询索引中维度为 d 的 n 个向量。
最多返回 k 个向量。 如果查询的结果不足，则结果数组会用 -1 填充。
- 参数：
x – 要搜索的输入向量，大小为 n * d / 8
labels – NNs 的输出标签，大小为 n*k
distances – 输出成对距离，大小为 n*k
-
哈希表大小函数：返回哈希表的大小。
-
IndexBinaryMultiHash(int d, int nhash, int b)