结构体 faiss::IndexProductResidualQuantizer

struct IndexProductResidualQuantizer : public faiss::IndexAdditiveQuantizer

基于乘积残差量化器的 Index。

公共类型

using Search_type_t = AdditiveQuantizer::Search_type_t
using component_t = float
using distance_t = float

公共函数

IndexProductResidualQuantizer(int d, size_t nsplits, size_t Msub, size_t nbits, MetricType metric = METRIC_L2, Search_type_t search_type = AdditiveQuantizer::ST_decompress)

构造函数。

参数:

  • d – 输入向量的维度

  • nsplits – 残差量化器的数量

  • Msub – 每个 RQ 的子量化器数量

  • nbits – 每个子向量索引的位数

  • d – 输入向量的维度

  • nsplits – 残差量化器的数量

  • Msub – 每个 RQ 的子量化器数量

  • nbits – 每个子向量索引的位数

IndexProductResidualQuantizer()
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 – 输出 NN 的标签，大小为 n*k

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 FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const override

FlatCodesDistanceComputer 提供了一个 distance_to_code 方法

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

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 会发生偏移

inline virtual DistanceComputer *get_distance_computer() const override

为此类索引获取一个 DistanceComputer (在 AuxIndexStructures 中定义) 对象。

对于支持随机访问其向量的索引，实现了 DistanceComputer。

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

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

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

参数:

  • 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

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

如果查询没有足够的结果，则结果数组将填充 -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 – 编码的索引，由搜索和分配返回

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 返回

公共成员

ProductResidualQuantizer prq

用于编码向量的乘积残差量化器。

AdditiveQuantizer *aq
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

度量类型的参数