结构体 faiss::IndexRowwiseMinMaxBase

struct IndexRowwiseMinMaxBase : public faiss::Index

为行式归一化索引提供基本功能。

Index 包装器，执行行式归一化到 [0,1]，保留系数。 这是一个仅用于向量编解码器的索引。

基本上，此索引在调用 subindex::train() 和 subindex::sa_encode() 之前，对输入数据集中的每一行执行行式缩放到 [0,1]。 sa_encode() 调用将缩放系数（scaler 和 minv）存储在每个输出代码的最开始。 格式：[scaler][minv][subindex::sa_encode() 输出] sa_decode() 中的解缩放使用： output_rescaled = scaler * output + minv

提供了一个额外的 ::train_inplace() 函数，以便在调用 subindex::train() 之前进行就地缩放，从而避免克隆输入数据集，但由于缩放和缩放回操作而修改输入数据集。 用户可以调用此函数代替 ::train()

派生类为缩放系数提供不同的数据类型。 目前，有具有 fp16 和 fp32 缩放系数的版本。

  • fp16 版本为每个编码向量添加 4 个额外字节

  • fp32 版本为每个编码向量添加 8 个额外字节

被 faiss::IndexRowwiseMinMax, faiss::IndexRowwiseMinMaxFP16 继承

公共类型

using component_t = float
using distance_t = float

公共函数

explicit IndexRowwiseMinMaxBase(Index *index)
IndexRowwiseMinMaxBase()
~IndexRowwiseMinMaxBase() override
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 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 reset() override

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

virtual void train_inplace(idx_t n, float *x) = 0
virtual void train(idx_t n, const float *x)

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

参数:

  • n – 训练向量的数量

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

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

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

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

参数:

  • n – 向量的数量

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

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

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

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

返回所有距离小于半径的向量。 请注意，许多索引未实现 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 个向量的索引。

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

参数:

  • n – 向量的数量

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

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

  • k – 最近邻的数量

virtual size_t remove_ids(const IDSelector &sel)

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

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

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

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

参数:

  • key – 要重建的向量的 id

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

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

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

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

参数:

  • n – 向量的数量

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

  • k – 提取的向量数

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

  • labels – 输出的 NN 的标签，大小为 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 size_t sa_code_size() const

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

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

编码一组向量

参数:

  • n – 向量的数量

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

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

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

解码一组向量

参数:

  • n – 向量的数量

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

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

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

将条目从另一个数据集移动到 self。在输出时，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 *index

子索引

bool own_fields

是否需要在析构函数中释放子索引。

int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细级别

bool is_trained

如果Index不需要训练，或者已经完成训练，则设置此项

MetricType metric_type

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

float metric_arg

度量类型的参数