文件 AuxIndexStructures.h

namespace faiss

实现了具有多种变体的 k-means 聚类。

此源代码已获得 MIT 许可，该许可位于此源树根目录中的 LICENSE 文件中。

IDSelector 旨在定义要处理的向量子集（用于删除或作为搜索子集）

PQ4 SIMD 打包和累积函数

基本内核使用 bbs = nb * 2 * 16 个向量累积 nq 个查询向量，并为此生成一个输出矩阵。它对于 nq * nb <= 4 很有用，否则寄存器溢出变得太大。

这些函数的实现分布在 3 个 cpp 文件中，以减少并行编译时间。模板被显式实例化。

此文件包含用于计算距离的内核的回调。

在整个库中，向量以 float * 指针的形式提供。当一批处理（添加/搜索）多个向量时，大多数算法都可以优化。在这种情况下，它们作为矩阵传入。当 n 个大小为 d 的向量作为 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 RangeSearchResult

#include <AuxIndexStructures.h>

目标是拥有一个简单的结果结构，同时最大限度地减少结果中的内存复制次数。可以重载方法 do_allocation 以在 Lua 或 Python 等脚本语言的矩阵类型中分配结果表。

公共函数

explicit RangeSearchResult(size_t nq, bool alloc_lims = true): lims 必须在 range_search 的输入上分配。

virtual void do_allocation(): 当 lims 包含每个查询的结果条目的 nb 时调用

virtual ~RangeSearchResult()

公共成员

size_t nq: 查询数量

size_t *lims: 大小 (nq + 1)

idx_t *labels: 查询 i 的结果是 labels[lims[i]:lims[i+1]]

float *distances: 相应的距离（未排序）

size_t buffer_size: 使用的结果缓冲区的大小

struct BufferList

#include <AuxIndexStructures.h>

在复制到 RangeSearchResult 对象之前，用于存储结果的临时缓冲区列表。

由 faiss::RangeSearchPartialResult 继承

公共函数

explicit BufferList(size_t buffer_size)

~BufferList()

void append_buffer(): 创建一个新的缓冲区

void add(idx_t id, float dis): 添加一个结果，如果需要，可能会附加一个新缓冲区

void copy_range(size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis): 将 elemnts ofs:ofs+n-1 复制为缓冲区中的线性数据到表 dest_ids, dest_dis

公共成员

size_t buffer_size

std::vector<Buffer> buffers

size_t wp: 最后一个缓冲区中的写指针。

struct Buffer

公共成员

idx_t *ids

float *dis

struct RangeQueryResult

#include <AuxIndexStructures.h>

单个查询的结果结构

公共函数

void add(float dis, idx_t id): 被搜索函数调用以报告一个新的结果

公共成员

idx_t qno

size_t nres

RangeSearchPartialResult *pres

struct RangeSearchPartialResult : public faiss::BufferList 

#include <AuxIndexStructures.h>

缓冲区中的条目按查询拆分

公共函数

explicit RangeSearchPartialResult(RangeSearchResult *res_in): 最终结果将存储在 res_in 中

RangeQueryResult &new_result(idx_t qno): 开始一个新的结果

void finalize()

void set_lims(): 在 do_allocation 之前由 range_search 调用

void copy_result(bool incremental = false): 在 do_allocation 之后由 range_search 调用

void append_buffer(): 创建一个新的缓冲区

void add(idx_t id, float dis): 添加一个结果，如果需要，可能会附加一个新缓冲区

void copy_range(size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis): 将 elemnts ofs:ofs+n-1 复制为缓冲区中的线性数据到表 dest_ids, dest_dis

公共成员

RangeSearchResult *res

std::vector<RangeQueryResult> queries: 每个查询的查询 ID + 结果数。

size_t buffer_size

std::vector<Buffer> buffers

size_t wp: 最后一个缓冲区中的写指针。

公共静态函数

static void merge(std::vector<RangeSearchPartialResult*> &partial_results, bool do_delete = true): 将一组 PartialResult 合并为一个 RangeSearchResult 在输出时，partialresults 为空！

struct InterruptCallback

由 faiss::TimeoutCallback 继承

公共函数

virtual bool want_interrupt() = 0

inline virtual ~InterruptCallback()

公共静态函数

static void clear_instance()

static void check()

检查是否

设置了中断回调
如果回调返回 true，则抛出一个异常。不应从多个线程调用。

static bool is_interrupted(): 与 check() 相同，但如果被中断，则返回 true 而不是抛出异常。可以从多个线程调用。

static size_t get_period_hint(size_t flops): 假设每次迭代需要一定数量的 flops，检查中断的合理间隔是多少？

公共静态属性

static std::mutex lock

static std::unique_ptr<InterruptCallback> instance

struct TimeoutCallback : public faiss::InterruptCallback 

公共函数

virtual bool want_interrupt() override

void set_timeout(double timeout_in_seconds)

公共成员

std::chrono::time_point<std::chrono::steady_clock> start

double timeout

公共静态函数

static void reset(double timeout_in_seconds)

static void clear_instance()

static void check()

检查是否

设置了中断回调
如果回调返回 true，则抛出一个异常。不应从多个线程调用。

static bool is_interrupted(): 与 check() 相同，但如果被中断，则返回 true 而不是抛出异常。可以从多个线程调用。

static size_t get_period_hint(size_t flops): 假设每次迭代需要一定数量的 flops，检查中断的合理间隔是多少？

公共静态属性

static std::mutex lock

static std::unique_ptr<InterruptCallback> instance

struct VisitedTable

#include <AuxIndexStructures.h>

针对快速访问进行了优化的集合实现。

公共函数

inline explicit VisitedTable(int size)

inline void set(int no): 将标志 #no 设置为 true

inline bool get(int no) const: 获取标志 #no

inline void advance(): 将所有标志重置为 false

公共成员

std::vector<uint8_t> visited

uint8_t visno