结构体 faiss::IndexAdditiveQuantizerFastScan

struct IndexAdditiveQuantizerFastScan : public faiss::IndexFastScan

IndexAQ 的快速扫描版本。 目前适用于 4 位 AQ。

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

实现：12：块循环，内部循环在 Q 上，qbs 为 13：相同，带有用于存储结果的储水池累加器 14：没有 qbs，带有堆累加器 15：没有 qbs，带有储水池累加器

被 faiss::IndexLocalSearchQuantizerFastScan, faiss::IndexProductLocalSearchQuantizerFastScan, faiss::IndexProductResidualQuantizerFastScan, faiss::IndexResidualQuantizerFastScan 继承

公共类型

using Search_type_t = AdditiveQuantizer::Search_type_t

using component_t = float

using distance_t = float

公共函数

explicit IndexAdditiveQuantizerFastScan(AdditiveQuantizer *aq, MetricType metric = METRIC_L2, int bbs = 32)

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

IndexAdditiveQuantizerFastScan()

~IndexAdditiveQuantizerFastScan() override

explicit IndexAdditiveQuantizerFastScan(const IndexAdditiveQuantizer &orig, int bbs = 32)

从现有的 IndexAQ 构建

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

将条目从另一个数据集移动到自身。在输出时，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 而不是顺序 ids。

默认实现会因断言而失败，因为它不受所有索引的支持。

参数:

• n – 向量的数量

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

• xids – 如果非空，则为要存储的向量的 ids（大小为 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 – 要重建的向量的 ids（大小为 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

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

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

公共成员

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

度量类型的参数