文件 IndexFlatCodes.h
-
namespace faiss
实现具有多种变体的 k-means 聚类。
版权所有 (c) Facebook, Inc. 及其附属公司。
此源代码已获得 MIT 许可，请参阅此源代码树根目录中的 LICENSE 文件。
IDSelector 旨在定义要处理的向量子集（用于删除或作为搜索子集）
PQ4 SIMD 打包和累加函数
基本内核将 nq 个查询向量与 bbs = nb * 2 * 16 个向量累加，并为此生成一个输出矩阵。 对于 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 IndexFlatCodes : public faiss::Index
- #include <IndexFlatCodes.h>
Index 将所有向量编码为固定大小代码（大小 code_size）。 存储在 codes 向量中
被 faiss::Index2Layer, faiss::IndexAdditiveQuantizer, faiss::IndexFlat, faiss::IndexLSH, faiss::IndexLattice, faiss::IndexNeuralNetCodec, faiss::IndexPQ, faiss::IndexScalarQuantizer 继承
公共函数
-
IndexFlatCodes()
-
IndexFlatCodes(size_t code_size, idx_t d, MetricType metric = METRIC_L2)
-
virtual void reset() override
从数据库中移除所有元素。
-
virtual void reconstruct_n(idx_t i0, idx_t ni, float *recons) const override
重建向量 i0 到 i0 + ni - 1
对于一些索引，此函数可能未定义
- 参数:
i0 – 序列中第一个向量的索引
ni – 序列中向量的数量
recons – 重建的向量（大小为 ni * d）
-
virtual void reconstruct(idx_t key, float *recons) const override
重建存储的向量（如果是有损编码，则为近似值）
对于一些索引，此函数可能未定义
- 参数:
key – 要重建的向量的 ID
recons – 重建的向量（大小为 d）
-
virtual size_t sa_code_size() const override
生成的代码的大小（以字节为单位）
-
virtual size_t remove_ids(const IDSelector &sel) override
移除一些 ID。请注意，由于索引的结构，此操作的语义与通常的语义不同：新的 ID 会发生偏移
-
virtual FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const
FlatCodesDistanceComputer 提供 distance_to_code 方法
默认实现使用 sa_decode 显式解码向量。
-
inline virtual DistanceComputer *get_distance_computer() const override
获取用于此类索引的 DistanceComputer（在 AuxIndexStructures 中定义）对象。
DistanceComputer 针对支持随机访问其向量的索引实现。
-
virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
通过解码实现的搜索
-
virtual void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override
查询维度为 d 的 n 个向量到索引。
返回距离 < radius 的所有向量。 请注意，许多索引不实现 range_search（只有 k-NN 搜索是强制性的）。
- 参数:
n – 向量的数量
x – 要搜索的输入向量，大小为 n * d
radius – 搜索半径
result – 结果表
-
CodePacker *get_CodePacker() const
-
virtual void check_compatible_for_merge(const Index &otherIndex) const override
检查两个索引是否兼容（即，它们以相同的方式训练并且具有相同的参数）。否则抛出异常。
-
virtual void merge_from(Index &otherIndex, idx_t add_id = 0) override
将条目从另一个数据集移动到自身。在输出时，other 为空。add_id 被添加到所有移动的 id 中（对于顺序 id，这将是 this->ntotal）
-
virtual void add_sa_codes(idx_t n, const uint8_t *x, const idx_t *xids) override
添加使用独立编解码器计算的向量
- 参数:
codes – 要添加的代码，大小为 n * sa_code_size()
xids – 相应的 id，大小为 n
-
IndexFlatCodes()
-
struct IndexFlatCodes : public faiss::Index