文件 MetaIndexes.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 IndexSplitVectors : public faiss::Index
- #include <MetaIndexes.h>
将输入向量分割成段，并将每个段分配给一个子索引，用于分发 MultiIndexQuantizer
公共函数
-
void sync_with_sub_indexes()
-
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 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 – 输出 NNs 的标签，大小为 n*k
-
virtual void train(idx_t n, const float *x) override
在一组有代表性的向量上执行训练
- 参数:
n – 训练向量的数量
x – 训练向量，大小为 n * d
-
virtual void reset() override
从数据库中移除所有元素。
-
~IndexSplitVectors() override
-
void sync_with_sub_indexes()
-
struct IndexRandom : public faiss::Index
- #include <MetaIndexes.h>
返回随机结果的索引。主要用于时间基准测试
公共函数
-
explicit IndexRandom(idx_t d, idx_t ntotal = 0, int64_t seed = 1234, MetricType mt = METRIC_L2)
-
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 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 – 输出 NNs 的标签，大小为 n*k
-
virtual void reconstruct(idx_t key, float *recons) const override
重构一个存储的向量 (如果是有损编码，则是近似值)
对于某些索引，此函数可能未定义
- 参数:
key – 要重构的向量的id
recons – 重构的向量 (大小 d)
-
virtual void reset() override
从数据库中移除所有元素。
-
~IndexRandom() override
公共成员
-
int64_t seed
-
explicit IndexRandom(idx_t d, idx_t ntotal = 0, int64_t seed = 1234, MetricType mt = METRIC_L2)
-
struct IndexSplitVectors : public faiss::Index