结构体 faiss::IndexIVFFlat

struct IndexIVFFlat : public faiss::IndexIVF

带有存储向量的倒排文件。 这里，倒排文件预先选择要搜索的向量，但它们没有被其他方式编码，代码数组只包含原始的浮点条目。

被 faiss::IndexIVFFlatDedup 继承

公共类型

using component_t = float

using distance_t = float

公共函数

IndexIVFFlat(Index *quantizer, size_t d, size_t nlist_, MetricType = METRIC_L2)

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）

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 InvertedListScanner *get_InvertedListScanner(bool store_pairs, const IDSelector *sel) const override

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

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

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

根据 (inv list index + inv list offset) 而不是 id 重构向量。

当不维护 direct_map 并且 inv list offset 由 search_preassigned() 计算且 store_pairs 设置时，此方法很有用。

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

解码一组向量

参数:

• n – 向量的数量

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

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

IndexIVFFlat()

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 id 调用 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 train_encoder(idx_t n, const float *x, const idx_t *assign)

为向量训练编码器。

如果 by_residual 为真，则使用残差和相应的分配数组调用它，否则 x 是原始训练向量，assign=nullptr

virtual idx_t train_encoder_num_vectors() const

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

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 – 在结果的上/下 32 位中存储 inv list 索引 + inv list 偏移量，而不是 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 – 在结果的上/下 32 位中存储 inv list 索引 + inv list 偏移量，而不是 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 被添加到所有移动的 ids（对于连续的 ids，这将是 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

ids 是否已排序？

void make_direct_map(bool new_maintain_direct_map = true)

初始化 direct map

参数:

new_maintain_direct_map – 如果为 true，则创建 direct map，否则清除它

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

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

参数:

• n – 向量的数量

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

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

公共成员

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 映射回倒排列表条目。 这使得 reconstruct() 成为可能。

bool by_residual = true

倒排列表中的代码是否编码相对于质心的向量？

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

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