Spec
RightArrayBinaryTree IteratorAn iterator for RightArrayBinaryTree.
An iterator for RightArrayBinaryTree.
Extends | Iter |
---|---|
All Extended | Iter |
All Impl'd | IteratorAssociatedTypesConcept |
Defined in | <seqan/index.h> |
Signature |
template <typename TSpec>
class Iter<TRightArrayBinaryTree, TSpec >;
|
Template Parameters
TSpec |
Specialisation Tag. Types: TopDownIterator |
---|---|
TRightArrayBinaryTree |
The RightArrayBinaryTree. |
Interface Function Overview
-
TContainer container(iterator)
Container of an iterator. -
TChar getCharacter(iterator);
This function returns the pivot character of the node the iterator currently points to. -
unsigned getLeftChildPos(iterator);
Returns the position in RightArrayBinaryTree of the left child node. -
unsigned getPosition(iterator);
Returns the position of the iterator in the host. -
unsigned getLeftChildPos(iterator);
Returns the position in RightArrayBinaryTree of the right child node. -
unsigned getSubTreeSize(iterator);
Returns the number of vertices in the subtree starting at the position an iterator points to. -
bool goDown(iterator);
Iterates down the leftmost edge in a RightArrayBinaryTree. -
bool goLeftChild(iterator);
Sets the iterator to the left child of the current node if it exists and returns true, otherwise the iterator does not change position and the function returns false. -
bool goRight(iterator);
Iterates to the next sibling in a RightArrayBinaryTree. -
bool goRightChild(iterator);
Sets the iterator to the right child of the current node if it exists and returns true, otherwise the iterator does not change position and the function returns false. -
bool goUp(iterator);
Iterates up one edge to the parent in a RightArrayBinaryTree. -
bool isLeaf(iterator);
Tests whether a given node is a leaf or not. -
bool isRoot(iterator);
Test whether a iterator points to the root node. -
void setCharacter(iterator, character);
The function sets the character of the node the iterator points to to character.
Interface Functions Inherited From IteratorAssociatedTypesConcept
Interface Metafunction Overview
Interface Metafunctions Inherited From Iter
Interface Metafunctions Inherited From IteratorAssociatedTypesConcept
Interface Functions Detail
TContainer container(iterator)
Container of an iterator.
Parameters
iterator
|
An iterator. |
---|
Returns
TContainer |
The container that iterator traverses. |
---|
Data Races
Thread safety unknown!
TChar getCharacter(iterator);
This function returns the pivot character of the node the iterator currently points to.
Parameters
iterator
|
The iterator. |
---|
Returns
TChar |
The resulting character. |
---|
Data Races
Thread safety unknown!
unsigned getLeftChildPos(iterator);
Returns the position in RightArrayBinaryTree of the left child node.
Parameters
iterator
|
The iterator. |
---|
Returns
unsigned |
The left child position. |
---|
Data Races
Thread safety unknown!
unsigned getPosition(iterator);
Returns the position of the iterator in the host.
Parameters
iterator
|
The iterator. |
---|
Returns
unsigned |
The position. |
---|
Data Races
Thread safety unknown!
unsigned getLeftChildPos(iterator);
Returns the position in RightArrayBinaryTree of the right child node.
Parameters
iterator
|
The iterator. |
---|
Returns
unsigned |
The left child position. |
---|
Data Races
Thread safety unknown!
unsigned getSubTreeSize(iterator);
Returns the number of vertices in the subtree starting at the position
an iterator points to.
Parameters
iterator
|
The iterator. |
---|
Returns
unsigned |
The subtree size. |
---|
Data Races
Thread safety unknown!
bool goDown(iterator);
Iterates down the leftmost edge in a RightArrayBinaryTree.
Parameters
iterator
|
The iterator |
---|
Returns
bool |
true if an edge to go down exists, otherwise false. |
---|
Data Races
Thread safety unknown!
bool goLeftChild(iterator);
Sets the iterator to the left child of the current node if it exists and returns true, otherwise the
iterator does not change position and the function returns false.
Parameters
iterator
|
The iterator |
---|
Returns
bool |
true if the edge to go down exists, otherwise false. |
---|
Data Races
Thread safety unknown!
bool goRight(iterator);
Iterates to the next sibling in a RightArrayBinaryTree.
Parameters
iterator
|
The iterator |
---|
Returns
bool |
true if the iterator could be moved, otherwise false. |
---|
Data Races
Thread safety unknown!
bool goRightChild(iterator);
Sets the iterator to the right child of the current node if it exists and returns true, otherwise the
iterator does not change position and the function returns false.
Parameters
iterator
|
The iterator. |
---|
Returns
bool |
true if the edge to go down exists, otherwise false. |
---|
Data Races
Thread safety unknown!
bool goUp(iterator);
Iterates up one edge to the parent in a RightArrayBinaryTree.
Parameters
iterator
|
The iterator. |
---|
Returns
bool |
true if the iterator could be moved, otherwise false. |
---|
Data Races
Thread safety unknown!
bool isLeaf(iterator);
Tests whether a given node is a leaf or not.
Parameters
iterator
|
The iterator. |
---|
Returns
bool |
true if the node is a leaf. |
---|
Data Races
Thread safety unknown!
bool isRoot(iterator);
Test whether a iterator points to the root node.
Parameters
iterator
|
The iterator. |
---|
Returns
bool |
true if iterator points to the root of the tree, otherwise false. |
---|
Data Races
Thread safety unknown!
void setCharacter(iterator, character);
The function sets the character of the node the iterator points to to character.
Parameters
iterator
|
The iterator. |
---|---|
character
|
The character to be assigned to a node. |
Data Races
Thread safety unknown!