文件 DistanceComputer.h

namespace faiss

实现具有多种变体的 k-means 聚类。

此源代码根据 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 DistanceComputer

由 faiss::FlatCodesDistanceComputer, faiss::NegativeDistanceComputer 继承

公共函数

virtual void set_query(const float *x) = 0: 在计算距离之前调用。指针 x 在调用运算符 () 时应保持有效

virtual float operator()(idx_t i) = 0: 计算向量 i 到当前查询向量的距离

inline virtual void distances_batch_4(const idx_t idx0, const idx_t idx1, const idx_t idx2, const idx_t idx3, float &dis0, float &dis1, float &dis2, float &dis3): 计算当前查询向量到 4 个存储向量的距离。某些 DistanceComputer 实现可能由此获益良多。

virtual float symmetric_dis(idx_t i, idx_t j) = 0: 计算两个存储向量之间的距离

inline virtual ~DistanceComputer()

struct NegativeDistanceComputer : public faiss::DistanceComputer 

公共函数

inline explicit NegativeDistanceComputer(DistanceComputer *basedis)

inline virtual void set_query(const float *x) override: 在计算距离之前调用。指针 x 在调用运算符 () 时应保持有效

inline virtual float operator()(idx_t i) override: 计算向量 i 到当前查询向量的距离

inline virtual void distances_batch_4(const idx_t idx0, const idx_t idx1, const idx_t idx2, const idx_t idx3, float &dis0, float &dis1, float &dis2, float &dis3) override: 计算当前查询向量到 4 个存储向量的距离。某些 DistanceComputer 实现可能由此获益良多。

inline virtual float symmetric_dis(idx_t i, idx_t j) override: 计算两个存储向量之间的距离

inline virtual ~NegativeDistanceComputer()

公共成员

DistanceComputer *basedis: 由此对象拥有

struct FlatCodesDistanceComputer : public faiss::DistanceComputer 

被 faiss::ScalarQuantizer::SQDistanceComputer 继承

公共函数

inline FlatCodesDistanceComputer(const uint8_t *codes, size_t code_size)

inline FlatCodesDistanceComputer()

inline virtual float operator()(idx_t i) override: 计算向量 i 到当前查询向量的距离

virtual float distance_to_code(const uint8_t *code) = 0: 计算当前查询向量到一个编码向量的距离

inline virtual ~FlatCodesDistanceComputer()

virtual void set_query(const float *x) = 0: 在计算距离之前调用。指针 x 在调用运算符 () 时应保持有效

inline virtual void distances_batch_4(const idx_t idx0, const idx_t idx1, const idx_t idx2, const idx_t idx3, float &dis0, float &dis1, float &dis2, float &dis3): 计算当前查询向量到 4 个存储向量的距离。某些 DistanceComputer 实现可能由此获益良多。

virtual float symmetric_dis(idx_t i, idx_t j) = 0: 计算两个存储向量之间的距离

公共成员

const uint8_t *codes

size_t code_size