ModifiedIterator - SeqAn API Documentation

# Class ModifiedIterator
Allows you to modify arbitrary iterators by specializing what differs from an origin.

Implements | RandomAccessIteratorConcept
All Subcl's | ModCyclicShapeModifiedIterator, ModPaddingIterator, ModReverseIterator, ModViewModifiedIterator
All Impl'd | BidirectionalIteratorConcept, CopyConstructibleConcept, DefaultConstructibleConcept, EqualityComparableConcept, ForwardIteratorConcept, InputIteratorConcept, IteratorAssociatedTypesConcept, LessThanComparableConcept, RandomAccessIteratorConcept
Defined in | <seqan/modifier.h>
Signature | `template <typename THost[, typename TSpec]> class ModifiedIterator;`

## Template Parameters

`THost` | The host iterator type.
`TSpec` | Tag used for the specialization, defaults to `void`.

## Member Function Overview

### Member Functions Inherited From EqualityComparableConcept

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

### Member Functions Inherited From LessThanComparableConcept

- `operator<`

### Member Functions Inherited From RandomAccessIteratorConcept

- `operator[]`

## Interface Function Overview

### Interface Functions Inherited From BidirectionalIteratorConcept

- `operator--(prefix)`
- `operator--(suffix)`
- `goPrevious`

### Interface Functions Inherited From InputIteratorConcept

- `operator++(suffix)`
- `operator++(prefix)`
- `operator->`
- `goNext`

### Interface Functions Inherited From IteratorAssociatedTypesConcept

- `operator*`
- `value`
- `getValue`

### Interface Functions Inherited From RandomAccessIteratorConcept

- `difference`
- `operator+=`
- `operator+`
- `operator-=`
- `goNil`
- `goFurther`
- `atNil`

## Interface Metafunction Overview

### Interface Metafunctions Inherited From IteratorAssociatedTypesConcept

- `Difference`
- `GetValue`
- `Pointer`
- `Reference`
- `Value`

### Interface Metafunctions Inherited From RandomAccessIteratorConcept

- `Difference`

## Detailed Description

`THost` can also be a modified iterator, so you can create custom iterators by combining predefined ones.

#### Dox Sources

    /*!
     * @class ModifiedIterator
     *
     * @implements RandomAccessIteratorConcept
     *
     * @headerfile <seqan/modifier.h>
     *
     * @brief Allows you to modify arbitrary iterators by specializing what differs
     *        from an origin.
     *
     * @signature template <typename THost[, typename TSpec]> class
     *            ModifiedIterator;
     *
     * @tparam THost The host iterator type.
     * @tparam TSpec Tag used for the specialization, defaults to <tt>void</tt>.
     *
     * <tt>THost</tt> can also be a modified iterator, so you can create custom
     * iterators by combining predefined ones.
     */