文件 IndexBinaryFromFloat.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 IndexBinaryFromFloat : public faiss::IndexBinary
#include <IndexBinaryFromFloat.h>

由 float Index 支持的 IndexBinary

支持添加顶点并搜索它们。

所有查询都是对称的,因为代码和向量之间没有区别。

公共函数

IndexBinaryFromFloat()
explicit IndexBinaryFromFloat(Index *index)
~IndexBinaryFromFloat()
virtual void add(idx_t n, const uint8_t *x) override

向索引添加 n 个维度为 d 的向量。

向量被隐式地分配标签 ntotal .. ntotal + n - 1

参数:

x – 输入矩阵,大小为 n * d / 8

virtual void reset() override

从数据库中删除所有元素。

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

查询索引中 n 个维度为 d 的向量。

最多返回 k 个向量。 如果查询没有足够的结果,结果数组将填充 -1。

参数:
  • x – 要搜索的输入向量,大小为 n * d / 8

  • labels – NNs 的输出标签,大小为 n*k

  • distances – 输出成对距离,大小为 n*k

virtual void train(idx_t n, const uint8_t *x) override

对代表性向量集执行训练。

参数:
  • n – 训练向量的数量

  • x – 训练向量,大小为 n * d / 8

公共成员

Index *index = nullptr
bool own_fields = false

对象是否拥有索引指针。