tree_breadth_first_iterator

class tree_breadth_first_iterator #( type T = int ) extends iterator#( T )

Provides a breadth-first iterator to a tree.

T	optional The type of data collected in a tree. The default is int.

Summary

tree_breadth_first_iterator	Provides a breadth-first iterator to a tree.
Types
tree_node_type	The shorthand of the tree_node type specialized with type T.
tree_type	The shorthand of the tree type specialized with type T.
new	Creates a tree iterator.
has_next	virtual Returns 1 if the iterator has more elements.
next	virtual Returns the next element.
next_node	virtual Returns the next tree_node.
remove	virtual Removes the last element returned by the iterator.

typedef tree_node#( T ) tree_node_type

The shorthand of the tree_node type specialized with type T.

typedef tree#( T ) tree_type

The shorthand of the tree type specialized with type T.

function new( tree_type t )

Creates a tree iterator.

t	A tree to be iterated.

virtual function bit has_next()

virtual Returns 1 if the iterator has more elements.

If the iterator has more elements, returns 1. Otherwise, returns 0.

virtual function T next()

virtual Returns the next element.

The next element in the iterator.

virtual function tree_node_type next_node()

virtual Returns the next tree_node.

The next tree node in the tree.

virtual function void remove()

virtual Removes the last element returned by the iterator. This function can be called once per call to next or next_node.

None.