结构体 faiss::MultiIndexQuantizer

struct MultiIndexQuantizer : public faiss::Index

量化器 (Quantizer)，其中质心是虚拟的：它们是子质心的笛卡尔积。

被 faiss::MultiIndexQuantizer2 继承

公共类型

using component_t = float
using distance_t = float

公共函数

MultiIndexQuantizer(int d, size_t M, size_t nbits)

每个子向量索引的位数

参数:

  • d – 输入向量的维度

  • M – 子量化器的数量

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

对有代表性的向量集合执行训练

参数:

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

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

在运行时添加和重置将会崩溃

virtual void reset() override

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

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

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

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

参数:

  • key – 要重建的向量的 ID

  • recons – 重建的向量（大小为 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 个向量查询到索引中。

返回所有距离 < 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 – 输出 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

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

如果查询的结果不足，则生成的数组将填充 -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 – 编码的索引，由 search 和 assign 返回

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 – 编码后的索引，由 search 和 assign 返回

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)

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

公共成员

ProductQuantizer pq
int d

向量维度

idx_t ntotal

已索引向量的总数

bool verbose

详细级别

bool is_trained

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

MetricType metric_type

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

float metric_arg

度量类型的参数