Concept IteratorAssociatedTypesConcept
Requires metafunctions for the associated types used in the iterator concepts.

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

Detailed Description

The SeqAn iterators mirror the definitions from ConceptC++.

Interface Function Overview

Interface Metafunction Overview

Interface Functions Detail

TGetValue getValue(it);

Deprecated.

Use operator*() instead.

Returns get-value of pointed-to character.

Parameters

it The iterator to get get-value from.

Returns

TGetValue The get-value that is pointed to.

Data Races

Thread safety unknown!

TReference operator*(it);

Returns reference to the pointed-to value.

Parameters

it The iterator to dereference.

Returns

TReference The reference type.

Data Races

Thread safety unknown!

TReference value(it);

Deprecated.

Use operator*() instead.

Returns reference to the pointed-to value.

Parameters

it The iterator to dereference.

Returns

TReference The reference type.

Data Races

Thread safety unknown!

Interface Metafunctions Detail

Size<TContainer>::Type

Returns the type for distances between two iterators.

Template Parameters

TContainer The Container type to query.

Returns

Type The type to use for storing iterator distances sizes.

This must be the same type as the distance type of the containers iterators.

GetValue<TIter>::Type

The get-value type of the iterator (same as the get-value type of the underlying container).

Template Parameters

TIter The TIter class to query for its get-value type.

Returns

Type The get-value type of TIter

Pointer<TIter>::Type

Returns pointer to an object, required for operator->, for example.

Template Parameters

TIter The type to query.

Returns

Type Pointer type.

Reference<TIter>::Type

The reference type of the iterator (same as the reference type of the underlying container).

Template Parameters

TIter The TIter class to query for its reference type.

Returns

Type The reference type of TIter

Value<TIter>::Type

The value type of the iterator (same as the value type of the underlying container).

Template Parameters

TIter The TIter class to query for its value type.

Returns

Type The value type of TIter