atBegin

Function

atBegin

Determines whether an iterator is at the beginning position.

bool atBegin(iterator [, container])

Include Headers

seqan/basic.h, seqan/graph_types.h

Parameters

iterator	An iterator. Types: RootedIteratorConcept: AnnotationTree Iterator Adjacency Iterator, Bfs Iterator, Dfs Preorder Iterator, Edge Iterator, Iter, Out-Edge Iterator, Segment, Vertex Iterator
container	Container of iterator. (optional) Remarks: If iterator implements RootedIteratorConcept then container is optional otherwise container is required.

Return Values

true if iterator points to the fist item of the container, otherwise false.

Member of

Example Programs

Part of Concept