结构体 faiss::ResidualCoarseQuantizer

struct ResidualCoarseQuantizer : public faiss::AdditiveCoarseQuantizer

与默认的 AdditiveCoarseQuantizer 相比，ResidualCoarseQuantizer 有点特殊，因为它可以在搜索时使用束搜索（虽然慢，但可能对非常大的词汇表有用）

公共类型

using component_t = float
using distance_t = float

公共函数

void set_beam_factor(float new_beam_factor)

如果需要，计算质心范数

ResidualCoarseQuantizer(int d, size_t M, size_t nbits, MetricType metric = METRIC_L2)

构造函数。

参数:

  • d – 输入向量的维度

  • M – 子量化器的数量

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

  • d – 输入向量的维度

  • M – 子量化器的数量

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

ResidualCoarseQuantizer(int d, const std::vector<size_t> &nbits, MetricType metric = METRIC_L2)
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 – 输出 NNs 的标签，大小为 n*k

void initialize_from(const ResidualCoarseQuantizer &other)

从 other 复制前 M 个码本级别。 用于将 ResidualQuantizer 裁剪到其前 M 个量化器。

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

N/A。

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

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

此函数可能未为某些索引定义

参数:

  • key – 要重建的向量的 ID

  • recons – 重建的向量（大小为 d）

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

对一组有代表性的向量执行训练。

参数:

  • n – 训练向量的数量

  • x – 训练向量，大小为 n * d

virtual void reset() override

N/A。

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

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

参数:

  • n – 向量的数量

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

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

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

公共成员

ResidualQuantizer rq

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

float beam_factor = 4.0f

波束大小和搜索 k 之间的因子。如果为负，则使用精确的搜索到质心方法

AdditiveQuantizer *aq
std::vector<float> centroid_norms

质心的范数，对 knn-search 有用

int d

向量维度

idx_t ntotal

已索引向量的总数

bool verbose

详细程度

bool is_trained

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

MetricType metric_type

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

float metric_arg

度量类型的参数