Class Specialization
IndexQGram
An index based on an array of sorted q-grams.
 | | ||||||
IndexQGram | |||||||
| | ||||||
Include Headers
seqan/index.h
Parameters
The text type. Types: String | |
The Shape specialization type. Note: This can be either a | |
The specializing type. Types: OpenAddressing Default: Default |
Remarks
The fibres (see Index and Fibre) of this index are a suffix array sorted by the first q characters (see QGramSA) and a q-gram directory (see QGramDir).
The size of the q-gram directory is |Σ|^q.
On a 32bit system the q-gram length is limited to 3 for char alphabets or 13-14 for Dna alphabets.
Consider to use the OpenAddressing q-gram index for longer q-grams if you don't need q-grams to be sorted.
Specialization of
Specializations
| An index based on an array of sorted q-grams. |
Metafunctions
| Type of a specific container member (fibre). (Index) | |
| The default alphabet type of a suffix array, i.e. the type to store a position of a string or string set. (Index) |
Functions
| The begin of a container. (Index) | |
| Resets an object. (Index) | |
| Returns the number of occurences of representative substring or a q-gram in the index text. | |
| Returns the number of occurences of a q-gram for every sequence of a StringSet . | |
| Return the number of sequences in an index' underlying text. (Index) | |
| Builds a q-gram index on a sequence. | |
| Shortcut for | |
| The end of a container. (Index) | |
| Returns a specific fibre of a container. (Index) | |
| Creates a matrix storing the number of common q-grams between all pairs of sequences. | |
| Returns an occurence of the representative substring or a q-gram in the index text. | |
| Returns all occurences of the representative substring or a q-gram in the index text. Returns the number of occurrences of a specified character from the start to a specified position. | |
| Return the q-gram step size used for index creation. | |
| Shortcut for | |
| Shortcut for | |
| Shortcut for | |
| Creates a specific Fibre. (Index) | |
| Shortcut for | |
| On-demand creation of a specific Fibre. (Index) | |
| Shortcut for | |
| Returns whether a specific Fibre is present. (Index) | |
| The number of items/characters. (Index) | |
| Returns the suffix array interval borders of occurences of representative substring or a q-gram in the index text. | |
| Sets the haystack of a Finder object. (Index) | |
| Change the q-gram step size used for index creation. |
Example Programs
See Also
SeqAn - Sequence Analysis Library - www.seqan.de