Iupac - SeqAn API Documentation

# Spec Iupac
Iupac code for DNA.

Extends | SimpleType
All Extended | SimpleType
All Impl'd | AlphabetConcept, AssignableConcept, ComparableConcept, CopyConstructibleConcept, DefaultConstructibleConcept, EqualityComparableConcept, FiniteOrderedAlphabetConcept, LessThanComparableConcept, OrderedAlphabetConcept
Defined in | <seqan/basic.h>
Signature | `typedef SimpleType<unsigned char, Iupac_> Iupac;`

## Member Function Overview

### Member Functions Inherited From SimpleType

- `SimpleType`

### Member Functions Inherited From AssignableConcept

- `operator=`

### Member Functions Inherited From ComparableConcept

- `operator>`

### Member Functions Inherited From EqualityComparableConcept

- `operator!=`
- `operator==`

### Member Functions Inherited From LessThanComparableConcept

- `operator<`

### Member Functions Inherited From OrderedAlphabetConcept

- `operator<`

## Interface Function Overview

### Interface Functions Inherited From AssignableConcept

- `assign`
- `set`
- `move`

### Interface Functions Inherited From ComparableConcept

- `operator<=`
- `operator>=`

### Interface Functions Inherited From FiniteOrderedAlphabetConcept

- `ordValue`
- `valueSize`

### Interface Functions Inherited From OrderedAlphabetConcept

- `supremumValueImpl`
- `maxValue`
- `infimumValueImpl`
- `minValue`

## Interface Metafunction Overview

### Interface Metafunctions Inherited From AlphabetConcept

- `BitsPerValue`

### Interface Metafunctions Inherited From FiniteOrderedAlphabetConcept

- `ValueSize`

### Interface Metafunctions Inherited From OrderedAlphabetConcept

- `MaxValue`
- `MinValue`

## Member Variable Overview

### Member Variables Inherited From SimpleType

- `value`

## Detailed Description

The ValueSize of `Iupac` is 16. The nucleotides are enumerated from 0 to 19 in this order: 'U'=0, 'T', 'A', 'W', 'C', 'Y', 'M', 'H', 'G', 'K', 'R', 'D', 'S', 'B', 'V', 'N'=15.

Objects of type `Iupac` can be converted to various other types and vice versa. Unknown values are converted to `'N'`.

## See Also

- IupacIterator
- IupacString

#### Dox Sources

    /*!
     * @class Iupac
     *
     * @extends SimpleType
     *
     * @headerfile <seqan/basic.h>
     *
     * @brief Iupac code for DNA.
     *
     * @signature typedef SimpleType<unsigned char, Iupac_> Iupac;
     *
     * The ValueSize of <tt>Iupac</tt> is 16. The nucleotides are enumerated from 0
     * to 19 in this order: 'U'=0, 'T', 'A', 'W', 'C', 'Y', 'M', 'H', 'G', 'K', 'R',
     * 'D', 'S', 'B', 'V', 'N'=15.
     *
     * Objects of type <tt>Iupac</tt> can be converted to various other types and
     * vice versa. Unknown values are converted to <tt>'N'</tt>.
     *
     * @see IupacString
     * @see IupacIterator
     */