Class Specialization
TopDownHistory Iterator
String tree iterator that can go down, right, and up. Supports depth-first search.
| |||||||||||||||||||||||||||||||||||
![]() | ![]() | ||||||||||||||||||||||||||||||||||
TopDownHistory Iterator | |||||||||||||||||||||||||||||||||||
Include Headers
seqan/index.h
Parameters
Type of the container that can be iterated. Metafunctions: Container | |
The specialization type. Specifies the depth-first search mode. |
Remarks
If not copy-constructed the TopDownHistory Iterator starts in the root node of the string 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
Metafunctions
| Type of the container given an iterator. (Iter) | |
| Type of an object that stores the difference between two iterators. (Iter) | |
| Type for reading values. (Iter) | |
| Type of iterator objects that are used to traverse the container. (Iter) | |
| Type of an object that represents a position in a container. (Iter) | |
| Reference type. (Iter) | |
| The spec of a class. (Iter) | |
| Type of the items in the container or behind an iterator. (Iter) |
Member Functions
| Constructor (TopDown Iterator) |
Functions
| Returns an alignment of the occurrences of the representative substring in the index text. (VSTree Iterator) | |
| Assigns value to item. (Iter) | |
| Determines whether an iterator is at the beginning position. (Iter) | |
| Determines whether an iterator is at the end position. | |
| Returns true if the iterator is at the end of a sequence. (Iter) | |
| Returns an iterator pointing to the root node of the virtual string tree/trie of an index. The only exception are Postorder iterators, where begin returns an iterator pointing to the leftmost node in the tree/trie. (VSTree Iterator) | |
| Test whether iterator points to a node with only leaf-children. (VSTree Iterator) | |
| Container of an iterator. (VSTree Iterator) | |
| Count the number of children of a tree node. (VSTree Iterator) | |
| Returns the number of occurrences of representative substring or a q-gram in the index text. (VSTree Iterator) | |
| The difference between two iterators. (Iter) | |
| Returns | |
| Returns the number of sequences, which contain the representative as a substring. (VSTree Iterator) | |
| Returns an occurrence of the representative substring or a q-gram in the index text. (VSTree Iterator) | |
| Returns all occurrences of the representative substring or a q-gram in the index text. (VSTree Iterator) | |
| Returns the characters left beside all occurrence of the representative substring in the index text. (VSTree Iterator) | |
| Access to the value. (Iter) | |
| Iterates to the first position of a container. | |
| Iterates down one edge or a path in a tree. (TopDown Iterator) | |
| Iterates to the last position of a container. | |
| Iterates some steps further. (Iter) | |
| Iterates to next position. | |
| Iterates to pevious position. (Iter) | |
| Iterates to the next sibling in a tree. (TopDown Iterator) | |
| Move iterator to the root node. (TopDown Iterator) | |
| Iterates up one edge to the parent in a tree. | |
| Test whether a tree iterator points to a leaf. (VSTree Iterator) | |
| Test whether the occurrences of an iterator's representative mutually differ in the character left of the hits. (VSTree Iterator) | |
| Test whether the characters left of the two occurrences of representative are equal. (VSTree Iterator) | |
| Test whether iterator points to a suffix. (VSTree Iterator) | |
| Test whether a tree iterator points to the root node. (VSTree Iterator) | |
| Test whether the representative occurs only once in every sequence. (VSTree Iterator) | |
| Returns the last common ancestor of two tree nodes. | |
| Returns the length of the longest-common-prefix of two suffix tree nodes. | |
| Assigns value to item. (Iter) | |
| Returns the zero-based node depth of the | |
| If | |
| If | |
| Returns the vertex descriptor of the parent node. (TopDown Iterator) | |
| Returns the first character of the edge from an | |
| Returns a substring representing the edge from an | |
| Returns the length of the edge from the | |
| Returns the length of the substring representing the path from root to | |
| Position of an iterator. (Iter) | |
| Returns the suffix array interval borders of occurrences of representative substring or a q-gram in the index text. (VSTree Iterator) | |
| Returns the length of the substring representing the path from root to | |
| Returns a substring representing the path from root to | |
| Reference to the value. (VSTree Iterator) |
Example Programs
SeqAn - Sequence Analysis Library - www.seqan.de
