文件 IndexFlat.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 IndexFlat : public faiss::IndexFlatCodes

#include <IndexFlat.h>

存储完整向量并执行穷举搜索的 Index

由 faiss::IndexFlatIP、faiss::IndexFlatL2 继承

公共函数

explicit IndexFlat(idx_t d, MetricType metric = METRIC_L2)

参数:

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 – NN 的输出标签，大小为 n*k

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 – 结果表

virtual void reconstruct(idx_t key, float *recons) const override

重建存储的向量（如果是有损编码，则重建近似向量）

此函数可能未针对某些索引定义

参数:

• key – 要重建的向量的 ID

• recons – 重建的向量（大小为 d）

void compute_distance_subset(idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const

计算与向量子集的距离

参数:

• x – 查询向量，大小为 n * d

• labels – 应该为每个查询向量比较的向量的索引，大小为 n * k

• distances – 相应的输出距离，大小为 n * k

inline float *get_xb()

inline const float *get_xb() const

inline IndexFlat()

virtual FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const override

FlatCodesDistanceComputer 提供 distance_to_code 方法

默认实现使用 sa_decode 显式解码向量。

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量

参数:

• n – 向量的数量

• x – 输入向量，大小为 n * d

• bytes – 输出编码向量，大小为 n * sa_code_size()

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override

解码一组向量

参数:

• n – 向量的数量

• bytes – 输入编码向量，大小为 n * sa_code_size()

• x – 输出向量，大小为 n * d

struct IndexFlatIP : public faiss::IndexFlat

公共函数

inline explicit IndexFlatIP(idx_t d)

inline IndexFlatIP()

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 – NN 的输出标签，大小为 n*k

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 – 结果表

virtual void reconstruct(idx_t key, float *recons) const override

重建存储的向量（如果是有损编码，则重建近似向量）

此函数可能未针对某些索引定义

参数:

• key – 要重建的向量的 ID

• recons – 重建的向量（大小为 d）

void compute_distance_subset(idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const

计算与向量子集的距离

参数:

• x – 查询向量，大小为 n * d

• labels – 应该为每个查询向量比较的向量的索引，大小为 n * k

• distances – 相应的输出距离，大小为 n * k

inline float *get_xb()

inline const float *get_xb() const

virtual FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const override

FlatCodesDistanceComputer 提供 distance_to_code 方法

默认实现使用 sa_decode 显式解码向量。

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量

参数:

• n – 向量的数量

• x – 输入向量，大小为 n * d

• bytes – 输出编码向量，大小为 n * sa_code_size()

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override

解码一组向量

参数:

• n – 向量的数量

• bytes – 输入编码向量，大小为 n * sa_code_size()

• x – 输出向量，大小为 n * d

struct IndexFlatL2 : public faiss::IndexFlat

子类：faiss::IndexFlat1D

公共函数

IndexFlatL2 构造函数，接受维度 d 作为参数。

参数:

d – 输入向量的维度

IndexFlatL2 默认构造函数。

获取用于计算平面代码距离的 FlatCodesDistanceComputer 对象。这是虚函数，并且重写了基类中的实现。

FlatCodesDistanceComputer 提供 distance_to_code 方法

默认实现使用 sa_decode 显式解码向量。

同步L2范数。

清除L2范数。

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 – NN 的输出标签，大小为 n*k

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 – 结果表

virtual void reconstruct(idx_t key, float *recons) const override

重建存储的向量（如果是有损编码，则重建近似向量）

此函数可能未针对某些索引定义

参数:

• key – 要重建的向量的 ID

• recons – 重建的向量（大小为 d）

void compute_distance_subset(idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const

计算与向量子集的距离

参数:

• x – 查询向量，大小为 n * d

• labels – 应该为每个查询向量比较的向量的索引，大小为 n * k

• distances – 相应的输出距离，大小为 n * k

返回内部向量数据指针（非常量版本）。

返回内部向量数据指针（常量版本）。

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量

参数:

• n – 向量的数量

• x – 输入向量，大小为 n * d

• bytes – 输出编码向量，大小为 n * sa_code_size()

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override

解码一组向量

参数:

• n – 向量的数量

• bytes – 输入编码向量，大小为 n * sa_code_size()

• x – 输出向量，大小为 n * d

公共成员

缓存的L2范数，类型为 std::vector<float>。

struct IndexFlat1D : public faiss::IndexFlatL2

#include <IndexFlat.h>

针对1D“向量”的优化版本。

公共函数

explicit IndexFlat1D(bool continuous_update = true)

void update_permutation()

如果不是 continuous_update，请在最后一次添加和第一次搜索之间调用此函数

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 reset() override

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

virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override

警告：返回的距离是 L1，而不是 L2。

virtual FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const override

FlatCodesDistanceComputer 提供 distance_to_code 方法

默认实现使用 sa_decode 显式解码向量。

void sync_l2norms()

void clear_l2norms()

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 – 结果表

virtual void reconstruct(idx_t key, float *recons) const override

重建存储的向量（如果是有损编码，则重建近似向量）

此函数可能未针对某些索引定义

参数:

• key – 要重建的向量的 ID

• recons – 重建的向量（大小为 d）

void compute_distance_subset(idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const

计算与向量子集的距离

参数:

• x – 查询向量，大小为 n * d

• labels – 应该为每个查询向量比较的向量的索引，大小为 n * k

• distances – 相应的输出距离，大小为 n * k

inline float *get_xb()

inline const float *get_xb() const

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量

参数:

• n – 向量的数量

• x – 输入向量，大小为 n * d

• bytes – 输出编码向量，大小为 n * sa_code_size()

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override

解码一组向量

参数:

• n – 向量的数量

• bytes – 输入编码向量，大小为 n * sa_code_size()

• x – 输出向量，大小为 n * d

公共成员

bool continuous_update = true

是否持续更新排列？

std::vector<idx_t> perm

排序后的数据库索引

std::vector<float> cached_l2norms