类 faiss::gpu::GpuIndexBinaryFlat
-
class GpuIndexBinaryFlat : public faiss::IndexBinary
是 IndexBinaryFlat 的 GPU 版本，用于通过汉明距离进行位向量的暴力比较
公共函数
-
GpuIndexBinaryFlat(GpuResourcesProvider *resources, const faiss::IndexBinaryFlat *index, GpuIndexBinaryFlatConfig config = GpuIndexBinaryFlatConfig())
从预先存在的 faiss::IndexBinaryFlat 实例构造，并将数据复制到给定的 GPU
-
GpuIndexBinaryFlat(GpuResourcesProvider *resources, int dims, GpuIndexBinaryFlatConfig config = GpuIndexBinaryFlatConfig())
构造一个可以添加内容的空实例。
-
~GpuIndexBinaryFlat() override
-
int getDevice() const
返回此索引所在的设备。
-
std::shared_ptr<GpuResources> getResources()
返回对 GpuResources 对象的引用，该对象管理 GPU 上的内存、流和句柄资源
-
void copyFrom(const faiss::IndexBinaryFlat *index)
从给定的 CPU 索引初始化自身；将覆盖自身中的所有数据
-
void copyTo(faiss::IndexBinaryFlat *index) const
将自身复制到给定的 CPU 索引；将覆盖索引实例中的所有数据
-
virtual void add(faiss::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, faiss::idx_t *labels, const faiss::SearchParameters *params = nullptr) const override
查询维度为 d 的 n 个向量到索引。
最多返回 k 个向量。 如果查询的结果不足，则结果数组会用 -1 填充。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
labels – NNs 的输出标签，大小为 n*k
distances – 输出成对距离，大小为 n*k
-
virtual void reconstruct(faiss::idx_t key, uint8_t *recons) const override
重建存储的向量。
此函数可能未针对某些索引定义。
- 参数:
key – 要重建的向量的 ID
recons – 重建的向量（大小为 d / 8）
-
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）
-
virtual void range_search(idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const
查询维度为 d 的 n 个向量到索引。
返回距离 < radius 的所有向量。 请注意，许多索引未实现 range_search（只有 k-NN 搜索是强制性的）。 距离会转换为浮点数，以重用 RangeSearchResult 结构，但它们是整数。 按照惯例，仅返回距离 < radius（严格比较）的距离，即 radius = 0 不返回任何结果，而 1 仅返回完全相同的向量。
- 参数:
x – 要搜索的输入向量，大小为 n * d / 8
radius – 搜索半径
result – 结果表
-
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 size_t remove_ids(const IDSelector &sel)
从索引中删除 ID。 并非所有索引都支持。
-
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
与搜索类似，但也会重建搜索结果的存储向量（对于有损编码，则为近似值）。
如果查询的结果不足，则结果数组会用 -1 填充。
- 参数:
recons – 重建的向量大小 (n, k, d)
-
void display() const
显示实际的类名和更多信息。
-
virtual void merge_from(IndexBinary &otherIndex, idx_t add_id = 0)
将条目从另一个数据集移动到 self。 在输出时，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 相同。
公共成员
-
int d = 0
向量维度
-
int code_size = 0
每个向量的字节数（= d / 8）
-
bool verbose = false
详细级别
-
MetricType metric_type = METRIC_L2
此索引用于搜索的度量类型
受保护函数
受保护的属性
-
std::shared_ptr<GpuResources> resources_
管理设备的流、cuBLAS 句柄和暂存内存。
-
const GpuIndexBinaryFlatConfig binaryFlatConfig_
配置选项。
-
GpuIndexBinaryFlat(GpuResourcesProvider *resources, const faiss::IndexBinaryFlat *index, GpuIndexBinaryFlatConfig config = GpuIndexBinaryFlatConfig())