CatgirlIntelligenceAgency/code/index/index-reverse/readme.md
Viktor Lofgren 1d34224416 (refac) Remove src/main from all source code paths.
Look, this will make the git history look funny, but trimming unnecessary depth from the source tree is a very necessary sanity-preserving measure when dealing with a super-modularized codebase like this one.

While it makes the project configuration a bit less conventional, it will save you several clicks every time you jump between modules.  Which you'll do a lot, because it's *modul*ar.  The src/main/java convention makes a lot of sense for a non-modular project though.  This ain't that.
2024-02-23 16:13:40 +01:00

2 KiB

Reverse Index

The reverse index contains a mapping from word to document id.

There are two tiers of this index.

  • A priority index which only indexes terms that are flagged with priority flags1.
  • A full index that indexes all terms.

The full index also provides access to term-level metadata, while the priority index is a binary index that only offers information about which documents has a specific word.

[1] See WordFlags in common/model and KeywordMetadata in features-convert/keyword-extraction.

Construction

The reverse index is constructed by first building a series of preindexes. Preindexes consist of a Segment and a Documents object. The segment contains information about which word identifiers are present and how many, and the documents contain information about in which documents the words can be found.

Memory layout illustrations

These would typically not fit in RAM, so the index journal is paged and the preindexes are constructed small enough to fit in memory, and then merged. Merging sorted arrays is a very fast operation that does not require additional RAM.

Illustration of successively merged preindex files

Once merged into one large preindex, indexes are added to the preindex data to form a finalized reverse index.

Illustration of the data layout of the finalized index

Central Classes

See Also