Concept InputIteratorConcept
Iterator that allows dereferenced reading.

Extends CopyConstructibleConcept, EqualityComparableConcept, IteratorAssociatedTypesConcept
All Extended CopyConstructibleConcept, EqualityComparableConcept, IteratorAssociatedTypesConcept
All Subcl's BidirectionalIteratorConcept, ForwardIteratorConcept, MutableBidirectionalIteratorConcept, MutableForwardIteratorConcept, MutableRandomAccessIteratorConcept, MutableRootedIteratorConcept, MutableRootedRandomAccessIteratorConcept, RandomAccessIteratorConcept, RootedIteratorConcept, RootedRandomAccessIteratorConcept
Defined in <seqan/basic.h>
Signature InputIteratorConcept<T>

Detailed Description

The SeqAn iterators mirror the definitions from ConceptC++.

See Also

Member Function Overview

Member Functions Inherited From EqualityComparableConcept

Interface Function Overview

Interface Functions Inherited From IteratorAssociatedTypesConcept

Interface Metafunction Overview

Interface Metafunctions Inherited From IteratorAssociatedTypesConcept

Interface Functions Detail

void goNext(it);

Iterates to next position.

Parameters

it The iterator to increment.

This function is equivalent to ++iterator.

Data Races

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

TIterator operator++(it);

C++ built-in prefix increment operator.

Parameters

it The iterator to increment.

Returns

TIterator A copy of the original iterator.

Data Races

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

TIterator operator++(it, i);

C++ built-in suffix increment operator.

Parameters

it The iterator to increment.
i An integer, used to mark suffix decrement.

Returns

TIterator A copy of the original iterator.

Data Races

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

TResult operator->(it);

C++ built-in structure dereference operator.

Parameters

it The iterator to structure-dereference.

Returns

TResult Either a pointer or another type. If it is another type, the operator-> is called recursively.

Data Races

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