结构体 faiss::IndexIVFIndependentQuantizer

struct IndexIVFIndependentQuantizer : public faiss::Index

一个 IVF 索引，其量化器的输入维度与有效载荷大小不同。要编码的向量通过 VectorTransform 从输入向量获得。

公共类型

using component_t = float
using distance_t = float

公共函数

IndexIVFIndependentQuantizer(Index *quantizer, IndexIVF *index_ivf, VectorTransform *vt = nullptr)
inline IndexIVFIndependentQuantizer()
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 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 – NN 的输出标签，大小为 n*k

virtual void reset() override

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

~IndexIVFIndependentQuantizer() override
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

查询 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 个向量的索引。

此函数与 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

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

如果查询的结果不足，则结果数组将填充 -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 *quantizer = nullptr

量化器直接使用输入向量

VectorTransform *vt = nullptr

在应用 IVF 向量之前进行转换

IndexIVF *index_ivf = nullptr

IVF 索引，控制 nlist 和 nprobe

bool own_fields = false

*this 是否拥有这 3 个字段

int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细程度

bool is_trained

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

MetricType metric_type

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

float metric_arg

度量类型参数