Class Specialization
IndexEsa
An index based on an enhanced suffix array.

Index

IndexEsa

Index<TText, IndexEsa<> >
Include Headers
seqan/index.h
Parameters

TText | The text type. Types: String

Remarks
The fibres (see Index and Fibre) of this index are a suffix array (see EsaSA), a lcp table (see EsaLcp), etc.
This index can be accessed as a Suffix Tree using the VSTree Iterator classes.
Specialization of
Index
Metafunctions

Fibre | Type of a specific index member (fibre). (Index)
SAValue | The default alphabet type of a suffix array, i.e. the type to store a position of a string or string set. (Index)
VertexDescriptor | Type of an object that represents a vertex descriptor.

Functions

begin | The begin of a container. (Index)
bwtAt | Shortcut for value(indexBwt(..), ..).
childAt | Shortcut for value(indexChildtab(..), ..).
clear | Resets an object. (Index)
end | The end of a container. (Index)
getFibre | Returns a specific Fibre of an Index object. (Index)
indexBwt | Shortcut for getFibre(.., EsaBwt).
indexChildtab | Shortcut for getFibre(.., EsaChildtab).
indexCreate | Creates a specific Fibre. (Index)
indexLcp | Shortcut for getFibre(.., EsaLcp).
indexLcpe | Shortcut for getFibre(.., EsaLcpe).
indexRawSA | Shortcut for getFibre(.., EsaRawSA).
indexRawText | Shortcut for getFibre(.., EsaRawText).
indexRequire | On-demand creation of a specific Fibre. (Index)
indexSA | Shortcut for getFibre(.., EsaSA).
indexSupplied | Returns whether a specific Fibre is present. (Index)
indexText | Shortcut for getFibre(.., EsaText).
lcpAt | Shortcut for value(indexLcp(..), ..).
lcpeAt | Shortcut for value(indexLcpe(..), ..).
length | The number of items/characters. (Index)
rawsaAt | Shortcut for value(indexRawSA(..), ..).
rawtextAt | Shortcut for value(indexRawText(..), ..).
resizeVertexMap | Initializes a vertex map.
saAt | Shortcut for value(indexSA(..), ..).
setHaystack | Sets the haystack of a Finder object. (Index)
textAt | Shortcut for value(indexText(..), ..).

Example Programs
Maximal Repeats, Index Finder StringSet, Mummy, Maximal Unique Matches, Index Finder, Supermaximal Repeats
See Also
Index Find Algorithm, ESA Index Fibres
SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2012/03/14 16:34:51