结构体 faiss::IndexBinaryFlat
-
struct IndexBinaryFlat : public faiss::IndexBinary
存储完整向量并执行穷举搜索的 Index。
公共类型
-
using component_t = uint8_t
-
using distance_t = int32_t
公共函数
-
explicit IndexBinaryFlat(idx_t d)
-
virtual void add(idx_t n, const uint8_t *x) override
将维度为 d 的 n 个向量添加到索引。
向量隐式地分配标签 ntotal .. ntotal + n - 1
- 参数:
x – 输入矩阵，大小为 n * d / 8
-
virtual void reset() override
从数据库中删除所有元素。
-
virtual void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
查询索引中维度为 d 的 n 个向量。
最多返回 k 个向量。如果查询的结果不足，则结果数组会用 -1 填充。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
labels – NNs 的输出标签，大小为 n*k
distances – 输出成对距离，大小为 n*k
-
virtual void range_search(idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override
查询索引中维度为 d 的 n 个向量。
返回所有距离 < radius 的向量。请注意，许多索引没有实现 range_search（只有 k-NN 搜索是强制性的）。距离转换为 float 以重用 RangeSearchResult 结构，但它们是整数。按照惯例，只返回距离 < radius（严格比较）的距离，即 radius = 0 不返回任何结果，1 只返回完全相同的向量。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
radius – 搜索半径
result – 结果表
-
virtual void reconstruct(idx_t key, uint8_t *recons) const override
重建存储的向量。
此函数可能未针对某些索引定义。
- 参数:
key – 要重建的向量的 id
recons – 重建的向量（大小为 d / 8）
-
virtual size_t remove_ids(const IDSelector &sel) override
删除一些 id。请注意，由于索引结构的原因，此操作的语义与通常的语义不同：新的 id 会被移位。
-
inline IndexBinaryFlat()
-
virtual void train(idx_t n, const uint8_t *x)
在一组有代表性的向量上执行训练。
- 参数:
n – 训练向量的数量
x – 训练向量，大小为 n * d / 8
-
virtual void add_with_ids(idx_t n, const uint8_t *x, const idx_t *xids)
与 add 相同，但存储 xids 而不是顺序 id。
默认实现会因为断言失败，因为它不是所有索引都支持的。
- 参数:
xids – 如果非空，则为要为向量存储的 ID（大小为 n）
-
void assign(idx_t n, const uint8_t *x, idx_t *labels, idx_t k = 1) const
返回与查询 x 最接近的 k 个向量的索引。
此函数与 search 相同，但仅返回邻居的标签。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
labels – NNs 的输出标签，大小为 n*k
-
virtual void reconstruct_n(idx_t i0, idx_t ni, uint8_t *recons) const
重构向量 i0 到 i0 + ni - 1。
此函数可能未针对某些索引定义。
- 参数:
recons – 重构的向量（大小为 ni * d / 8）
-
virtual void search_and_reconstruct(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params = nullptr) const
类似于 search，但也重构了搜索结果的已存储向量（对于有损编码的情况，则重构近似向量）。
如果查询的结果不足，则结果数组将用 -1 填充。
- 参数:
recons – 重构的向量大小 (n, k, d)
-
void display() const
显示实际的类名和更多信息。
-
virtual void merge_from(IndexBinary &otherIndex, idx_t add_id = 0)
将条目从另一个数据集移动到自身。 在输出时，other 为空。 add_id 将添加到所有移动的 ID（对于顺序 ID，这将是 this->ntotal）
-
virtual void check_compatible_for_merge(const IndexBinary &otherIndex) const
检查两个索引是否兼容（即，它们以相同的方式进行训练并且具有相同的参数）。 否则抛出异常。
-
virtual size_t sa_code_size() const
生成的代码的大小（以字节为单位）
-
virtual void add_sa_codes(idx_t n, const uint8_t *codes, const idx_t *xids)
与 IndexBinary 的 add_with_ids 相同。
公共成员
-
std::vector<uint8_t> xb
数据库向量，大小为 ntotal * d / 8
-
bool use_heap = true
选择使用堆或计数来选择扫描倒排列表时最小的 k 个值。
-
size_t query_batch_size = 32
-
ApproxTopK_mode_t approx_topk_mode = ApproxTopK_mode_t::EXACT_TOPK
-
int d = 0
向量维度
-
int code_size = 0
每个向量的字节数（= d / 8）
-
idx_t ntotal = 0
索引向量的总数
-
bool verbose = false
详细程度
-
bool is_trained = true
如果Index不需要训练，或者已经完成训练，则设置此项
-
MetricType metric_type = METRIC_L2
此索引用于搜索的度量类型
-
using component_t = uint8_t