Fibre - SeqAn API Documentation

# Fn<> Fibre
Type of a specific container member (fibre).

Defined in | <seqan/index.h>
Signature | `Fibre<TObject, TSpec>::Type;`

## Template Parameters

`TSpec` | Tag to specify the fibre. Types: IndexEsaFibres, FMIndexFibres, QGramIndexFibres, WOTDIndexFibres, WaveletTreeFibres, RightArrayBinaryTreeFibres, RankDictionaryFibres, SentinelRankDictionaryFibres
`TObject` | The container type. Types: Index, RankDictionary, SparseString, CompressedSA

## Return Values

`Type` | Fibre type.

## Detailed Description

### Naming

Some containers, such as the Index or the RankDictionary, can be seen as a collection of tables. However, each table alone is just a collection of information. They only become powerful if used together. Therefore, a more appropriate label for the tables is fibre, like the fibres of a rope.

In addition, sometimes a fibre can be a single value and calling it a table would be misleading.

#### Dox Sources

    /*!
     * @mfn Fibre
     *
     * @headerfile <seqan/index.h>
     *
     * @brief Type of a specific container member (fibre).
     *
     * @signature Fibre<TObject, TSpec>::Type;
     *
     * @tparam TSpec Tag to specify the fibre. Types: @link IndexEsaFibres @endlink,
     *               @link FMIndexFibres @endlink, @link QGramIndexFibres @endlink,
     *               @link WOTDIndexFibres @endlink, @link WaveletTreeFibres
     *               @endlink, @link RightArrayBinaryTreeFibres @endlink, @link
     *               RankDictionaryFibres @endlink, @link
     *               SentinelRankDictionaryFibres @endlink
     * @tparam TObject The container type. Types: @link Index @endlink, @link
     *                 RankDictionary @endlink, @link SparseString @endlink, @link
     *                 CompressedSA @endlink
     *
     * @return Type Fibre type.
     *
     * @section Naming
     *
     * Some containers, such as the @link Index @endlink or the @link RankDictionary
     * @endlink, can be seen as a collection of tables. However, each table alone is
     * just a collection of information. They only become powerful if used together.
     * Therefore, a more appropriate label for the tables is fibre, like the fibres
     * of a rope.
     *
     * In addition, sometimes a fibre can be a single value and calling it a table
     * would be misleading.
     */