结构体 faiss::IndexIVFSpectralHash

struct IndexIVFSpectralHash : public faiss::IndexIVF

倒排列表，存储大小为 nbit 的二进制码。在二进制转换之前，向量的维度从 dim d 通过 vt（默认情况下为随机旋转）转换为 dim nbit。

每个坐标都减去由 threshold_type 确定的值，并分成大小为 period 的间隔。间隔的一半是 0 位，另一半是 1。

公共类型

enum ThresholdType

值

enumerator Thresh_global: 全局阈值为 0

enumerator Thresh_centroid: 与质心比较

enumerator Thresh_centroid_half: 围绕质心的中心间隔

enumerator Thresh_median: 训练集的中位数

using component_t = float

using distance_t = float

公共函数

IndexIVFSpectralHash(Index *quantizer, size_t d, size_t nlist, int nbit, float period)

IndexIVFSpectralHash()

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

训练向量的编码器。

如果 by_residual 为 true，则使用残差和相应的 assign 数组调用它，否则 x 是原始训练向量，并且 assign=nullptr

virtual void encode_vectors(idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos = false) const override

对一组向量进行编码，就像它们出现在倒排列表中一样

参数:

list_nos – 量化器返回的倒排列表 id（大小为 n）。 -1s 被忽略。
codes – 输出代码，大小为 n * code_size
include_listno – 在代码中包含列表 id（在这种情况下，将 ceil(log8(nlist)) 添加到代码大小）

virtual InvertedListScanner *get_InvertedListScanner(bool store_pairs, const IDSelector *sel) const override

获取此索引的扫描器（store_pairs 意味着忽略标签）

默认搜索实现使用此方法来计算距离

void replace_vt(VectorTransform *vt, bool own = false): 替换空（可能未训练）索引的向量变换

void replace_vt(IndexPreTransform *index, bool own = false): 方便函数，用于从 index_factory 构建的索引中获取 VT（应以“LSH”结尾）

~IndexIVFSpectralHash() override

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

virtual void train(idx_t n, const float *x) override: 训练量化器并调用 train_encoder 来训练子量化器。

virtual void add(idx_t n, const float *x) override: 使用 NULL id 调用 add_with_ids。

virtual void add_with_ids(idx_t n, const float *x, const idx_t *xids) override: 调用 encode_vectors 的默认实现

virtual void add_core(idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context = nullptr)

向量加法的实现，其中向量分配是预定义的。默认实现将代码提取交给 encode_vectors。

参数:: precomputed_idx – 输入向量的量化索引（大小为 n）

virtual void add_sa_codes(idx_t n, const uint8_t *codes, const idx_t *xids) override

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

参数:

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

virtual idx_t train_encoder_num_vectors() const: 可以由子类重新定义，以指示它们需要多少训练向量

virtual void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params = nullptr, IndexIVFStats *stats = nullptr) const override

搜索一组向量，这些向量已通过 IVF 量化器进行预量化。使用查询结果填充相应的堆。默认实现使用 InvertedListScanners 进行搜索。

参数:

n – 要查询的向量数量
x – 查询向量，大小为 nx * d
assign – 粗量化索引，大小为 nx * nprobe
centroid_dis – 到粗糙质心的距离，大小为 nx * nprobe
distance – 输出距离，大小为 n * k
labels – 输出标签，大小为 n * k
store_pairs – 在结果的较高/较低 32 位中存储 inv list 索引 + inv list 偏移量，而不是 ids（用于重新排序）。
params – 用于覆盖对象的搜索参数
stats – 要更新的搜索统计信息（可以为空）

virtual void range_search_preassigned(idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs = false, const IVFSearchParameters *params = nullptr, IndexIVFStats *stats = nullptr) const override

范围搜索一组向量，这些向量已通过 IVF 量化器进行预量化。填写 RangeSearchResults 结果。默认实现使用 InvertedListScanners 进行搜索。

参数:

n – 要查询的向量数量
x – 查询向量，大小为 nx * d
assign – 粗量化索引，大小为 nx * nprobe
centroid_dis – 到粗糙质心的距离，大小为 nx * nprobe
result – 输出结果
store_pairs – 在结果的较高/较低 32 位中存储 inv list 索引 + inv list 偏移量，而不是 ids（用于重新排序）。
params – 用于覆盖对象的搜索参数
stats – 要更新的搜索统计信息（可以为空）

virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override: 分配向量，然后调用 search_preassign

virtual void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override

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

返回所有距离 < 半径的向量。请注意，许多索引未实现 range_search（仅强制执行 k-NN 搜索）。

参数:

n – 向量数
x – 要搜索的输入向量，大小为 n * d
radius – 搜索半径
result – 结果表

virtual void reconstruct(idx_t key, float *recons) const override: 重构一个向量。仅当 maintain_direct_map 设置为 1 或 2 时有效。

virtual void update_vectors(int nv, const idx_t *idx, const float *v)

更新向量的子集。

索引必须具有 direct_map

参数:

nv – 要更新的向量数量
idx – 要更新的向量索引，大小为 nv
v – 新值的向量，大小为 nv*d

virtual void reconstruct_n(idx_t i0, idx_t ni, float *recons) const override

重构索引向量的子集。

覆盖默认实现以绕过 reconstruct()，它要求维护 direct_map。

参数:

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 override

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

覆盖默认实现以避免必须维护 direct_map，而是通过 search_preassigned() 中的 store_pairs 标志来获取代码偏移量。

参数:: recons – 重构向量大小 (n, k, d)

void search_and_return_codes(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno = false, const SearchParameters *params = nullptr) const

类似于搜索，但也会返回搜索结果的存储向量对应的代码。

参数:

codes – 代码 (n, k, code_size)
include_listno – 在代码中包含列表 id（在这种情况下，将 ceil(log8(nlist)) 添加到代码大小）

virtual void reconstruct_from_offset(int64_t list_no, int64_t offset, float *recons) const

给定位置（根据反向列表索引 + 反向列表偏移量），而不是 ID，来重构向量。

当不维护 direct_map 且反向列表偏移量由 search_preassigned() 计算且 store_pairs 设置为 true 时，可用于重构。

virtual size_t remove_ids(const IDSelector &sel) override: 数据集操作函数。

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

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

virtual CodePacker *get_CodePacker() const

virtual void copy_subset_to(IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const: 将索引条目的一个子集复制到另一个索引。有关 subset_type 的含义，请参阅 Invlists::copy_subset_to

inline size_t get_list_size(size_t list_no) const

bool check_ids_sorted() const: ID 是否已排序？

void make_direct_map(bool new_maintain_direct_map = true)

初始化直接映射

参数:: new_maintain_direct_map – 如果为 true，则创建直接映射，否则清除它

void set_direct_map_type(DirectMap::Type type)

void replace_invlists(InvertedLists *il, bool own = false): 替换倒排列表，如果 own_invlists，则取消分配旧列表

virtual size_t sa_code_size() const override: 生成代码的大小（以字节为单位）

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量。 sa_encode 将调用 encode_vector，其中 include_listno=true

参数:

n – 要编码的向量数
x – 要编码的向量
bytes – 代码的输出数组

返回:

写入代码的字节数

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

解码一组向量

参数:

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

void train_q1(size_t n, const float *x, bool verbose, MetricType metric_type): 训练量化器并调用 train_residual 来训练子量化器。

size_t coarse_code_size() const: 计算存储列表 ID 所需的字节数

void encode_listno(idx_t list_no, uint8_t *code) const

idx_t decode_listno(const uint8_t *code) const

公共成员

VectorTransform *vt = nullptr: 从 d 到 nbit 维度的转换

bool own_fields = true: 拥有 vt

int nbit = 0: 二进制签名的位数

float period = 0: 0 和 1 的间隔大小

ThresholdType threshold_type = Thresh_global

std::vector<float> trained: 训练后的阈值。大小为 nlist * nbit，如果为 Thresh_global，则为 0

InvertedLists *invlists = nullptr: 访问实际数据。

bool own_invlists = false

size_t code_size = 0: 每个向量的编码大小，以字节为单位

int parallel_mode = 0

并行模式决定了如何使用 OpenMP 并行化查询

0 (默认): 在查询上拆分 1: 在倒排列表上并行化 2: 在两者上并行化 3: 以更精细的粒度在查询上拆分

PARALLEL_MODE_NO_HEAP_INIT: 二进制或与之前的二进制一起使用，以防止堆被初始化和最终化

const int PARALLEL_MODE_NO_HEAP_INIT = 1024

DirectMap direct_map: 可选的映射，将 id 映射回 invlist 条目。这使得 reconstruct() 成为可能

bool by_residual = true: invlist 中的编码是否对相对于质心的向量进行编码？

int d: 向量维度

idx_t ntotal: 索引向量的总数

bool verbose: 详细级别

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

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

float metric_arg: 度量类型的参数

size_t nprobe = 1: 查询时的探针数量

size_t max_codes = 0: 执行查询要访问的最大代码数

Index *quantizer = nullptr: 将向量映射到倒排列表的量化器

size_t nlist = 0: 倒排列表的数量

char quantizer_trains_alone = 0: >= 0: 在 kmeans 训练中使用量化器作为索引 = 1: 只需将训练集传递给量化器的 train() = 2: 在平面索引上进行 kmeans 训练 + 将质心添加到量化器

ClusteringParameters cp: 用于覆盖默认聚类参数

Index *clustering_index = nullptr: 用于覆盖聚类期间使用的索引