结构体 faiss::MultiIndexQuantizer2

struct MultiIndexQuantizer2 : public faiss::MultiIndexQuantizer

MultiIndexQuantizer，其中PQ分配由子索引执行

公共类型

using component_t = float
using distance_t = float

公共函数

MultiIndexQuantizer2(int d, size_t M, size_t nbits, Index **indexes)
MultiIndexQuantizer2(int d, size_t nbits, Index *assign_index_0, Index *assign_index_1)
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

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

最多返回k个向量。如果查询的结果不足，结果数组将用-1填充。

参数：

  • n – 向量的数量

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

  • k – 提取的向量的数量

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

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

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

add和reset会在运行时崩溃

virtual void reset() override

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

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

查询索引中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 – 输出的NN标签，大小为 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 – 输出的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 – 编码后的索引，由 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 – 编码后的索引，由搜索和分配返回

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

公共成员

std::vector<Index*> assign_indexes

在 d / M 维度上的 M 个索引。

bool own_fields
ProductQuantizer pq
int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细级别

bool is_trained

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

MetricType metric_type

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

float metric_arg

度量类型的参数