Concept OutputIteratorConcept
Iterator that allows dereferenced writing.

Extends CopyConstructibleConcept, IteratorAssociatedTypesConcept
All Extended CopyConstructibleConcept, IteratorAssociatedTypesConcept
All Subcl's MutableForwardIteratorConcept, MutableRootedIteratorConcept
Defined in <seqan/basic.h>
Signature OutputIteratorConcept<T>

Detailed Description

The SeqAn iterators mirror the definitions from ConceptC++. *

Examples

In the following, x is an iterator to type X, t is a valid rvalue of type X.

The following expressions must be valid.

*x = t     // Dereference assignment.
++x        // Preincrement.
(void)x++  // Postincrement.
*x++ = t   // Postincrement and assign.

assignValue(x, t);

See Also

Interface Function Overview

Interface Functions Inherited From IteratorAssociatedTypesConcept

Interface Metafunction Overview

Interface Metafunctions Inherited From IteratorAssociatedTypesConcept

Interface Functions Detail

void assignValue(it, value);

Deprecated.

Use dereferencement and assignment instead.

Assigns value to iterator.

Parameters

it The iterator to assign value to.
value A value that is assigned to the item it points to.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void goNext(it);

Iterates to next position.

Parameters

it The iterator to increment.

This function is equivalent to ++iterator.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void moveValue(container, pos, value);

Move a value of a container to a given position.

Parameters

container The container to manipulate.
pos The position of the item in the container to manipulate.
value The value to move to container[pos].

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TIterator operator++(it)

C++ built-in prefix increment operator.

Parameters

it The iterator to increment.

Returns

TIterator A copy of the original iterator.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TIterator operator++(it, i)

C++ built-in suffix increment operator.

Parameters

it The iterator to increment.
i An integer, used to mark suffix decrement.

Returns

TIterator A copy of the original iterator.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void writeValue(iter, val);

Write a single value to a container by dereferencing its iterator.

Parameters

iter The iterator to use for dereferenced writing.
val The value to write into the container.

If the host of iter is a ContainerConcept then container is resized to make space for the item.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.