结构体 faiss::Index2Layer

struct Index2Layer : public faiss::IndexFlatCodes

与IndexIVFPQ类似，但不包含倒排列表：编码存储是顺序的。

这个类主要用于存储可以随机访问的编码向量，搜索功能未实现。

公共类型

using component_t = float
using distance_t = float

公共函数

Index2Layer(Index *量化器, size_t nlist, int M, int nbit = 8, MetricType metric = METRIC_L2)
Index2Layer()
~Index2Layer()
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

未实现

virtual DistanceComputer *get_distance_computer() const override

获取此索引类型的DistanceComputer (在 AuxIndexStructures 中定义) 对象。

DistanceComputer 是为支持随机访问其向量的索引实现的。

void transfer_to_IVFPQ(IndexIVFPQ &other) const

将平面编码转移到 IVFPQ 索引

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

对一组向量进行编码

参数:

  • n – 向量的数量

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

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

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(idx_t n, const float *x) override

默认的add使用sa_encode

virtual void reset() override

移除数据库中的所有元素。

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

重建向量 i0 到 i0 + ni - 1

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

参数:

  • i0 – 序列中第一个向量的索引

  • ni – 序列中向量的数量

  • recons – 重建的向量 (大小为 ni * d)

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

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

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

参数:

  • key – 要重建的向量的 id

  • recons – 重建的向量 (大小为 d)

virtual size_t sa_code_size() const override

生成的代码的大小（以字节为单位）

virtual size_t remove_ids(const IDSelector &sel) override

移除一些 id。 请注意，由于索引的结构，此操作的语义与通常的语义不同：新的 id 会发生移动

virtual FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const

FlatCodesDistanceComputer 提供 distance_to_code 方法

默认实现使用 sa_decode 显式解码向量。

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 – 结果表

CodePacker *get_CodePacker() const
virtual void check_compatible_for_merge(const Index &otherIndex) const override

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

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

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

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

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

参数:

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

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

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

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

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

参数:

  • n – 要重建的向量数

  • keys – 要重建的向量的 id（大小为 n）

  • recons – 重建的向量（大小为 n * 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 – 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 – 编码的索引，由 search 和 assign 返回

公共成员

Level1Quantizer q1

第一层量化器

ProductQuantizer pq

第二层量化器始终是 PQ

size_t code_size_1

第一层代码的大小 (ceil(log8(q1.nlist)))

size_t code_size_2

第二层代码的大小

size_t code_size
std::vector<uint8_t> codes

编码后的数据集，大小为 ntotal * code_size

int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细程度级别

bool is_trained

设置 Index 是否不需要训练，或者是否已经完成训练

MetricType metric_type

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

float metric_arg

度量类型的参数