TopDown Iterator

Class Specialization

TopDown Iterator

Iterator for suffix trees that can go down and right beginning from the root.



VSTree Iterator

TopDown Iterator

TopDownHistory Iterator

Iterator<TContainer, TopDown<TSpec> >::Type

Iter<TContainer, VSTree< TopDown<TSpec> > >

Include Headers

seqan/index.h

Parameters

TContainer	Type of the container that can be iterated. Metafunctions: Container Types: IndexDfi, IndexEsa, IndexWotd
TSpec	The specialization type.

Remarks

If not copy-constructed the TopDown Iterator starts in the root node of the suffix tree.

Specialization of

VSTree Iterator

Specializations

TopDownHistory Iterator

Iterator for suffix trees that can go down, right, and up. Supports depth-first search.

Member Functions

Iterator

Constructor

Functions

alignment	Returns an alignment of the occurences of the representative substring in the index text. (VSTree Iterator)
childrenAreLeaves	Test whether iterator points to a node with only leaf-children. (VSTree Iterator)
container	Container of an iterator. (VSTree Iterator)
countChildren	Count the number of children of a tree node. (VSTree Iterator)
countOccurrences	Returns the number of occurences of representative substring or a q-gram in the index text. (VSTree Iterator)
emptyParentEdge	Returns true iff the edge label from the iterator node to its parent is empty.
getFrequency	Returns the number of sequences, which contain the representative as a substring. (VSTree Iterator)
getOccurrence	Returns an occurence of the representative substring or a q-gram in the index text. (VSTree Iterator)
getOccurrences	Returns all occurences of the representative substring or a q-gram in the index text. (VSTree Iterator)
getOccurrencesBwt	Returns the characters left beside all occurence of the representative substring in the index text. (VSTree Iterator)
goDown	Iterates down one edge or a path in a tree.
goRight	Iterates to the next sibling in a tree.
goRoot	Move iterator to the root node.
isLeaf	Test whether iterator points to a leaf. (VSTree Iterator)
isLeftMaximal	Test whether the occurences of an iterator's representative mutually differ in the character left of the hits. (VSTree Iterator)
isPartiallyLeftExtensible	Test whether the characters left of the two occurences of representative are equal. (VSTree Iterator)
isRightTerminal	Test whether iterator points to a suffix. (VSTree Iterator)
isRoot	Test whether iterator points to the root node. (VSTree Iterator)
isUnique	Test whether the representative occurs only once in every sequence. (VSTree Iterator)
nodeHullPredicate	If false this node and its subtree is concealed. (VSTree Iterator)
nodePredicate	If false this node will be skipped during the bottom-up traversal. (VSTree Iterator)
nodeUp	Returns the vertex descriptor of the parent node.
parentRepLength	Returns the length of the substring representing the path from root to iterator's parent node.
range	Returns the suffix array interval borders of occurences of representative substring or a q-gram in the index text. (VSTree Iterator)
repLength	Returns the length of the substring representing the path from root to iterator node. (VSTree Iterator)
representative	Returns a substring representing the path from root to iterator node. (VSTree Iterator)
value	Reference to the value. (VSTree Iterator)

SeqAn - Sequence Analysis Library - www.seqan.de