SorterConfig - SeqAn API Documentation

# Spec SorterConfig
Configuration of Sorter.

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

## Template Parameters

`TCompare` | The compare function (see STL's `binary_function`).
`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

The requirement on TCompare are as follows: let `comp` be an object of type `TCompare`. `comp(a, b)` should return a value less, equal, or greater than 0 if `a < b`, `a == b`, or `a > b`.

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

## See Also

- SorterConfigSize

#### Dox Sources

    /*!
     * @class SorterConfig
     *
     * @extends SorterSpec
     *
     * @headerfile <seqan/pipe.h>
     *
     * @brief Configuration of Sorter.
     *
     * @signature template <typename TCompare[, typename TFile]> struct
     *            SorterConfig;
     *
     * @tparam TCompare The compare function (see STL's <tt>binary_function</tt>).
     * @tparam TFile The underlying File type, defaults to <tt>File&lt;&gt;</tt>.
     *
     * The requirement on TCompare are as follows: let <tt>comp</tt> be an object of
     * type <tt>TCompare</tt>. <tt>comp(a, b)</tt> should return a value less,
     * equal, or greater than 0 if <tt>a &lt; b</tt>, <tt>a == b</tt>, or <tt>a &gt;
     * b</tt>.
     *
     * Using this configuration spec., the Sorter's size type is
     * <tt>Size&lt;TFile&gt;::Type</tt>. To use a custom size type @link
     * SorterConfigSize @endlink should be used.
     *
     * @see SorterConfigSize
     */