LevenshteinStringEnumerator - SeqAn API Documentation

# Spec LevenshteinStringEnumerator
Enumerate all strings within a given edit distance of a "center string" (of edit distance < 3).

Extends | StringEnumerator
All Extended | StringEnumerator
Defined in | <seqan/misc/edit_environment.h>
Signature | `template <typename TString, unsigned DISTANCE> class StringEnumerator<TString, EditEnvironment<LevenshteinDistance, DISTANCE> >;`

## Template Parameters

`TString` | Type of the string to enumerate the environment of.
`DISTANCE` | The maximal distance to generate strings with.

## Member Function Overview

### Member Functions Inherited From StringEnumerator

- `StringEnumerator`

## Interface Function Overview

### Interface Functions Inherited From StringEnumerator

- `begin`
- `end`
- `length`

## Interface Metafunction Overview

### Interface Metafunctions Inherited From StringEnumerator

- `Difference`
- `Host`
- `Iterator`
- `Position`
- `Reference`
- `Size`
- `Value`

## Member Variable Overview

### Member Variables Inherited From StringEnumerator

- `trim`

## Detailed Description

Note:

The LevenshteinStringEnumerator#length function does not work for `DISTANCE > 2`.

See StringEnumerator for examples.

#### Dox Sources

    /*!
     * @class LevenshteinStringEnumerator
     *
     * @extends StringEnumerator
     *
     * @headerfile <seqan/misc/edit_environment.h>
     *
     * @brief Enumerate all strings within a given edit distance of a "center
     *        string" (of edit distance &lt; 3).
     *
     * @note The @link StringEnumerator#length LevenshteinStringEnumerator#length
     *       @endlink function does not work for <tt>DISTANCE &gt; 2</tt>.
     *
     * @signature template <typename TString, unsigned DISTANCE> class
     *            StringEnumerator<TString, EditEnvironment<LevenshteinDistance,
     *            DISTANCE> >;
     *
     * @tparam TString Type of the string to enumerate the environment of.
     * @tparam DISTANCE The maximal distance to generate strings with.
     *
     * See @link StringEnumerator @endlink for examples.
     */