Class Specialization
FMIndex
An index based on the Burrows-Wheeler transform.
Index
FMIndex
Index<TText, FMIndex<TOccSpec, TSpec> >
Include Headers
seqan/index.h
Parameters
TText
The text type.
TOccSpec
Occurrence table specialisation.
Types: SBM, WT
Default: Tag.WT
Remarks: The tags are really shortcuts for the different SentinelRankDictionarys
TSpec
FM index specialisation.
Default: void
Specialization of
Metafunctions
FibreType of a specific container member (fibre). (Index)
SAValueThe default alphabet type of a suffix array, i.e. the type to store a position of a string or string set. (Index)
Functions
beginThe begin of a container.
clearResets an object. (Index)
countSequencesReturn the number of sequences in an index' underlying text. (Index)
endThe end of a container. (Index)
getFibreReturns a specific fibre of a container. (Index)
indexCreateCreates a specific Fibre. (Index)
indexRequireOn-demand creation of a specific Fibre. (Index)
indexSAShortcut for getFibre(.., FibreSA). (Index)
indexSuppliedReturns whether a specific Fibre is present. (Index)
indexTextShortcut for getFibre(index, FibreText()). (Index)
lengthThe number of characters in the underlying text of the index is returned. (Index)
openThis functions opens an index from disk. (Index)
saveThis functions saves an index to disk. (Index)
setHaystackSets the haystack of a Finder object. (Index)
toSuffixPositionThis function computes the position of a specified position in the suffix array (additionally containing entries for the sentinels. The returned position correspond to the suffix array of the original text without sentinels.
SeqAn - Sequence Analysis Library - www.seqan.de
 

Page built @2013/07/11 09:12:38