IndexEsa

Class Specialization

IndexEsa

An index based on an enhanced suffix array.

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

Metafunctions

Fibre	Type of a specific container 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)
countSequences	Return the number of sequences in an index' underlying text. (Index)
end	The end of a container. (Index)
getFibre	Returns a specific fibre of a container. (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