Inorder iterator on the nodes of a binary tree. More...

#include <tpl_binNodeUtils.H>

Inheritance diagram for Aleph::BinNodeInfixIterator< Node >:

Collaboration diagram for Aleph::BinNodeInfixIterator< Node >:

Public Member Functions
bool	is_in_first () const noexcept
	Return `true` if the iterator is on the first node.

bool	is_last () const noexcept

void	swap (BinNodeInfixIterator &it) noexcept

	BinNodeInfixIterator ()=default

	BinNodeInfixIterator (Node *r) noexcept
	Initialize an iterator on the first node inorder.

	BinNodeInfixIterator (const BinNodeInfixIterator &it)

	BinNodeInfixIterator (BinNodeInfixIterator &&it) noexcept

void	reset_first () noexcept
	Reset the iterator to the first node inorder.

void	reset_last () noexcept
	Reset the iterator to the first node inorder.

void	end () noexcept

BinNodeInfixIterator &	operator= (const BinNodeInfixIterator &it)

BinNodeInfixIterator &	operator= (BinNodeInfixIterator &&it) noexcept

bool	has_curr () const noexcept
	Return `true` the iterator has current node.

Node *	get_curr_ne () const noexcept
	Return the current link guaranteeing no exception. Be careful.

Node *	get_curr () const
	Return the current node. Throw `overflow_error` if there is no current.

size_t	get_pos () const
	Return the current position of iterator. Only valid if has_curr() == true.

void	next_ne () noexcept

void	next ()
	Move the iterator one position forward.

Private Member Functions
Node *	advance_to_min (Node *r) noexcept

void	init () noexcept

Static Private Member Functions
static Node *	advance_to_max (Node *r) noexcept

Private Attributes
Node *	root = Node::NullPtr

Node *	curr = Node::NullPtr

long	pos = 0

ArrayStack< Node * >	s

Detailed Description

template<class Node>
class Aleph::BinNodeInfixIterator< Node >

Inorder iterator on the nodes of a binary tree.

This class export a full iterator for the nodes of a binary tree where the visit order corresponds to a inorder sense.

Definition at line 2683 of file tpl_binNodeUtils.H.

Constructor & Destructor Documentation

◆ BinNodeInfixIterator() [1/4]

template<class Node >

Aleph::BinNodeInfixIterator< Node >::BinNodeInfixIterator ( )

default

◆ BinNodeInfixIterator() [2/4]

template<class Node >

Aleph::BinNodeInfixIterator< Node >::BinNodeInfixIterator ( Node * r )

inlinenoexcept

Initialize an iterator on the first node inorder.

Definition at line 2738 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::init().

◆ BinNodeInfixIterator() [3/4]

template<class Node >

Aleph::BinNodeInfixIterator< Node >::BinNodeInfixIterator ( const BinNodeInfixIterator< Node > & it )

inline

Definition at line 2744 of file tpl_binNodeUtils.H.

◆ BinNodeInfixIterator() [4/4]

template<class Node >

Aleph::BinNodeInfixIterator< Node >::BinNodeInfixIterator ( BinNodeInfixIterator< Node > && it )

inlinenoexcept

Definition at line 2750 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::swap().

Member Function Documentation

◆ advance_to_max()

template<class Node >

static Node * Aleph::BinNodeInfixIterator< Node >::advance_to_max ( Node * r )

inlinestaticprivatenoexcept

Definition at line 2700 of file tpl_binNodeUtils.H.

References r, and RLINK.

Referenced by Aleph::BinNodeInfixIterator< Node >::reset_last().

◆ advance_to_min()

template<class Node >

Node * Aleph::BinNodeInfixIterator< Node >::advance_to_min ( Node * r )

inlineprivatenoexcept

Definition at line 2690 of file tpl_binNodeUtils.H.

References LLINK, Aleph::ArrayStack< T >::push(), r, and Aleph::BinNodeInfixIterator< Node >::s.

Referenced by Aleph::BinNodeInfixIterator< Node >::init(), and Aleph::BinNodeInfixIterator< Node >::next_ne().

◆ end()

template<class Node >

void Aleph::BinNodeInfixIterator< Node >::end ( )

inlinenoexcept

Definition at line 2774 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::curr, Aleph::ArrayStack< T >::empty(), Aleph::BinNodeInfixIterator< Node >::pos, and Aleph::BinNodeInfixIterator< Node >::s.

Referenced by Aleph::DynIntervalTree< T, Compare >::Iterator::end().

◆ get_curr()

template<class Node >

Node * Aleph::BinNodeInfixIterator< Node >::get_curr ( ) const

inline

Return the current node. Throw overflow_error if there is no current.

Definition at line 2807 of file tpl_binNodeUtils.H.

References ah_overflow_error_if, Aleph::BinNodeInfixIterator< Node >::curr, Aleph::divide_and_conquer_partition_dp(), and Aleph::BinNodeInfixIterator< Node >::has_curr().

Referenced by Aleph::DynIntervalTree< T, Compare >::Iterator::get_curr().

◆ get_curr_ne()

template<class Node >

Node * Aleph::BinNodeInfixIterator< Node >::get_curr_ne ( ) const

inlinenoexcept

Return the current link guaranteeing no exception. Be careful.

Definition at line 2804 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::curr.

Referenced by Aleph::DynIntervalTree< T, Compare >::Iterator::get_curr_ne(), and TEST().

◆ get_pos()

template<class Node >

size_t Aleph::BinNodeInfixIterator< Node >::get_pos ( ) const

inline

Return the current position of iterator. Only valid if has_curr() == true.

Definition at line 2814 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::pos.

Referenced by Aleph::DynIntervalTree< T, Compare >::Iterator::get_pos().

◆ has_curr()

template<class Node >

bool Aleph::BinNodeInfixIterator< Node >::has_curr ( ) const

inlinenoexcept

Return true the iterator has current node.

Definition at line 2801 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::curr.

Referenced by Aleph::BinNodeInfixIterator< Node >::get_curr(), Aleph::DynIntervalTree< T, Compare >::Iterator::has_curr(), Aleph::infix_for_each(), Aleph::infix_traverse(), Aleph::BinNodeInfixIterator< Node >::next(), and TEST().

◆ init()

template<class Node >

void Aleph::BinNodeInfixIterator< Node >::init ( )

inlineprivatenoexcept

Definition at line 2708 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::advance_to_min(), Aleph::BinNodeInfixIterator< Node >::curr, Aleph::BinNodeInfixIterator< Node >::pos, and Aleph::BinNodeInfixIterator< Node >::root.

Referenced by Aleph::BinNodeInfixIterator< Node >::BinNodeInfixIterator(), and Aleph::BinNodeInfixIterator< Node >::reset_first().

◆ is_in_first()

template<class Node >

bool Aleph::BinNodeInfixIterator< Node >::is_in_first ( ) const

inlinenoexcept

Return true if the iterator is on the first node.

Definition at line 2717 of file tpl_binNodeUtils.H.

References Aleph::and, Aleph::BinNodeInfixIterator< Node >::curr, Aleph::ArrayStack< T >::is_empty(), LLINK, and Aleph::BinNodeInfixIterator< Node >::s.

◆ is_last()

template<class Node >

bool Aleph::BinNodeInfixIterator< Node >::is_last ( ) const

inlinenoexcept

Definition at line 2722 of file tpl_binNodeUtils.H.

References Aleph::and, Aleph::BinNodeInfixIterator< Node >::curr, Aleph::ArrayStack< T >::is_empty(), RLINK, and Aleph::BinNodeInfixIterator< Node >::s.

◆ next()

template<class Node >

void Aleph::BinNodeInfixIterator< Node >::next ( )

inline

Move the iterator one position forward.

Throw overflow_error if there is no current

Definition at line 2834 of file tpl_binNodeUtils.H.

References ah_overflow_error_if, Aleph::divide_and_conquer_partition_dp(), Aleph::BinNodeInfixIterator< Node >::has_curr(), and Aleph::BinNodeInfixIterator< Node >::next_ne().

Referenced by Aleph::DynIntervalTree< T, Compare >::Iterator::next().

◆ next_ne()

template<class Node >

void Aleph::BinNodeInfixIterator< Node >::next_ne ( )

inlinenoexcept

Definition at line 2816 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::advance_to_min(), Aleph::BinNodeInfixIterator< Node >::curr, Aleph::ArrayStack< T >::is_empty(), Aleph::ArrayStack< T >::pop(), Aleph::BinNodeInfixIterator< Node >::pos, RLINK, and Aleph::BinNodeInfixIterator< Node >::s.

Referenced by Aleph::BinNodeInfixIterator< Node >::next(), Aleph::DynIntervalTree< T, Compare >::Iterator::next_ne(), and TEST().

◆ operator=() [1/2]

template<class Node >

BinNodeInfixIterator & Aleph::BinNodeInfixIterator< Node >::operator= ( BinNodeInfixIterator< Node > && it )

inlinenoexcept

Definition at line 2793 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::swap().

◆ operator=() [2/2]

template<class Node >

BinNodeInfixIterator & Aleph::BinNodeInfixIterator< Node >::operator= ( const BinNodeInfixIterator< Node > & it )

inline

Definition at line 2781 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::curr, Aleph::BinNodeInfixIterator< Node >::pos, Aleph::BinNodeInfixIterator< Node >::root, and Aleph::BinNodeInfixIterator< Node >::s.

◆ reset_first()

template<class Node >

void Aleph::BinNodeInfixIterator< Node >::reset_first ( )

inlinenoexcept

Reset the iterator to the first node inorder.

Definition at line 2753 of file tpl_binNodeUtils.H.

References Aleph::ArrayStack< T >::empty(), Aleph::BinNodeInfixIterator< Node >::init(), and Aleph::BinNodeInfixIterator< Node >::s.

Referenced by Aleph::DynIntervalTree< T, Compare >::Iterator::reset_first().

◆ reset_last()

template<class Node >

void Aleph::BinNodeInfixIterator< Node >::reset_last ( )

inlinenoexcept

Reset the iterator to the first node inorder.

Definition at line 2760 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::advance_to_max(), Aleph::BinNodeInfixIterator< Node >::curr, Aleph::ArrayStack< T >::empty(), Aleph::BinNodeInfixIterator< Node >::pos, Aleph::BinNodeInfixIterator< Node >::root, Aleph::BinNodeInfixIterator< Node >::s, and Aleph::size().

◆ swap()

template<class Node >

void Aleph::BinNodeInfixIterator< Node >::swap ( BinNodeInfixIterator< Node > & it )

inlinenoexcept

Definition at line 2727 of file tpl_binNodeUtils.H.

References Aleph::BinNodeInfixIterator< Node >::curr, Aleph::BinNodeInfixIterator< Node >::pos, Aleph::BinNodeInfixIterator< Node >::root, Aleph::BinNodeInfixIterator< Node >::s, and Aleph::ArrayStack< T >::swap().

Referenced by Aleph::BinNodeInfixIterator< Node >::BinNodeInfixIterator(), and Aleph::BinNodeInfixIterator< Node >::operator=().

Member Data Documentation

◆ curr

template<class Node >

Node* Aleph::BinNodeInfixIterator< Node >::curr = Node::NullPtr

private

Definition at line 2686 of file tpl_binNodeUtils.H.

◆ pos

template<class Node >

long Aleph::BinNodeInfixIterator< Node >::pos = 0

private

Definition at line 2687 of file tpl_binNodeUtils.H.

Referenced by Aleph::BinNodeInfixIterator< Node >::end(), Aleph::BinNodeInfixIterator< Node >::get_pos(), Aleph::BinNodeInfixIterator< Node >::init(), Aleph::BinNodeInfixIterator< Node >::next_ne(), Aleph::BinNodeInfixIterator< Node >::operator=(), Aleph::BinNodeInfixIterator< Node >::reset_last(), and Aleph::BinNodeInfixIterator< Node >::swap().

◆ root

template<class Node >

Node* Aleph::BinNodeInfixIterator< Node >::root = Node::NullPtr

mutableprivate

Definition at line 2685 of file tpl_binNodeUtils.H.

Referenced by Aleph::BinNodeInfixIterator< Node >::init(), Aleph::BinNodeInfixIterator< Node >::operator=(), Aleph::BinNodeInfixIterator< Node >::reset_last(), and Aleph::BinNodeInfixIterator< Node >::swap().

◆ s

template<class Node >

ArrayStack<Node *> Aleph::BinNodeInfixIterator< Node >::s

private

Definition at line 2688 of file tpl_binNodeUtils.H.

Referenced by Aleph::BinNodeInfixIterator< Node >::advance_to_min(), Aleph::BinNodeInfixIterator< Node >::end(), Aleph::BinNodeInfixIterator< Node >::is_in_first(), Aleph::BinNodeInfixIterator< Node >::is_last(), Aleph::BinNodeInfixIterator< Node >::next_ne(), Aleph::BinNodeInfixIterator< Node >::operator=(), Aleph::BinNodeInfixIterator< Node >::reset_first(), Aleph::BinNodeInfixIterator< Node >::reset_last(), and Aleph::BinNodeInfixIterator< Node >::swap().

The documentation for this class was generated from the following file:

tpl_binNodeUtils.H

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BinNodeInfixIterator() [1/4]

◆ BinNodeInfixIterator() [2/4]

◆ BinNodeInfixIterator() [3/4]

◆ BinNodeInfixIterator() [4/4]

Member Function Documentation

◆ advance_to_max()

◆ advance_to_min()

◆ end()

◆ get_curr()

◆ get_curr_ne()

◆ get_pos()

◆ has_curr()

◆ init()

◆ is_in_first()

◆ is_last()

◆ next()

◆ next_ne()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reset_first()

◆ reset_last()

◆ swap()

Member Data Documentation

◆ curr

◆ pos

◆ root

◆ s