Index Esa Fibres - SeqAn API Documentation

# Group Index Esa Fibres
Tag to select a specific fibre (e.g. table, object, ...) of an IndexEsa index.

## Grouped Tags Overview

- `EsaBwt`
  The Burrows-Wheeler table.
- `EsaChildtab`
  The child table.
- `EsaIsa`
  The inverse suffix array.
- `EsaLcp`
  The lcp table.
- `EsaLcpe`
  The lcpe table.
- `EsaRawText`
  The raw text the index is really based on.
- `EsaSA`
  The suffix array.
- `EsaText`
  The original text the index should be based on.

## Detailed Description

These tags can be used to get Fibres of an Enhanced Suffix Array based IndexEsa.

## See Also

- Fibre
- IndexEsa
- getFibre

## Grouped Tags Detail

### `EsaBwt`

Defined in
  <seqan/index.h>

The Burrows-Wheeler table.

The Burrows-Wheeler table contains the Burrows-Wheeler transformation of `EsaRawText`. The entries are the characters left of the corresponding suffix in the suffix array `EsaSA`.

Fibre returns the same type for `EsaRawText` and for `EsaBwt`.

### `EsaChildtab`

Defined in
  <seqan/index.h>

The child table.

The child table contains structural information of the suffix tree (see Abhouelda et al.).

Fibre returns a String over the alphabet of a size type.

### `EsaIsa`

Defined in
  <seqan/index.h>

The inverse suffix array.

The inverse suffix array stores the lexicographic rank of each suffix of `EsaRawText`.

Fibre returns a String over the alphabet of a size type.

### `EsaLcp`

Defined in
  <seqan/index.h>

The lcp table.

The lcp table contains the lcp-value of two adjacent suffices in the suffix array `EsaSA`.

Fibre returns a String over the alphabet of a size type.

### `EsaLcpe`

Defined in
  <seqan/index.h>

The lcpe table.

### `EsaRawText`

Defined in
  <seqan/index.h>

The raw text the index is really based on.

`EsaText` and `EsaRawText` fibres are equal by default. They differ if the index text is a set of strings. Then, raw text is the concatenation of all strings in this set.

### `EsaSA`

Defined in
  <seqan/index.h>

The suffix array.

The suffix array contains the indices of all suffices of `EsaRawText` in lexicographical order.

Fibre returns a String over the alphabet of the SAValue of `TIndex`.

### `EsaText`

Defined in
  <seqan/index.h>

The original text the index should be based on.

#### Dox Sources

    /*!
     * @defgroup IndexEsaFibres Index Esa Fibres
     *
     * @brief Tag to select a specific fibre (e.g. table, object, ...) of an @link
     *        IndexEsa @endlink index.
     *
     * These tags can be used to get @link Fibre Fibres @endlink of an Enhanced
     * Suffix Array based @link IndexEsa @endlink.
     *
     * @see Fibre
     * @see Index#getFibre
     * @see IndexEsa
     *
     * @tag IndexEsaFibres#EsaSA
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The suffix array.
     *
     * The suffix array contains the indices of all suffices of <tt>EsaRawText</tt>
     * in lexicographical order.
     *
     * @link Fibre @endlink returns a @link String @endlink over the alphabet of the
     * @link SAValue @endlink of <tt>TIndex</tt>.
     *
     * @tag IndexEsaFibres#EsaIsa
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The inverse suffix array.
     *
     * The inverse suffix array stores the lexicographic rank of each suffix of
     * <tt>EsaRawText</tt>.
     *
     * @link Fibre @endlink returns a @link String @endlink over the alphabet of a
     * size type.
     *
     * @tag IndexEsaFibres#EsaChildtab
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The child table.
     *
     * The child table contains structural information of the suffix tree (see
     * Abhouelda et al.).
     *
     * @link Fibre @endlink returns a @link String @endlink over the alphabet of a
     * size type.
     *
     * @tag IndexEsaFibres#EsaRawText
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The raw text the index is really based on.
     *
     * <tt>EsaText</tt> and <tt>EsaRawText</tt> fibres are equal by default. They
     * differ if the index text is a set of strings. Then, raw text is the
     * concatenation of all strings in this set.
     *
     * @tag IndexEsaFibres#EsaText
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The original text the index should be based on.
     *
     * @tag IndexEsaFibres#EsaBwt
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The Burrows-Wheeler table.
     *
     * The Burrows-Wheeler table contains the Burrows-Wheeler transformation of
     * <tt>EsaRawText</tt>. The entries are the characters left of the corresponding
     * suffix in the suffix array <tt>EsaSA</tt>.
     *
     * @link Fibre @endlink returns the same type for <tt>EsaRawText</tt> and for
     * <tt>EsaBwt</tt>.
     *
     * @tag IndexEsaFibres#EsaLcp
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The lcp table.
     *
     * The lcp table contains the lcp-value of two adjacent suffices in the suffix
     * array <tt>EsaSA</tt>.
     *
     * @link Fibre @endlink returns a @link String @endlink over the alphabet of a
     * size type.
     *
     * @tag IndexEsaFibres#EsaLcpe
     *
     * @headerfile <seqan/index.h>
     *
     * @brief The lcpe table.
     */