文件 MatrixStats.h

namespace faiss

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

此源代码已获得 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 MatrixStats

#include <MatrixStats.h>

报告数据集的一些统计信息并对其进行评论。

它是一个类而不是一个函数，因此所有统计信息也可以从代码访问

公共函数

MatrixStats(size_t n, size_t d, const float *x)

void do_comment(const char *fmt, ...)

公共成员

std::string comments

size_t n = 0

size_t d = 0

size_t n_collision = 0

size_t n_valid = 0

size_t n0 = 0

double min_norm2 = HUGE_VALF

double max_norm2 = 0

uint64_t hash_value = 0

std::vector<PerDimStats> per_dim_stats

std::unordered_map<uint64_t, Occurrence> occurrences

char *buf

size_t nbuf

struct Occurrence

公共成员

size_t first

size_t count

struct PerDimStats

公共函数

void add(float x)

void compute_mean_std()

公共成员

size_t n = 0: 各种特殊条目的计数

size_t n_nan = 0

size_t n_inf = 0

size_t n0 = 0

float min = HUGE_VALF: 用于获取最小值/最大值和标准差值

float max = -HUGE_VALF

double sum = 0

double sum2 = 0

size_t n_valid = 0

double mean = NAN

double stddev = NAN