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

VSTree Iterator

Iterator | TopDown Iterator

TopDownHistory Iterator

Iterator<TContainer, TopDown< ParentLinks<TSpec> > >::Type
Iter<TContainer, VSTree< TopDown< ParentLinks<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. Specifies the depth-first search mode. Types: Postorder, PostorderEmptyEdges, Preorder, PreorderEmptyEdges

Remarks
If not copy-constructed the TopDownHistory Iterator starts in the root node of the suffix tree. Depending on the depth-first search mode the root is not the first DFS node. To go to the first DFS node use goBegin.
Specialization of
TopDown Iterator
Implements
Iterator
Member Functions

Iterator | Constructor (TopDown Iterator)
Iterator | Constructor

Functions

alignment | Returns an alignment of the occurences of the representative substring in the index text. (VSTree Iterator)
assignValue | Assigns value to item. (Iterator)
atBegin | Determines whether an iterator is at the beginning position. (Iterator)
atEnd | Determines whether an iterator is at the end position.
atEnd | Determines whether an iterator is at the end position.
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. (TopDown Iterator)
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)
getValue | Access to the value. (Iterator)
goBegin | Iterates to the first position of a container.
goBegin | Iterates to the first position of a container.
goDown | Iterates down one edge or a path in a tree. (TopDown Iterator)
goEnd | Iterates to the last position of a container.
goEnd | Iterates to the last position of a container.
goFurther | Iterates some steps further. (Iterator)
goNext | Iterates to next position.
goNext | Iterates to next position.
goPrevious | Iterates to pevious position. (Iterator)
goRight | Iterates to the next sibling in a tree. (TopDown Iterator)
goRoot | Move iterator to the root node. (TopDown Iterator)
goUp | Iterates up one edge to the parent in a tree.
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)
lca | Returns the last common ancestor of two tree nodes.
lca | Returns the last common ancestor of two tree nodes.
lca | Returns the last common ancestor of two tree nodes.
lcp | Returns the length of the longest-common-prefix of two suffix tree nodes.
lcp | Returns the length of the longest-common-prefix of two suffix tree nodes.
moveValue | Assigns value to item. (Iterator)
nodeDepth | Returns the zero-based node depth of the iterator node.
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. (TopDown Iterator)
parentEdgeFirstChar | Returns the first character of the edge from an iterator node to its parent.
parentEdgeLabel | Returns a substring representing the edge from an iterator node to its parent.
parentEdgeLength | Returns the length of the edge from the iterator node to its parent.
parentRepLength | Returns the length of the substring representing the path from root to iterator's parent node. (TopDown Iterator)
position | Position of an iterator. (Iterator)
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)
value | Reference to the value. (VSTree Iterator)

Example Programs
Constraint Iterator
SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2012/03/14 16:34:52