文件 OnDiskInvertedLists.h
-
namespace faiss
实现了具有许多变体的 k-means 聚类。
版权所有 (c) Facebook, Inc. 及其附属公司。
此源代码根据 MIT 许可证获得许可，该许可证位于此源树的根目录中的 LICENSE 文件中。
IDSelector 旨在定义要处理的向量子集（用于删除或作为搜索的子集）
PQ4 SIMD 压缩和累积函数
基本内核使用 bbs = nb * 2 * 16 个向量累积 nq 查询向量，并生成该输出矩阵。 它对于 nq * nb <= 4 很有趣，否则寄存器溢出变得太大。
这些函数的实现分布在 3 个 cpp 文件中，以减少并行编译时间。 模板被显式实例化。
此文件包含计算距离的内核的回调。
在整个库中，向量以 float * 指针的形式提供。 当多个向量在一个批次中一起处理（添加/搜索）时，大多数算法都可以优化。 在这种情况下，它们作为矩阵传入。 当大小为 d 的 n 个向量作为 float * x 提供时，向量 i 的分量 j 是
x[ i * d + j ]
其中 0 <= i < n 且 0 <= j < d。换句话说，矩阵始终是紧凑的。 在指定矩阵大小时，我们称其为 n*d 矩阵，这意味着行优先存储。
I/O 函数可以读取/写入到文件名、文件句柄或抽象介质的对象。
读取函数返回应该使用 delete 释放的对象。 这些对象中的所有引用都归该对象所有。
倒排列表的定义 + 一些实现该接口的常见类。
由于 IVF（倒排文件）索引对于大规模用例非常有用，因此我们将与它们相关的一些函数分组到这个小库中。 大多数函数都可以在 IndexIVF 和嵌入在 IndexPreTransform 中的 IndexIVF 上运行。
在此文件中，实现了 L2 和内积之外的额外指标
实现了一些神经网络层，主要用于支持 QINCo
定义了一些将变换应用于一组向量的对象。 这些通常是预处理步骤。
-
struct OnDiskInvertedLists : public faiss::InvertedLists
- #include <OnDiskInvertedLists.h>
倒排列表的磁盘存储。
数据存储在内存映射的内存块中（基指针 ptr，大小 totsize）。 每个列表都是一个内存范围，其中包含 (对象 List)，其中包含
uint8_t codes[capacity * code_size]
后跟 idx_t ids[capacity]
在每个数组中，使用 size <= capacity 的第一个元素，其余未初始化。
通过以下方式支持添加和调整大小
将列表的容量向上舍入为 2 的幂
维护一个空闲槽位列表，按大小排序。
根据需要调整 mmap 块的大小。
如果所有列表的大小 == 容量且没有可用的槽位，则 OnDiskInvertedLists 是紧凑的。
向 invlists 添加内容的速度很慢。对于增量添加，最好使用默认的 ArrayInvertedLists 对象，并使用 merge_from 将其转换为 OnDisk。
当已知将要访问一组列表时，调用 prefetch_lists 非常有用，它会启动一组线程来并行读取列表。
公共类型
-
using List = OnDiskOneList
公共函数
-
OnDiskInvertedLists(size_t nlist, size_t code_size, const char *filename)
反向列表是否以只读方式映射
-
virtual size_t list_size(size_t list_no) const override
获取列表的大小
-
virtual const uint8_t *get_codes(size_t list_no) const override
获取反向列表的代码，必须由 release_codes 释放
- 返回值:
代码大小 list_size * code_size
-
virtual const idx_t *get_ids(size_t list_no) const override
获取反向列表的 ID，必须由 release_ids 释放
- 返回值:
ids 大小 list_size
-
virtual size_t add_entries(size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override
-
virtual void update_entries(size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override
-
virtual void resize(size_t list_no, size_t new_size) override
-
size_t merge_from_multiple(const InvertedLists **ils, int n_il, bool shift_ids = false, bool verbose = false)
-
size_t merge_from_1(const InvertedLists *il, bool verbose = false)
与单个 invlist 的 merge_from 相同
-
void crop_invlists(size_t l0, size_t l1)
限制倒排列表到 l0:l1，不触及内存映射区域。
-
virtual void prefetch_lists(const idx_t *list_nos, int nlist) const override
准备以下列表（默认情况下不执行任何操作）。列表可以是 -1，因此使用有符号长整型。
-
~OnDiskInvertedLists() override
-
void do_mmap()
-
void update_totsize(size_t new_totsize)
-
void resize_locked(size_t list_no, size_t new_size)
-
size_t allocate_slot(size_t capacity)
-
void free_slot(size_t offset, size_t capacity)
-
void set_all_lists_sizes(const size_t *sizes)
覆盖所有列表大小并创建一个打包存储。
-
OnDiskInvertedLists()
公共成员
-
size_t totsize
-
uint8_t *ptr
-
bool read_only
-
LockLevels *locks
-
OngoingPrefetch *pf
-
int prefetch_nthread
-
struct Slot
-
struct OnDiskInvertedListsIOHook : public faiss::InvertedListsIOHook
公共函数
-
OnDiskInvertedListsIOHook()
-
virtual void write(const InvertedLists *ils, IOWriter *f) const override
将索引写入到 IOWriter （包括fourcc）
-
virtual InvertedLists *read(IOReader *f, int io_flags) const override
当 fourcc 与此类的 fourcc 匹配时调用
-
virtual InvertedLists *read_ArrayInvertedLists(IOReader *f, int io_flags, size_t nlist, size_t code_size, const std::vector<size_t> &sizes) const override
从 ArrayInvertedLists 读取到这种倒排列表类型中。为此，必须启用回调，并且 io_flag 必须设置为 IO_FLAG_SKIP_IVF_DATA | (fourcc 的 16 个高位)
（默认实现失败）
-
OnDiskInvertedListsIOHook()
-
struct OnDiskInvertedLists : public faiss::InvertedLists