结构体 faiss::IndexProductResidualQuantizerFastScan

struct IndexProductResidualQuantizerFastScan : public faiss::IndexAdditiveQuantizerFastScan

基于乘积残差量化器的索引。存储的向量通过乘积残差量化代码近似。也可以用作编解码器

公共类型

using Search_type_t = AdditiveQuantizer::Search_type_t

using component_t = float

using distance_t = float

公共函数

IndexProductResidualQuantizerFastScan(int d, size_t nsplits, size_t Msub, size_t nbits, MetricType metric = METRIC_L2, Search_type_t search_type = AdditiveQuantizer::ST_norm_rq2x4, int bbs = 32)

构造函数。

参数:

d – 输入向量的维度
nsplits – 残差量化器的数量
Msub – 每个 RQ 的子量化器数量
nbits – 每个子向量索引的位数
d – 输入向量的维度
nsplits – 残差量化器的数量
Msub – 每个 RQ 的子量化器数量
nbits – 每个子向量索引的位数
metric – 度量类型
search_type – AQ 搜索类型

IndexProductResidualQuantizerFastScan()

void init(AdditiveQuantizer *aq, MetricType metric = METRIC_L2, int bbs = 32)

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

对具有代表性的向量集执行训练

参数:

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

void estimate_norm_scale(idx_t n, const float *x)

virtual void compute_codes(uint8_t *codes, idx_t n, const float *x) const override

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

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

解码一组向量。

注意：IndexAdditiveQuantizerFastScan 对象中的代码是非连续的。但是此方法需要连续的表示。

参数:

n – 向量的数量
bytes – 输入编码向量，大小为 n * code_size
x – 输出向量，大小为 n * d

void init_fastscan(int d, size_t M, size_t nbits, MetricType metric, int bbs)

virtual void reset() override: 从数据库中删除所有元素。

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

将维度为 d 的 n 个向量添加到索引。

向量被隐式分配标签 ntotal .. ntotal + n - 1 此函数将输入向量分割成小于 blocksize_add 的块，并调用 add_core。

参数:

n – 向量的数量
x – 输入矩阵，大小为 n * d

void compute_quantized_LUT(idx_t n, const float *x, uint8_t *lut, float *normalizers) const

template<bool is_max> void search_dispatch_implem(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const

template<class Cfloat> void search_implem_234(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const

template<class C> void search_implem_12(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const

template<class C> void search_implem_14(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const

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

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

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

参数:

key – 要重建的向量的ID
recons – 重建的向量（大小为 d）

virtual size_t remove_ids(const IDSelector &sel) override: 从索引中删除 ID。并非所有索引都支持。返回删除的元素数量。

CodePacker *get_CodePacker() const

virtual void merge_from(Index &otherIndex, idx_t add_id = 0) override: 将条目从另一个数据集移动到 self。输出时，other 为空。 add_id 添加到所有移动的 ID（对于顺序 ID，这将是 this->ntotal）

virtual void check_compatible_for_merge(const Index &otherIndex) const override: 检查两个索引是否兼容（即，它们以相同的方式训练并具有相同的参数）。否则抛出异常。

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

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

返回所有距离 < 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 – 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 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 – 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 返回

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 add_sa_codes(idx_t n, const uint8_t *codes, const idx_t *xids)

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

参数:

codes – 要添加的代码，大小为 n * sa_code_size()
xids – 相应的 ID，大小为 n

公共成员

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

AdditiveQuantizer *aq

bool rescale_norm = true

int norm_scale = 1

size_t max_train_points = 0

int implem = 0

int skip = 0

int bbs

int qbs = 0

size_t M

size_t nbits

size_t ksub

size_t code_size

size_t ntotal2

size_t M2

AlignedTable<uint8_t> codes

const uint8_t *orig_codes = nullptr

int d: 向量维度

idx_t ntotal: 索引向量的总数

bool verbose: 详细级别

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

MetricType metric_type: 此索引用于搜索的度量类型

float metric_arg: 度量类型的参数