| Class Index Contains preprocessing data of a fixed text. Allows fast dictionary look-up and advanced computations.
Index
Index_DFI | Index_ESA | Index_QGram | Index_Wotd | Pizza & Chili Index
Index<TText[, TSpec]> Parameters
TText | The text type. Metafunctions: Host Types: String, StringSet
TSpec | The index type. Metafunctions: Spec Default: The result of DefaultIndexSpec
Specializations
Index_DFI | The Deferred Frequency Index (see Weese and Schulz, "Efficient string mining under constraints via the deferred frequency index").
Index_ESA | An index based on an enhanced suffix array.
Index_QGram | An index based on an array of sorted q-grams.
Index_Wotd | An index based on a lazy suffix tree (see Giegerich et al., "Efficient implementation of lazy suffix trees").
Pizza & Chili Index | An adapter for the Pizza & Chili index API.
Metafunctions
Fibre | Type of a specific index member (fibre).
SAValue | The default alphabet type of a suffix array, i.e. the type to store a position of a string or string set.
Functions
begin | The begin of a container.
clear | Resets an object.
end | The end of a container.
getFibre | Returns a specific Fibre of an Index object.
indexCreate | Creates a specific Fibre.
indexRequire | On-demand creation of a specific Fibre.
indexSupplied | Returns whether a specific Fibre is present.
length | The number of items/characters.
setHaystack | Sets the haystack of a Finder object.
Remarks An index contains various arrays or objects, also called fibres (see Fibre). These fibres are created on demand depending on the requirements of an algorithm. Example Programs Index Finder, Index Finder StringSet, Maximal Repeats, Maximal Unique Matches, Mummy, Supermaximal Repeats SeqAn - Sequence Analysis Library - www.seqan.de