Spec
IndexEsaAn index based on an enhanced suffix array.
An index based on an enhanced suffix array.
Extends | Index |
---|---|
Implements | StringTreeConcept |
All Extended | Index |
All Impl'd | StringTreeConcept |
Defined in | <seqan/index.h> |
Signature |
template <typename TText, typename TSpec>
class Index<TText, IndexEsa<TSpec> >;
|
Interface Function Overview
-
TValue bwtAt(position, index);
Shortcut for value(indexBwt(..), ..). -
TValue childAt(position, index);
Shortcut for value(indexChildtab(..), ..). -
void createChildtab(childTab, lcp[, algoTag]);
Creates a child table from a given lcp table. -
TBwt indexBwt(index);
Shortcut for getFibre(.., EsaBwt). -
TChildTab indexChildtab(index);
Shortcut for getFibre(.., EsaChildtab). -
TIsa indexIsa(index);
Shortcut for getFibre(.., EsaIsa). -
TLcp indexLcp(index);
Shortcut for getFibre(.., EsaLcp). -
TLcpe indexLcpe(index);
Shortcut for getFibre(.., EsaLcpe). -
TSA indexSA(index);
Shortcut for getFibre(.., EsaSA). -
TValue isaAt(position, index);
Shortcut for value(indexIsa(..), ..). -
TValue lcpAt(position, index);
Shortcut for value(indexLcp(..), ..). -
TValue lcpeAt(position, index);
Shortcut for value(indexLcpe(..), ..). -
TValue saAt(position, index);
Shortcut for value(indexSA(..), ..). -
TValue textAt(position, index);
Shortcut for value(indexText(..), ..).
Interface Functions Inherited From Index
clear
countSequences
getFibre
indexCreate
indexRawText
indexRequire
indexSupplied
indexText
length
open
rawtextAt
save
Interface Functions Inherited From StringTreeConcept
Interface Metafunction Overview
Interface Metafunctions Inherited From Index
Interface Metafunctions Inherited From StringTreeConcept
Detailed Description
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 VSTreeIterator classes.
See Also
Interface Functions Detail
TValue bwtAt(position, index);
Shortcut for value(indexBwt(..), ..).
Parameters
index
|
The IndexEsa object holding the fibre. |
---|---|
position
|
A position in the array on which the value should be accessed. |
Returns
TValue |
A reference or proxy to the value. |
---|
Data Races
Thread safety unknown!
TValue childAt(position, index);
Shortcut for value(indexChildtab(..), ..).
Parameters
position
|
A position in the array on which the value should be accessed. |
---|---|
index
|
The IndexEsa object holding the fibre. |
Returns
TValue |
A reference or proxy to the value. |
---|
Data Races
Thread safety unknown!
void createChildtab(childTab, lcp[, algoTag]);
Creates a child table from a given lcp table.
Parameters
childTab
|
A reference to the resulting child table. |
---|---|
lcp
|
A given lcp table. |
algoTag
|
A tag that identifies the algorithm which is used for the creation. |
The size of childTab must be at least length(text) before calling this function.
Data Races
Thread safety unknown!
TBwt indexBwt(index);
Shortcut for getFibre(.., EsaBwt).
Parameters
index
|
The IndexEsa object holding the fibre. |
---|
Returns
TBwt |
A reference to the EsaBwt fibre (Burrows-Wheeler table). |
---|
Data Races
Thread safety unknown!
TChildTab indexChildtab(index);
Shortcut for getFibre(.., EsaChildtab).
Parameters
index
|
The Index object holding the fibre. |
---|
Returns
TChildTab |
A reference to the EsaChildtab fibre (child table). |
---|
Data Races
Thread safety unknown!
TIsa indexIsa(index);
Shortcut for getFibre(.., EsaIsa).
Parameters
index
|
The Index object holding the fibre. |
---|
Returns
TIsa |
A reference to the inverse suffix array fibre. |
---|
Data Races
Thread safety unknown!
TLcp indexLcp(index);
Shortcut for getFibre(.., EsaLcp).
Parameters
index
|
The Index object holding the fibre. |
---|
Returns
TLcp |
A reference to the EsaLcp fibre (lcp table). |
---|
Data Races
Thread safety unknown!
TLcpe indexLcpe(index);
Shortcut for getFibre(.., EsaLcpe).
Parameters
index
|
The Index object holding the fibre. |
---|
Returns
TLcpe |
A reference to the EsaLcpe fibre (enhanced lcp table). |
---|
Data Races
Thread safety unknown!
TSA indexSA(index);
Shortcut for getFibre(.., EsaSA).
Parameters
index
|
The Index object holding the fibre. |
---|
Returns
TSA |
A reference to the EsaSA fibre (suffix array). |
---|
Data Races
Thread safety unknown!
TValue isaAt(position, index);
Shortcut for value(indexIsa(..), ..).
Parameters
index
|
The Index object holding the fibre. |
---|---|
position
|
A position in the array on which the value should be accessed. |
Returns
TValue |
A reference or proxy to the value in the inverse suffix array. |
---|
Data Races
Thread safety unknown!
TValue lcpAt(position, index);
Shortcut for value(indexLcp(..), ..).
Parameters
index
|
The Index object holding the fibre. |
---|---|
position
|
A position in the array on which the value should be accessed. |
Returns
TValue |
A reference or proxy to the value. |
---|
Data Races
Thread safety unknown!
TValue lcpeAt(position, index);
Shortcut for value(indexLcpe(..), ..).
Parameters
index
|
The Index object holding the fibre. |
---|---|
position
|
A position in the array on which the value should be accessed. |
Returns
TValue |
A reference or proxy to the value. |
---|
Data Races
Thread safety unknown!
TValue saAt(position, index);
Shortcut for value(indexSA(..), ..).
Parameters
index
|
The Index object holding the fibre. |
---|---|
position
|
A position in the array on which the value should be accessed. |
Returns
TValue |
A reference or proxy to the value in the suffix array. |
---|
Data Races
Thread safety unknown!
TValue textAt(position, index);
Shortcut for value(indexText(..), ..).
Parameters
index
|
The Index object holding the fibre. |
---|---|
position
|
A position in the fibre on which the value should be accessed. |
Returns
TValue |
A reference or proxy to the value in the text. |
---|
Data Races
Thread safety unknown!