结构体 faiss::IndexHNSW2Level
-
struct IndexHNSW2Level : public faiss::IndexHNSW
具有快速随机访问的 2 级代码结构
公共函数
-
IndexHNSW2Level()
-
IndexHNSW2Level(Index *quantizer, size_t nlist, int m_pq, int M)
-
void flip_to_ivf()
-
virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const 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
-
virtual void train(idx_t n, const float *x) override
如果需要，训练存储。
-
virtual void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override
查询维度为 d 的 n 个向量到索引。
返回所有距离 < radius 的向量。请注意，许多索引不实现 range_search（只有 k-NN 搜索是强制性的）。
- 参数：
n – 向量的数量
x – 要搜索的输入向量，大小为 n * d
radius – 搜索半径
result – 结果表
-
virtual void reconstruct(idx_t key, float *recons) const override
重建存储的向量（如果是有损编码，则重建近似值）
此函数可能未为某些索引定义
- 参数：
key – 要重建的向量的 id
recons – 重建的向量（大小为 d）
-
virtual void reset() override
从数据库中移除所有元素。
-
void shrink_level_0_neighbors(int size)
-
void search_level_0(idx_t n, const float *x, idx_t k, const storage_idx_t *nearest, const float *nearest_d, float *distances, idx_t *labels, int nprobe = 1, int search_type = 1, const SearchParameters *params = nullptr) const
仅在第0层执行搜索，给定每个顶点的起始点。
- 参数：
search_type – 1：每次nprobe执行一次搜索，2：将所有入口点入队
-
void init_level_0_from_knngraph(int k, const float *D, const idx_t *I)
替代的图构建方法
-
void init_level_0_from_entry_points(int npt, const storage_idx_t *points, const storage_idx_t *nearests)
替代的图构建方法
-
void reorder_links()
-
void link_singletons()
-
void permute_entries(const idx_t *perm)
-
virtual DistanceComputer *get_distance_computer() const override
获取此类索引的DistanceComputer（在AuxIndexStructures中定义）对象。
DistanceComputer是为支持对其向量进行随机访问的索引实现的。
-
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 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
类似于 search，但也重建搜索结果的存储向量 (或者，如果是使用有损编码，则进行近似重建)。
如果某个查询的结果不足，则结果数组会用 -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 – 编码的索引，由 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 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
公共成员
-
HNSW hnsw
-
bool own_fields = false
-
Index *storage = nullptr
-
bool init_level0 = true
-
bool keep_max_size_level0 = false
-
int d
向量维度
-
idx_t ntotal
已索引向量的总数
-
bool verbose
详细程度
-
bool is_trained
如果 Index 不需要训练，或者已经完成训练，则设置
-
MetricType metric_type
此索引用于搜索的度量类型
-
float metric_arg
度量类型的参数
-
IndexHNSW2Level()