结构体 faiss::IndexRefine

struct IndexRefine : public faiss::Index

Index 在一个 base_index (一个快速的索引) 中查询，并使用精确搜索来优化结果，希望能够改善结果。

被 faiss::IndexRefineFlat 继承

公共类型

using component_t = float
using distance_t = float

公共函数

IndexRefine(Index *base_index, Index *refine_index)

从空索引初始化

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

在一组具有代表性的向量上执行训练

参数:

  • n – 训练向量的数量

  • x – 训练向量，大小为 n * d

virtual void add(idx_t n, const float *x) override

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

向量被隐式地分配标签 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

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

最多返回 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 size_t sa_code_size() const override

生成的代码的大小（以字节为单位）

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

sa_decode 从 index_refine 解码，假定 index_refine 更准确

~IndexRefine() override
virtual void add_with_ids(idx_t n, const float *x, const idx_t *xids)

与 add 相同，但存储 xids 而不是连续的 IDs。

默认实现会断言失败，因为它并非所有索引都支持。

参数:

  • n – 向量的数量

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

  • xids – 如果非空，则为要为向量存储的 IDs（大小为 n）

virtual void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const

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

返回距离 < radius 的所有向量。请注意，许多索引未实现 range_search（只有 k-NN 搜索是强制性的）。

参数:

  • n – 向量的数量

  • x – 要搜索的输入向量，大小为 n * d

  • radius – 搜索半径

  • result – 结果表

virtual void assign(idx_t n, const float *x, idx_t *labels, idx_t k = 1) const

返回与查询 x 最接近的 k 个向量的索引。

此函数与搜索相同，但仅返回邻居的标签。

参数:

  • n – 向量的数量

  • x – 要搜索的输入向量，大小为 n * d

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

  • k – 最近邻的数量

virtual size_t remove_ids(const IDSelector &sel)

从索引中移除 ID。并非所有索引都支持。 返回移除的元素数量。

virtual void reconstruct_batch(idx_t n, const idx_t *keys, float *recons) const

重构多个存储的向量（如果是有损编码，则为近似值）

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

参数:

  • n – 要重构的向量数

  • keys – 要重构的向量的 ID（大小为 n）

  • recons – 重构的向量（大小为 n * d）

virtual void reconstruct_n(idx_t i0, idx_t ni, float *recons) const

重构向量 i0 到 i0 + ni - 1

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

参数:

  • i0 – 序列中第一个向量的索引

  • ni – 序列中向量的数量

  • recons – 重构的向量（大小为 ni * d）

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

类似于搜索，但也重建存储的向量（或者在有损编码的情况下进行近似），以用于搜索结果。

如果查询结果不足，则结果数组将用 -1 填充。

参数:

  • n – 向量的数量

  • x – 要搜索的输入向量，大小为 n * d

  • k – 提取的向量数

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

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

  • recons – 重建的向量大小 (n, k, d)

virtual void compute_residual(const float *x, float *residual, idx_t key) const

计算索引编码后的残差向量。

残差向量是向量与其表示形式在索引中解码后可以重建的向量之间的差。残差可用于多阶段索引方法，如 IndexIVF 的方法。

参数:

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

  • residual – 输出残差向量，大小为 d

  • key – 编码的索引，由搜索和分配返回

virtual void compute_residual_n(idx_t n, const float *xs, float *residuals, const idx_t *keys) const

计算索引编码后的残差向量（批量形式）。 等价于为每个向量调用 compute_residual。

残差向量是向量与其表示形式在索引中解码后可以重建的向量之间的差。残差可用于多阶段索引方法，如 IndexIVF 的方法。

参数:

  • n – 向量的数量

  • xs – 输入向量，大小 (n x d)

  • residuals – 输出残差向量，大小 (n x d)

  • keys – 编码的索引，由搜索和分配返回

virtual DistanceComputer *get_distance_computer() const

获取此索引类型的 DistanceComputer（在 AuxIndexStructures 中定义）对象。

DistanceComputer 针对支持随机访问其向量的索引实现。

virtual void merge_from(Index &otherIndex, idx_t add_id = 0)

将条目从另一个数据集移动到自身。在输出时，other 为空。 add_id 被添加到所有移动的 id (对于顺序 id，这将是 this->ntotal)

virtual void check_compatible_for_merge(const Index &otherIndex) const

检查两个索引是否兼容（即，它们以相同的方式训练并且具有相同的参数）。 否则抛出异常。

virtual void add_sa_codes(idx_t n, const uint8_t *codes, const idx_t *xids)

添加使用独立编解码器计算的向量

参数:

  • codes – 要添加的代码，大小为 n * sa_code_size()

  • xids – 对应的 id，大小为 n

公共成员

Index *base_index

更快的索引，用于预先选择应过滤的向量

Index *refine_index

细化索引

bool own_fields

是否应该释放基本索引？

bool own_refine_index

与细化索引相同

float k_factor = 1

搜索中请求的 k 和从 base_index 请求的 k 之间的因子（应 >= 1）

int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细级别

bool is_trained

设置该值，如果 Index 不需要训练，或者已经完成训练

MetricType metric_type

此索引用于搜索的度量类型

float metric_arg

度量类型的参数