Concept
RandomAccessIteratorConcept
An iterator allowing random access.

IteratorAssociatedTypesConcept
CopyConstructibleConcept | EqualityComparableConcept

DefaultConstructibleConcept | InputIteratorConcept

ForwardIteratorConcept

BidirectionalIteratorConcept | LessThanComparableConcept

RandomAccessIteratorConcept

RootedRandomAccessIteratorConcept

MutableRootedRandomAccessIteratorConcept

Concept Definition
Refines
LessThanComparableConcept, BidirectionalIteratorConcept
Required Metafunctions

Difference | Type of an object that stores the difference between two iterators.
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

atNil | Tests whether iterator is at nil position.
difference | The difference between two iterators.
goFurther | Iterates some steps further.
goNext | Iterates to next position. (ForwardIteratorConcept)
goNil | Moves iterator to nil position.
goPrevious | Iterates to pevious position. (BidirectionalIteratorConcept)
operator> | C++ built-in greater-than comparison operator.
operator>= | C++ built-in greather-than-or-equal comparison operator.
operator< | C++ built-in less-than comparison operator. (LessThanComparableConcept)
operator<= | C++ built-in less-than-or-equal comparison operator.
operator* | C++ built-in multiplication operator. (InputIteratorConcept)
operator+ | C++ built-in addition operator.
operator++ (prefix) | C++ built-in prefix increment operator. (InputIteratorConcept)
operator++ (suffix) | C++ built-in suffix increment operator. (InputIteratorConcept)
operator+= | C++ built-in addition assignment operator.
operator- | C++ built-in subtraction operator.
operator-> | C++ built-in structure dereference operator. (InputIteratorConcept)
operator-- (prefix) | C++ built-in prefix decrement operator. (BidirectionalIteratorConcept)
operator-- (suffix) | C++ built-in suffix decrement operator. (BidirectionalIteratorConcept)
operator-= | C++ built-in subtraction assignment operator.
operator[] | C++ built-in array subscript operator.

Refinements

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

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

ModifiedIterator | Allows to modify arbitrary iterators by specializing what differs from an origin.

Used By Function
goFurther, goPrevious, value, getValue, goNext, difference
Functions

absFreqOfLettersInSeq | Counts the number of times each residue of a fixed sequence alphabet occurs in a given sequence.
absFreqOfLettersInSetOfSeqs | Counts the number of times each residue of a fixed sequence alphabet occurs in a given set of sequences.
atNil | Tests whether iterator is at nil position.
backgroundFrequency | Determines the background letter frequencies in a given dataset
convertPatternToProfile | Converts a pattern into a profile which consists of a set of frequency distributions.
em | Represents the EM algorithm as used by MEME.
getValue | Access to the value. (IteratorAssociatedTypesConcept)
goNext | Iterates to next position. (ForwardIteratorConcept)
goNil | Moves iterator to nil position.
goPrevious | Iterates to pevious position. (BidirectionalIteratorConcept)
hammingDistance | Determines the Hamming distance between two sequences.
value | Reference to the value. (IteratorAssociatedTypesConcept)

Examples
In the following, x is an iterator to type X, t is a valid rvalue of type X, n is a distance type.
The following expressions must be valid.
x += n // Iterator addition assignment.
x + n // Iterator addition.
n + i // Iterator addition.
x -= n // Iterator subtraction assignment.
x - n // Iterator subtraction.
x - a // Difference.
x[n] // Element operator.
SeqAn - Sequence Analysis Library - www.seqan.de

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