BidirectionalIndex - SeqAn API Documentation

# Class BidirectionalIndex
A bidirectional index class.

Defined in | <seqan/index.h>
Signature | `template <typename TText, typename TIndexSpec> class Index<TText, Bidirectional<TIndexSpec> >;`

## Template Parameters

`TText` | The text type. Types: String, StringSet
`TIndexSpec` | Unidirectional index used for constructing a bidirectional one.

## Detailed Description

### Structure

The BidirectionalIndex consists of two unidirectional indices that index the original text and the reverse text.

#### Dox Sources

    /*!
     * @class BidirectionalIndex
     *
     * @headerfile <seqan/index.h>
     *
     * @brief A bidirectional index class.
     *
     * @signature template <typename TText, typename TIndexSpec> class Index<TText,
     *            Bidirectional<TIndexSpec> >;
     *
     * @tparam TText The text type. Types: @link String @endlink, @link StringSet
     *               @endlink
     * @tparam TIndexSpec Unidirectional index used for constructing a bidirectional
     *                    one.
     *
     * @section Structure
     *
     * The BidirectionalIndex consists of two unidirectional indices that index the
     * original text and the reverse text.
     */