结构体 faiss::IndexNSGFlat
-
struct IndexNSGFlat : public faiss::IndexNSG
带有一个 NSG 结构的 Flat 索引，以更有效地访问元素。
公共类型
-
using component_t = float
-
using distance_t = float
公共函数
-
IndexNSGFlat()
-
IndexNSGFlat(int d, int R, MetricType metric = METRIC_L2)
-
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 search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
搜索的入口点
-
virtual void reconstruct(idx_t key, float *recons) const override
重建一个存储的向量（如果是有损编码，则是近似值）
对于某些索引，此函数可能未定义
- 参数:
key – 要重建的向量的 id
recons – 重建的向量（大小为 d）
-
virtual void reset() 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
查询索引中n个维度为d的向量。
返回所有距离小于半径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 – 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类似，但也重建了搜索结果的存储向量（如果是lossy编码，则重建一个近似值）。
如果查询没有足够的结果，则结果数组将用-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 – 编码后的索引，由搜索和分配返回
-
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 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
-
using component_t = float