Concept IteratorAssociatedTypesConceptRequires metafunctions for the associated types used in the iterator concepts.
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
-
TGetValue getValue(it);
Returns get-value of pointed-to character. -
TReference operator*(it);
Returns reference to the pointed-to value. -
TReference value(it);
Returns reference to the pointed-to value.
Interface Metafunction Overview
-
Size<TContainer>::Type
Returns the type for distances between two iterators. -
GetValue<TIter>::Type
The get-value type of the iterator (same as the get-value type of the underlying container). -
Pointer<TIter>::Type
Returns pointer to an object, required for operator->, for example. -
Reference<TIter>::Type
The reference type of the iterator (same as the reference type of the underlying container). -
Value<TIter>::Type
The value type of the iterator (same as the value type of the underlying container).
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TReference operator*(it);
Returns reference to the pointed-to value.
Parameters
it
|
The iterator to dereference. |
---|
Returns
TReference |
The reference type. |
---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.