Concept BidirectionalIteratorConcept
Iterator that can be both incremented and decremented.

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

Detailed Description

The SeqAn iterators mirror the definitions from ConceptC++.

Examples

In the following, x is an iterator to type X.

The following expressions must be valid.

--x  // Predecrement.
x--  // Postdecrement.

Member Function Overview

Member Functions Inherited From EqualityComparableConcept

Interface Function Overview

Interface Functions Inherited From InputIteratorConcept

Interface Functions Inherited From IteratorAssociatedTypesConcept

Interface Metafunction Overview

Interface Metafunctions Inherited From IteratorAssociatedTypesConcept

Interface Functions Detail

void goPrevious(it);

Iterates to pevious position.

Parameters

it Iterator to move to previous position.

This function is equivalent to --iterator.

Data Races

Thread safety unknown!

TIterator operator--(it);

C++ built-in prefix decrement operator.

Parameters

it The iterator to increment.

Returns

TIterator Reference to the incremented iterator.

Data Races

Thread safety unknown!

TIterator operator--(it, i);

C++ built-in suffix decrement operator.

Parameters

it The iterator to increment.
i An int value to mark the operator as suffix decrement.

Returns

TIterator Reference to the incremented iterator.

Data Races

Thread safety unknown!