end

Function

end

The end of a container.

Iterator end(object [, tag])

Include Headers

seqan/sequence.h

Parameters

object	A container. Types: ContainerConcept: Gaps, ModifiedString, String AlignCols, char array, CompressedSA, Finder, FragmentStore, FrequencyDistribution, Index, MaxRepeats Iterator, RightArrayBinaryTree, SeedSet, SeedSet, std::basic_string, std::list, std::vector, StringEnumerator, StringSet
tag	An iterator spec tag that specifies the kind of the iterator returned. (optional) Default: Given by DefaultGetIteratorSpec.

Remarks

If the container does not contain any items at all, the function may return 0.

Return Values

An iterator that points behind the last item in object. The type is the result of Iterator<TContainer, TTag>::Type where TContainer is the type of object and TTag is the type of tag.

Metafunctions: Iterator

Member of

Index, String, FrequencyDistribution, Map, std::basic_string, std::vector, MaxRepeats Iterator, StringEnumerator, Gaps, std::list, char array, RightArrayBinaryTree Iterator, CompressedSA, StringSet, Finder

Example Programs

Iterator Basics, Rooted Iterators

Part of Concept

ContainerConcept, Container