结构体 faiss::IndexPQFastScan

struct IndexPQFastScan : public faiss::IndexFastScan

IndexPQ 的快速扫描版本。目前适用于 4 位 PQ。

代码不是按顺序存储的，而是按大小为 bbs 的块分组的。 这使得可以使用 SIMD 指令快速计算距离。

实现：12：带有内部循环的阻塞循环，Q 的 qbs 13：与存储结果的储层累加器相同 14：没有 qbs 的堆累加器 15：没有 qbs 的储层累加器

公共类型

using component_t = float

using distance_t = float

公共函数

IndexPQFastScan(int d, size_t M, size_t nbits, MetricType metric = METRIC_L2, int bbs = 32)

IndexPQFastScan() = default

explicit IndexPQFastScan(const IndexPQ &orig, int bbs = 32)

从现有的 IndexPQ 构建

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

在一组有代表性的向量上执行训练

参数:

• n – 训练向量的数量

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

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

解码一组向量。

注意：IndexPQFastScan 对象中的代码是不连续的。 但是此方法需要连续的表示形式。

参数:

• 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 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 – 输出最近邻的标签，大小为 n*k

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 – 输出最近邻的标签，大小为 n*k

• k – 最近邻的数量

virtual void reconstruct_batch(idx_t n, const idx_t *keys, float *recons) const

重构多个存储的向量（如果是lossy coding，则是近似值）

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

参数:

• 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 – 输出最近邻的标签，大小为 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 add_sa_codes(idx_t n, const uint8_t *codes, const idx_t *xids)

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

参数:

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

• xids – 相应的 ID，大小为 n

公共成员

ProductQuantizer pq

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

度量类型的参数