BitPackedTuple - SeqAn API Documentation

# Spec BitPackedTuple
A fixed-size tuple of values. Memory is saved by packing bits.

Extends | Tuple
All Extended | Tuple
Defined in | <seqan/basic.h>
Signature | `template <typename TValue, unsigned SIZE> class Tuple<TValue, SIZE, BitPacked<> >;`

## Template Parameters

`TValue` | The value type.
`SIZE` | The length of the tuple.

## Member Function Overview

### Member Functions Inherited From Tuple

- `i`

## Interface Metafunction Overview

### Interface Metafunctions Inherited From Tuple

- `LENGTH`
- `Value`

## Detailed Description

The characters are stored as bit sequence in an ordinal type (char, ..., int64_t).

### Remarks

Only useful for small alphabets as small tuple sizes (|Sigma|^size <= 2^64 as for Dna or AminoAcid m-grams).

#### Dox Sources

    /*!
     * @class BitPackedTuple
     *
     * @extends Tuple
     *
     * @headerfile <seqan/basic.h>
     *
     * @brief A fixed-size tuple of values. Memory is saved by packing bits.
     *
     * @signature template <typename TValue, unsigned SIZE> class Tuple<TValue,
     *            SIZE, BitPacked<> >;
     *
     * @tparam TValue The value type.
     * @tparam SIZE The length of the tuple.
     *
     * The characters are stored as bit sequence in an ordinal type (char, ...,
     * int64_t).
     *
     * @section Remarks
     *
     * Only useful for small alphabets as small tuple sizes (|Sigma|^size &lt;= 2^64
     * as for Dna or AminoAcid m-grams).
     */