Array String - SeqAn API Documentation

# Spec Array String
Fast, static-size string.

Extends | String
All Extended | String
All Impl'd | AssignableConcept, ContainerConcept, DestructibleConcept, ForwardContainerConcept, RandomAccessContainerConcept, ReversibleContainerConcept, SegmentableConcept, StringConcept, TextConcept
Defined in | <seqan/sequence.h>
Signature | `template <typename TValue, size_t CAPACITY> class String<TValue, Array<CAPACITY> >;`

## Template Parameters

`TValue` | The value type, that is the type of the items/characters stored in the string.Use Value to get the value type for a given class.
`CAPACITY` | A positive integer that specifies the capacity of the string.Note that the capacity of an Array String is fixed at compile-time.

## Member Function Overview

### Member Functions Inherited From String

- `operator=`
- `String`

### Member Functions Inherited From AssignableConcept

- `operator=`

### Member Functions Inherited From RandomAccessContainerConcept

- `operator[]`

## Interface Function Overview

### Interface Functions Inherited From String

- `beginPosition`
- `endPosition`
- `reserve`
- `resizeSpace`
- `toCString`

### Interface Functions Inherited From AssignableConcept

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

### Interface Functions Inherited From ContainerConcept

- `begin`
- `end`
- `length`
- `empty`
- `swap`
- `writeValue`
- `write`
- `getObjectId`
- `moveValue`
- `append`
- `appendValue`
- `shrinkToFit`
- `directionIterator`

### Interface Functions Inherited From RandomAccessContainerConcept

- `value`
- `assignValue`
- `getValue`

### Interface Functions Inherited From SegmentableConcept

- `prefix`
- `infixWithLength`
- `infix`
- `suffix`

### Interface Functions Inherited From StringConcept

- `iter`
- `append`
- `appendValue`
- `front`
- `back`
- `resize`
- `clear`
- `erase`
- `eraseFront`
- `eraseBack`
- `capacity`
- `computeGenerousCapacity`
- `insert`
- `insertValue`
- `replace`

### Interface Functions Inherited From TextConcept

- `stringSetLimits`
- `posLocalToX`
- `posLocalize`
- `posGlobalize`
- `getSeqNo`
- `getSeqOffset`

## Interface Metafunction Overview

### Interface Metafunctions Inherited From ContainerConcept

- `DefaultGetIteratorSpec`
- `DefaultIteratorSpec`
- `Difference`
- `DirectionIterator`
- `GetValue`
- `Iterator`
- `Position`
- `Reference`
- `Size`
- `Value`

### Interface Metafunctions Inherited From SegmentableConcept

- `Infix`
- `Prefix`
- `Suffix`

### Interface Metafunctions Inherited From TextConcept

- `SAValue`
- `StringSetLimits`

## Detailed Description

Having static-sized strings is useful as members of structs for external memory algorithms, for example.

#### Dox Sources

    /*!
     * @class ArrayString Array String
     *
     * @extends String
     *
     * @headerfile <seqan/sequence.h>
     *
     * @brief Fast, static-size string.
     *
     * @signature template <typename TValue, size_t CAPACITY> class String<TValue,
     *            Array<CAPACITY> >;
     *
     * @tparam TValue The value type, that is the type of the items/characters
     *                stored in the string.Use @link Value @endlink to get the value
     *                type for a given class.
     * @tparam CAPACITY A positive integer that specifies the capacity of the
     *                  string.Note that the capacity of an Array String is fixed at
     *                  compile-time.
     *
     * Having static-sized strings is useful as members of structs for external
     * memory algorithms, for example.
     */