结构体 faiss::MaskedInvertedLists

struct MaskedInvertedLists : public faiss::ReadOnlyInvertedLists

如果第一个倒排列表非空,则使用第一个,否则使用第二个

如果 il1 有一些过长的倒排列表,并且 il0 有这些列表的替换列表(其他列表为空),则此功能很有用。

公共类型

enum subset_type_t

enumerator SUBSET_TYPE_ID_RANGE
enumerator SUBSET_TYPE_ID_MOD
enumerator SUBSET_TYPE_ELEMENT_RANGE
enumerator SUBSET_TYPE_INVLIST_FRACTION
enumerator SUBSET_TYPE_INVLIST

公共函数

MaskedInvertedLists(const InvertedLists *il0, const InvertedLists *il1)
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 释放

返回值:

ID 大小为 list_size

virtual void release_codes(size_t list_no, const uint8_t *codes) const override

释放 get_codes 返回的代码(默认实现为 nop)

virtual void release_ids(size_t list_no, const idx_t *ids) const override

释放 get_ids 返回的 ID

virtual idx_t get_single_id(size_t list_no, size_t offset) const override
返回值:

倒排列表中的单个 ID

virtual const uint8_t *get_single_code(size_t list_no, size_t offset) const override
返回值:

倒排列表中的单个代码(应使用 release_codes 释放)

virtual void prefetch_lists(const idx_t *list_nos, int nlist) const override

准备以下列表(默认情况下不执行任何操作),列表可以是 -1,因此使用有符号的 long

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
virtual bool is_empty(size_t list_no, void *inverted_list_context = nullptr) const

检查列表是否为空

virtual InvertedListsIterator *get_iterator(size_t list_no, void *inverted_list_context = nullptr) const

获取使用 use_iterator 的列表的可迭代对象

virtual size_t add_entry(size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context = nullptr)

向倒排列表添加一个条目

virtual void update_entry(size_t list_no, size_t offset, idx_t id, const uint8_t *code)
virtual void reset()
void merge_from(InvertedLists *oivf, size_t add_id)

从 oivf 移动所有条目(输出时为空)

size_t copy_subset_to(InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const

将条目索引的子集复制到另一个索引

返回值:

复制的条目数

double imbalance_factor() const

1=完美平衡, >1:不平衡

void print_stats() const

显示有关倒排列表的一些统计信息

size_t compute_ntotal() const

汇总列表大小

公共成员

const InvertedLists *il0
const InvertedLists *il1
size_t nlist

可能的键值的数量

size_t code_size

每个向量的代码大小(以字节为单位)

bool use_iterator = false

请求使用迭代器,而不是 get_codes / get_ids

公共静态属性

static const size_t INVALID_CODE_SIZE = static_cast<size_t>(-1)

用于 BlockInvertedLists,其中代码被打包成组,并且单个代码大小没有意义