MapperConfig - SeqAn API Documentation

# Spec MapperConfig
Configuration of Mapper.

Extends | MapperSpec
All Extended | MapperSpec, Pool
Defined in | <seqan/pipe.h>
Signature | `template <typename TMap[, typename TFile]> struct MapperConfig;`

## Template Parameters

`TMap` | The destination function (see STL's `unary_function`). This functions maps a stream element to its destined position. The result type of this unary function should convertible to `TSize`.
`TFile` | The underlying File type, defaults to `File≶>`.

## Interface Function Overview

### Interface Functions Inherited From Pool

- `assign`
- `atEnd`
- `beginRead`
- `beginWrite`
- `clear`
- `endRead`
- `endWrite`
- `front`
- `length`
- `pop`
- `push`
- `resize`

## Detailed Description

Using this configuration spec., the Mapper's size type is `Size<TFile>::Type`. To use a custom size type MapperConfigSize should be used.

## See Also

- MapperConfigSize

#### Dox Sources

    /*!
     * @class MapperConfig
     *
     * @extends MapperSpec
     *
     * @headerfile <seqan/pipe.h>
     *
     * @brief Configuration of Mapper.
     *
     * @signature template <typename TMap[, typename TFile]> struct MapperConfig;
     *
     * @tparam TMap The destination function (see STL's <tt>unary_function</tt>).
     *              This functions maps a stream element to its destined position.
     *              The result type of this unary function should convertible to
     *              <tt>TSize</tt>.
     * @tparam TFile The underlying File type, defaults to <tt>File&lg;&gt;</tt>.
     *
     * Using this configuration spec., the Mapper's size type is
     * <tt>Size&lt;TFile&gt;::Type</tt>. To use a custom size type MapperConfigSize
     * should be used.
     *
     * @see MapperConfigSize
     */