Concept
RootedIteratorConcept
Iterator that knows its container.

CopyConstructibleConcept | EqualityComparableConcept | IteratorAssociatedTypesConcept

DefaultConstructibleConcept | InputIteratorConcept

ForwardIteratorConcept

RootedIteratorConcept

RootedRandomAccessIteratorConcept

MutableRootedRandomAccessIteratorConcept

Concept Definition
Refines
ForwardIteratorConcept
Required Metafunctions

Container | Type of the container given an iterator.
Difference | Type of an object that stores the difference between two iterators. (IteratorAssociatedTypesConcept)
GetValue | Type for reading values. (IteratorAssociatedTypesConcept)
Pointer | Returns pointer to an object, required for operator->, for example. (IteratorAssociatedTypesConcept)
Reference | Reference type. (IteratorAssociatedTypesConcept)
Value | Type of the items in the container or behind an iterator. (IteratorAssociatedTypesConcept)

Required Functions

atBegin | Determines whether an iterator is at the beginning position.
atEnd | Determines whether an iterator is at the end position.
container | Container of an iterator.
goBegin | Iterates to the first position of a container.
goEnd | Iterates to the last position of a container.
goNext | Iterates to next position. (ForwardIteratorConcept)
operator* | C++ built-in multiplication operator. (InputIteratorConcept)
operator++ (prefix) | C++ built-in prefix increment operator. (InputIteratorConcept)
operator++ (suffix) | C++ built-in suffix increment operator. (InputIteratorConcept)
operator-> | C++ built-in structure dereference operator. (InputIteratorConcept)

Refinements

RootedRandomAccessIteratorConcept | An iterator that is both rooted and random access, allowing to implement position.

RootedIteratorConcept<T>
Include Headers
seqan/basic.h
Remarks
The SeqAn iterators mirror the definitions from ConceptC++.
Implemented by

AnnotationTree Iterator | Iterator of the annotation tree represented by a FragmentStore.

Used By Function
container, goBegin, atEnd, goEnd, atBegin, value, getValue, goNext
Functions

find | Search for a Pattern in a Finder object.
getValue | Access to the value. (IteratorAssociatedTypesConcept)
goNext | Iterates to next position. (ForwardIteratorConcept)
value | Reference to the value. (IteratorAssociatedTypesConcept)

Shortcuts

CharIterator | Iterator for CharString.
Dna5Iterator | Iterator for Dna5String.
DnaIterator | Iterator for DnaString.
IupacIterator | Iterator for IupacString.
PeptideIterator | Iterator for Peptide.
Rna5Iterator | Iterator for Rna5String.
RnaIterator | Iterator for RnaString.
UnicodeIterator | Iterator for UnicodeString.

SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2014/10/13 16:12:57