结构体 faiss::IndexQINCo
-
struct IndexQINCo : public faiss::IndexNeuralNetCodec
公共类型
-
using component_t = float
-
using distance_t = float
公共函数
-
IndexQINCo(int d, int M, int nbits, int L, int h, MetricType metric = METRIC_L2)
-
inline ~IndexQINCo()
-
virtual void train(idx_t n, const float *x) override
对具有代表性的向量集合执行训练
- 参数：
n – 训练向量的数量
x – 训练向量，大小为 n * d
-
virtual void sa_encode(idx_t n, const float *x, uint8_t *codes) const override
编码一组向量
- 参数：
n – 向量数量
x – 输入向量，大小为 n * d
bytes – 输出编码向量，大小为 n * sa_code_size()
-
virtual void sa_decode(idx_t n, const uint8_t *codes, float *x) const override
解码一组向量
- 参数：
n – 向量数量
bytes – 输入编码向量，大小为 n * sa_code_size()
x – 输出向量，大小为 n * d
-
virtual void add(idx_t n, const float *x) override
默认的 add 使用 sa_encode
-
virtual void reset() override
从数据库中移除所有元素。
-
virtual void reconstruct_n(idx_t i0, idx_t ni, float *recons) const override
重建向量 i0 到 i0 + ni - 1
对于某些索引，可能未定义此函数
- 参数：
i0 – 序列中第一个向量的索引
ni – 序列中向量的数量
recons – 重建向量（大小为 ni * d）
-
virtual void reconstruct(idx_t key, float *recons) const override
重建一个存储的向量（如果是有损编码，则重建一个近似值）
对于某些索引，可能未定义此函数
- 参数：
key – 要重建的向量的 ID
recons – 重建向量（大小为 d）
-
virtual size_t sa_code_size() const override
生成的代码的大小，以字节为单位
-
virtual size_t remove_ids(const IDSelector &sel) override
移除一些 ID。注意，由于索引的结构，此操作的语义与通常的语义不同：新的 ID 会被移动。
-
virtual FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const
FlatCodesDistanceComputer 提供了一个 distance_to_code 方法。
默认实现显式地使用 sa_decode 解码向量。
-
inline virtual DistanceComputer *get_distance_computer() const override
获取此索引类型的 DistanceComputer 对象（定义在 AuxIndexStructures 中）。
DistanceComputer 为支持随机访问其向量的索引实现。
-
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 range_search(idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override
查询 n 个维度为 d 的向量到索引中。
返回所有距离 < radius 的向量。请注意，许多索引未实现 range_search（仅 k-NN 搜索是强制性的）。
- 参数：
n – 向量数量
x – 要搜索的输入向量，大小为 n * d
radius – 搜索半径
result – 结果表
-
CodePacker *get_CodePacker() const
-
virtual void check_compatible_for_merge(const Index &otherIndex) const override
检查两个索引是否兼容（即，它们以相同的方式训练并具有相同的参数）。否则抛出异常。
-
virtual void merge_from(Index &otherIndex, idx_t add_id = 0) override
将条目从另一个数据集移动到自身。输出时，other 为空。 add_id 添加到所有移动的 ID（对于连续的 ID，这将是 this->ntotal）
-
virtual void add_sa_codes(idx_t n, const uint8_t *x, const idx_t *xids) override
添加使用独立编解码器计算的向量
- 参数：
codes – 要添加的代码，大小为 n * sa_code_size()
xids – 相应的 ID，大小为 n
-
void permute_entries(const idx_t *perm)
-
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 个向量的索引。
此函数与搜索相同，但仅返回邻居的标签。
- 参数：
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 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 – NN 的输出标签，大小为 n*k
recons – 重建的向量大小 (n, k, d)
公共成员
-
QINCo qinco
-
NeuralNetCodec *net = nullptr
-
size_t M
-
size_t nbits
-
size_t code_size
-
std::vector<uint8_t> codes
已编码的数据集，大小为 ntotal * code_size
-
int d
向量维度
-
idx_t ntotal
索引向量的总数
-
bool verbose
详细程度
-
bool is_trained
设置如果 Index 不需要训练，或者如果训练已经完成
-
MetricType metric_type
此索引用于搜索的度量类型
-
float metric_arg
度量类型的参数
-
using component_t = float