LocalMatch - SeqAn API Documentation

# Class LocalMatch
Stores information about local matches.

Defined in | <seqan/parse_lm.h>
Signature | `template <typename TId, typename TPosition> class LocalMatch;`

## Template Parameters

`TId` | Type to use for subject/query id.
`TPosition` | Type to use for storing positions.

## Member Variable Overview

- `TPosition LocalMatch::queryBeginPos`
  Begin position of local match in the query.
- `TPosition LocalMatch::queryEndPos`
  End position of local match in the query.
- `TId LocalMatch::queryId`
  The id of the query.
- `TPosition LocalMatch::subjectBeginPos`
  Begin position of local match in the subject.
- `TPosition LocalMatch::subjectEndPos`
  End position of local match in the subject.
- `TId LocalMatch::subjectId`
  The id of the subject.

## Detailed Description

Matches on the reverse-complement are encoded by the begin position being greater than the end position.

Sequence names are not stored in LocalMatch objects but in the LocalMatchStore they belong to.

## See Also

- LocalMatchStore

## Member Variables Detail

### `TPosition LocalMatch::queryBeginPos`

Begin position of local match in the query.

### `TPosition LocalMatch::queryEndPos`

End position of local match in the query.

### `TId LocalMatch::queryId`

The id of the query.

### `TPosition LocalMatch::subjectBeginPos`

Begin position of local match in the subject.

### `TPosition LocalMatch::subjectEndPos`

End position of local match in the subject.

### `TId LocalMatch::subjectId`

The id of the subject.

#### Dox Sources

    /*!
     * @class LocalMatch
     *
     * @headerfile <seqan/parse_lm.h>
     *
     * @brief Stores information about local matches.
     *
     * @signature template <typename TId, typename TPosition> class LocalMatch;
     *
     * @tparam TId Type to use for subject/query id.
     * @tparam TPosition Type to use for storing positions.
     *
     * Matches on the reverse-complement are encoded by the begin position being
     * greater than the end position.
     *
     * Sequence names are not stored in LocalMatch objects but in the @link
     * LocalMatchStore @endlink they belong to.
     *
     * @see LocalMatchStore
     *
     * @var TId LocalMatch::queryId;
     *
     * @brief The id of the query.
     *
     * @var TPosition LocalMatch::queryBeginPos;
     *
     * @brief Begin position of local match in the query.
     *
     * @var TPosition LocalMatch::queryEndPos;
     *
     * @brief End position of local match in the query.
     *
     * @var TPosition LocalMatch::subjectBeginPos;
     *
     * @brief Begin position of local match in the subject.
     *
     * @var TPosition LocalMatch::subjectEndPos;
     *
     * @brief End position of local match in the subject.
     *
     * @var TId LocalMatch::subjectId;
     *
     * @brief The id of the subject.
     */