结构体 faiss::IndexIVFPQ

struct IndexIVFPQ : public faiss::IndexIVF

使用乘积量化器编码的倒排文件。每个残差向量都被编码为乘积量化器代码。

被 faiss::IndexIVFPQR 继承

公共类型

using component_t = float

using distance_t = float

公共函数

IndexIVFPQ(Index *量化器, size_t d, size_t nlist, size_t M, size_t nbits_per_idx, MetricType metric = METRIC_L2)

virtual void encode_vectors(idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos = false) const override

将一组向量编码为它们将出现在倒排列表中的形式

参数:

• list_nos – 量化器返回的倒排列表 ID（大小为 n）。 -1s 将被忽略。

• codes – 输出代码，大小为 n * code_size

• include_listno – 在代码中包含列表 ID（在这种情况下，将 ceil(log8(nlist)) 添加到代码大小）

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

解码一组向量

参数:

• n – 向量数量

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

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

virtual void add_core(idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context = nullptr) override

向量添加的实现，其中向量分配是预定义的。默认实现将代码提取交给 encode_vectors。

参数:

precomputed_idx – 输入向量的量化索引（大小为 n）

void add_core_o(idx_t n, const float *x, const idx_t *xids, float *residuals_2, const idx_t *precomputed_idx = nullptr, void *inverted_list_context = nullptr)

与 add_core 相同，也

• 如果 residuals_2 != NULL，则输出二级残差

• 接受 precomputed_idx = nullptr

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

训练乘积量化器

virtual idx_t train_encoder_num_vectors() const override

可以被子类重新定义，以指示它们需要多少训练向量

virtual void reconstruct_from_offset(int64_t list_no, int64_t offset, float *recons) const override

根据位置（倒排列表索引 + 倒排列表偏移量）而不是 ID 重建向量。

当不维护 direct_map 且倒排列表偏移量由 search_preassigned() 计算，并且设置了 store_pairs 时很有用。

size_t find_duplicates(idx_t *ids, size_t *lims) const

在数据集中查找完全重复项。

重复项在预分配的数组中返回（参见最大大小）。

参数:

• lims – 重复项组之间的限制（最大大小为 ntotal / 2 + 1）

• ids – ids[lims[i]] : ids[lims[i+1]-1] 是一组重复项 (最大大小为 ntotal)

返回值:

找到的组数 n

void encode(idx_t key, const float *x, uint8_t *code) const

void encode_multiple(size_t n, idx_t *keys, const float *x, uint8_t *codes, bool compute_keys = false) const

对多个向量进行编码

参数:

• n – 要编码的向量的数量

• keys – 这些向量的倒排列表 ID（大小为 n）

• x – 向量 (大小 n * d)

• codes – 输出代码（大小 n * code_size）

• compute_keys – 如果为 false，则假定密钥已预先计算，否则计算它们

void decode_multiple(size_t n, const idx_t *keys, const uint8_t *xcodes, float *x) const

encode_multiple 的逆函数

virtual InvertedListScanner *get_InvertedListScanner(bool store_pairs, const IDSelector *sel) const override

获取此索引的扫描器（store_pairs 表示忽略标签）

默认搜索实现使用它来计算距离

void precompute_table()

构建预计算表

IndexIVFPQ()

virtual void reset() override

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

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

训练量化器并调用 train_encoder 来训练子量化器。

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

使用 NULL ids 调用 add_with_ids。

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

调用 encode_vectors 的默认实现

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

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

参数:

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

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

virtual void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params = nullptr, IndexIVFStats *stats = nullptr) const override

搜索一组向量，这些向量已由 IVF 量化器预先量化。用查询结果填充相应的堆。 默认实现使用 InvertedListScanners 进行搜索。

参数:

• n – 要查询的向量数

• x – 查询向量，大小为 nx * d

• assign – 粗量化索引，大小为 nx * nprobe

• centroid_dis – 到粗糙质心的距离，大小为 nx * nprobe

• distance – 输出距离，大小为 n * k

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

• store_pairs – 将 inv list 索引 + inv list 偏移量存储在结果的上/下 32 位，而不是 ID（用于重新排序）。

• params – 用于覆盖对象的搜索参数

• stats – 要更新的搜索统计信息（可以为空）

virtual void range_search_preassigned(idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs = false, const IVFSearchParameters *params = nullptr, IndexIVFStats *stats = nullptr) const override

搜索一组向量的范围，这些向量已由 IVF 量化器预先量化。 填写 RangeSearchResults 结果。 默认实现使用 InvertedListScanners 进行搜索。

参数:

• n – 要查询的向量数

• x – 查询向量，大小为 nx * d

• assign – 粗量化索引，大小为 nx * nprobe

• centroid_dis – 到粗糙质心的距离，大小为 nx * nprobe

• result – 输出结果

• store_pairs – 将 inv list 索引 + inv list 偏移量存储在结果的上/下 32 位，而不是 ID（用于重新排序）。

• params – 用于覆盖对象的搜索参数

• stats – 要更新的搜索统计信息（可以为空）

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

分配向量，然后调用 search_preassign

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

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

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

参数:

• n – 向量数量

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

• radius – 搜索半径

• result – 结果表

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

重建向量。 仅当 maintain_direct_map 设置为 1 或 2 时才有效

virtual void update_vectors(int nv, const idx_t *idx, const float *v)

更新向量的子集。

索引必须具有 direct_map

参数:

• nv – 要更新的向量数

• idx – 要更新的向量索引，大小为 nv

• v – 新值的向量，大小为 nv*d

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

重建索引向量的子集。

覆盖默认实现以绕过 reconstruct()，该函数要求维护 direct_map。

参数:

• 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 override

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

覆盖默认实现以避免必须维护 direct_map，而是通过 store_pairs 标志在 search_preassigned() 中获取代码偏移量。

参数:

recons – 重建向量，大小为 (n, k, d)

void search_and_return_codes(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno = false, const SearchParameters *params = nullptr) const

与搜索类似，但也返回与搜索结果的存储向量相对应的代码。

参数:

• codes – 代码 (n, k, code_size)

• include_listno – 在代码中包含列表 ID（在这种情况下，将 ceil(log8(nlist)) 添加到代码大小）

virtual size_t remove_ids(const IDSelector &sel) override

数据集操作函数。

virtual void check_compatible_for_merge(const Index &otherIndex) const override

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

virtual void merge_from(Index &otherIndex, idx_t add_id) override

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

virtual CodePacker *get_CodePacker() const

virtual void copy_subset_to(IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const

将条目索引的子集复制到另一个索引，有关 subset_type 的含义，请参见 Invlists::copy_subset_to

inline size_t get_list_size(size_t list_no) const

bool check_ids_sorted() const

id 是否已排序？

void make_direct_map(bool new_maintain_direct_map = true)

初始化直接映射

参数:

new_maintain_direct_map – 如果为 true，则创建直接映射，否则清除它

void set_direct_map_type(DirectMap::Type type)

void replace_invlists(InvertedLists *il, bool own = false)

替换倒排列表，如果 own_invlists 为 true，则旧的列表将被释放。

virtual size_t sa_code_size() const override

生成的代码的大小，以字节为单位。

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

编码一组向量。sa_encode 将调用 encode_vector，并且 include_listno=true。

参数:

• n – 要编码的向量数量

• x – 要编码的向量

• bytes – 代码的输出数组

返回值:

写入代码的字节数

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 void reconstruct_batch(idx_t n, const idx_t *keys, float *recons) const

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

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

参数:

• n – 要重建的向量数量

• keys – 要重建的向量的 ID (大小为 n)

• recons – 重建的向量 (大小为 n * 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。

void train_q1(size_t n, const float *x, bool verbose, MetricType metric_type)

训练量化器并调用 train_residual 来训练子量化器。

size_t coarse_code_size() const

计算存储列表 ID 所需的字节数

void encode_listno(idx_t list_no, uint8_t *code) const

idx_t decode_listno(const uint8_t *code) const

公共成员

ProductQuantizer pq

生成编码

bool do_polysemous_training

训练后重新排序 PQ 质心？

PolysemousTraining *polysemous_training

如果为 NULL，则使用默认值

size_t scan_table_threshold

使用表计算还是即时计算？

int polysemous_ht

用于多义过滤的汉明阈值。

int use_precomputed_table

预计算表，以加快查询预处理速度，但会增加一些内存开销（仅用于带 L2 度量的 by_residual）

AlignedTable<float> precomputed_table

如果 use_precompute_table 大小为 nlist * pq.M * pq.ksub

InvertedLists *invlists = nullptr

访问实际数据。

bool own_invlists = false

size_t code_size = 0

每个向量的编码大小（以字节为单位）

int parallel_mode = 0

并行模式确定如何使用 OpenMP 并行化查询

0（默认）：在查询上拆分 1：在倒排列表上并行化 2：在两者上并行化 3：以更精细的粒度在查询上拆分

PARALLEL_MODE_NO_HEAP_INIT：二进制或与之前的值进行或运算，以防止堆被初始化和最终化

const int PARALLEL_MODE_NO_HEAP_INIT = 1024

DirectMap direct_map

可选的映射，将 ID 映射回 invlist 条目。这使得 reconstruct() 成为可能

bool by_residual = true

invlist 中的代码是否编码相对于质心的向量？

int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细级别

bool is_trained

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

MetricType metric_type

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

float metric_arg

度量类型的参数

size_t nprobe = 1

查询时的探针数

size_t max_codes = 0

查询时访问的最大代码数量。

Index *quantizer = nullptr

将向量映射到倒排列表的量化器。

size_t nlist = 0

倒排列表的数量。

char quantizer_trains_alone = 0

= 0: 将量化器用作kmeans训练中的索引 = 1: 仅将训练集传递给量化器的train() = 2: 在平面索引上进行kmeans训练 + 将质心添加到量化器。

bool own_fields = false

对象是否拥有量化器。

ClusteringParameters cp

用于覆盖默认聚类参数。

Index *clustering_index = nullptr

用于覆盖聚类期间使用的索引。