结构体 faiss::IndexFlat1D

struct IndexFlat1D : public faiss::IndexFlatL2

针对1维“向量”的优化版本。

公共类型

using component_t = float
using distance_t = float

公共函数

explicit IndexFlat1D(bool continuous_update = true)
void update_permutation()

如果不是 continuous_update，则在最后一次 add 和第一次 search 之间调用此方法

virtual void add(idx_t n, const float *x) override

将维度为 d 的 n 个向量添加到索引中。

向量被隐式分配标签 ntotal .. ntotal + n - 1 此函数将输入向量切分成小于 blocksize_add 的块并调用 add_core。

参数:

  • n – 向量的数量

  • x – 输入矩阵，大小为 n * d

virtual void reset() override

从数据库中删除所有元素。

virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override

警告：返回的距离是 L1，而不是 L2。

virtual FlatCodesDistanceComputer *get_FlatCodesDistanceComputer() const override

FlatCodesDistanceComputer 提供 distance_to_code 方法

默认实现使用 sa_decode 显式解码向量。

void sync_l2norms()
void clear_l2norms()
virtual void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override

查询索引中维度为 d 的 n 个向量。

返回所有距离 < radius 的向量。请注意，许多索引不实现 range_search（只有 k-NN 搜索是强制性的）。

参数:

  • n – 向量的数量

  • x – 要搜索的输入向量，大小为 n * d

  • radius – 搜索半径

  • result – 结果表

virtual void reconstruct(idx_t key, float *recons) const override

重建存储的向量（如果是有损编码，则重建近似值）

此函数可能未针对某些索引定义

参数:

  • key – 要重建的向量的 ID

  • recons – 重构向量 (大小为 d)

void compute_distance_subset(idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const

计算向量子集的距离

参数:

  • x – 查询向量，大小为 n * d

  • labels – 应该为每个查询向量比较的向量的索引，大小为 n * k

  • distances – 对应的输出距离，大小为 n * k

inline float *get_xb()
inline const float *get_xb() const
virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量

参数:

  • n – 向量的数量

  • x – 输入向量，大小为 n * d

  • bytes – 输出编码向量，大小为 n * sa_code_size()

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override

解码一组向量

参数:

  • n – 向量的数量

  • bytes – 输入编码向量，大小为 n * sa_code_size()

  • x – 输出向量，大小为 n * d

virtual void reconstruct_n(idx_t i0, idx_t ni, float *recons) const override

重构向量 i0 到 i0 + ni - 1

此函数可能未针对某些索引定义

参数:

  • i0 – 序列中第一个向量的索引

  • ni – 序列中向量的数量

  • recons – 重构向量 (大小为 ni * d)

virtual size_t sa_code_size() const override

生成的代码的大小（以字节为单位）

virtual size_t remove_ids(const IDSelector &sel) override

删除一些 ID。 请注意，由于索引的结构，此操作的语义与通常的语义不同：新 ID 已移位

inline virtual DistanceComputer *get_distance_computer() const override

为此类索引获取一个 DistanceComputer (在 AuxIndexStructures 中定义) 对象。

DistanceComputer 针对支持随机访问其向量的索引实现。

CodePacker *get_CodePacker() const
virtual void check_compatible_for_merge(const Index &otherIndex) const override

检查两个索引是否兼容（即，它们以相同的方式进行训练并具有相同的参数）。 否则抛出异常。

virtual void merge_from(Index &otherIndex, idx_t add_id = 0) override

将条目从另一个数据集移动到 self。 在输出时，other 为空。 add_id 被添加到所有移动的 ID (对于顺序 ID，这将是 this->ntotal)

virtual void add_sa_codes(idx_t n, const uint8_t *x, const idx_t *xids) override

添加使用独立编解码器计算的向量

参数:

  • codes – 要添加的代码，大小为 n * sa_code_size()

  • xids – 对应的ID，大小为 n

void permute_entries(const idx_t *perm)
virtual void train(idx_t n, const float *x)

在一组代表性向量上执行训练

参数:

  • n – 训练向量的数量

  • x – 训练向量，大小为 n * d

virtual void add_with_ids(idx_t n, const float *x, const idx_t *xids)

与 add 相同，但存储 xids 而不是顺序 ID。

默认实现会因断言而失败，因为它并非所有索引都支持。

参数:

  • n – 向量的数量

  • x – 输入向量，大小为 n * d

  • xids – 如果非空，则为要存储的向量的 ID（大小为 n）

virtual void assign(idx_t n, const float *x, idx_t *labels, idx_t k = 1) const

返回与查询 x 最接近的 k 个向量的索引。

此函数与搜索相同，但仅返回邻居的标签。

参数:

  • n – 向量的数量

  • x – 要搜索的输入向量，大小为 n * d

  • labels – NN 的输出标签，大小为 n*k

  • k – 最近邻的数量

virtual void reconstruct_batch(idx_t n, const idx_t *keys, float *recons) const

重建多个存储的向量（如果是有损编码，则是近似值）

此函数可能未针对某些索引定义

参数:

  • n – 要重建的向量的数量

  • keys – 要重建的向量的 ID（大小为 n）

  • recons – 重建的向量（大小为 n * d）

virtual void search_and_reconstruct(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params = nullptr) const

类似于搜索，但也重建了搜索结果的存储向量（或者在有损编码的情况下，是近似值）。

如果查询的结果不足，则结果数组将填充 -1。

参数:

  • n – 向量的数量

  • x – 要搜索的输入向量，大小为 n * d

  • k – 提取的向量的数量

  • distances – 输出成对距离，大小为 n*k

  • labels – NN 的输出标签，大小为 n*k

  • recons – 重建的向量，大小为 (n, k, d)

virtual void compute_residual(const float *x, float *residual, idx_t key) const

计算索引编码后的残差向量。

残差向量是向量与可以从其在索引中的表示形式解码的重建之间的差。残差可用于多阶段索引方法，例如 IndexIVF 的方法。

参数:

  • x – 输入向量，大小为 d

  • residual – 输出残差向量，大小为 d

  • key – 编码后的索引，由 search 和 assign 返回

virtual void compute_residual_n(idx_t n, const float *xs, float *residuals, const idx_t *keys) const

计算索引编码后的残差向量（批量形式）。相当于为每个向量调用 compute_residual。

残差向量是向量与可以从其在索引中的表示形式解码的重建之间的差。残差可用于多阶段索引方法，例如 IndexIVF 的方法。

参数:

  • n – 向量的数量

  • xs – 输入向量，大小为 (n x d)

  • residuals – 输出残差向量，大小为 (n x d)

  • keys – 编码后的索引，由搜索和分配返回

公共成员

bool continuous_update = true

是否持续更新排列？

std::vector<idx_t> perm

排序后的数据库索引

std::vector<float> cached_l2norms
size_t code_size
std::vector<uint8_t> codes

编码后的数据集，大小为 ntotal * code_size

int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细级别

bool is_trained

设置 Index 是否需要训练，或者是否已经完成训练

MetricType metric_type

此索引用于搜索的度量类型

float metric_arg

度量类型的参数