PigeonholeParameters - SeqAn API Documentation

# Class PigeonholeParameters
Parameters for the pigeonhole filter algorithm.

Defined in | <seqan/index/find_pigeonhole.h>
Signature | `struct PigeonholeParameters;`

## Member Function Overview

- `PigeonholeParameters::PigeonholeParameters();`
  Default constructor.

## Member Variable Overview

- `bool PigeonholeParameters::debug`
  Whether to print debug information, defaults to `false`.
- `unsigned PigeonholeParameters::delta`
  Delta length, becomes index step site; defaults to `0`.
- `unsigned PigeonholeParameters::overlap`
  Overlap length of adjacent q-grams, default is to use non-overlappling q-grams (`= 0`).
- `bool PigeonholeParameters::printDots`
  Whether to print dots for the scanning progress, defaults to `false`.

## See Also

- PigeonholePattern

## Member Functions Detail

### `PigeonholeParameters::PigeonholeParameters();`

Default constructor.

Initializes all member variables, default values are given in the variable documentation.

#### Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

## Member Variables Detail

### `bool PigeonholeParameters::debug`

Whether to print debug information, defaults to `false`.

### `unsigned PigeonholeParameters::delta`

Delta length, becomes index step site; defaults to `0`.

A value of `0` means that the delta will be auto-detected.

### `unsigned PigeonholeParameters::overlap`

Overlap length of adjacent q-grams, default is to use non-overlappling q-grams (`= 0`).

### `bool PigeonholeParameters::printDots`

Whether to print dots for the scanning progress, defaults to `false`.

#### Dox Sources

    /*!
     * @class PigeonholeParameters
     *
     * @headerfile <seqan/index/find_pigeonhole.h>
     *
     * @brief Parameters for the pigeonhole filter algorithm.
     *
     * @signature struct PigeonholeParameters;
     *
     * @see PigeonholePattern
     *
     * @fn PigeonholeParameters::PigeonholeParameters
     *
     * @brief Default constructor.
     *
     * @signature PigeonholeParameters::PigeonholeParameters();
     *
     * Initializes all member variables, default values are given in the variable
     * documentation.
     *
     * @var unsigned PigeonholeParameters::overlap;
     *
     * @brief Overlap length of adjacent q-grams, default is to use non-overlappling
     *        q-grams (<tt>= 0</tt>).
     *
     * @var unsigned PigeonholeParameters::delta;
     *
     * @brief Delta length, becomes index step site; defaults to <tt>0</tt>.
     *
     * A value of <tt>0</tt> means that the delta will be auto-detected.
     *
     * @var bool PigeonholeParameters::printDots;
     *
     * @brief Whether to print dots for the scanning progress, defaults to
     *        <tt>false</tt>.
     *
     * @var bool PigeonholeParameters::debug;
     *
     * @brief Whether to print debug information, defaults to <tt>false</tt>.
     */