Aleph::In_Iterator< GT, SA > Class Template Reference

Filtered iterator for incoming arcs of a node. More...

#include <tpl_graph.H>

Inheritance diagram for Aleph::In_Iterator< GT, SA >:

Collaboration diagram for Aleph::In_Iterator< GT, SA >:

Public Types
using	Item_Type = typename GT::Arc *
Public Types inherited from Aleph::Digraph_Iterator< GT, __In_Filt< GT > >
using	Item_Type = typename Itor::Item_Type
using	Iterator_Type = Itor
	The type of element.

Public Member Functions
	In_Iterator ()=default
	In_Iterator (typename GT::Node *p, SA sa=SA())
void	next ()
void	next_ne () noexcept
Public Member Functions inherited from Aleph::Digraph_Iterator< GT, __In_Filt< GT > >
	Digraph_Iterator (typename GT::Node *p)
	Iterator type.
void	next ()
	Move the iterator one position forward.
void	next_ne () noexcept
void	prev ()
	Move the iterator one position backward.
bool	has_curr () const noexcept
	Return true the iterator has an current arc.
GT::Arc *	get_curr () const
	Return the current arc.
GT::Arc *	get_curr_ne () const noexcept
	Return the current arc.
auto	get_current_arc () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Alias for get_curr().
GT::Node *	get_node (typename GT::Arc *a) const noexcept
	Return the connected node to arc.
GT::Node *	get_node () const
	Return the connected node to current arc.
auto	get_tgt_node () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Alias for get_node().
GT::Node *	get_node_ne () const noexcept
	Return the connected node to current arc.
auto	get_tgt_node_ne () const noexcept
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Alias for get_node_ne().
void	reset_first () noexcept
	Reset the iterator to the first arc.
void	reset_last () noexcept
	Reset the iterator to the last arc.
void	end () noexcept
	Put the iterator in end state.

Private Types
using	Base = Digraph_Iterator< GT, __In_Filt< GT > >

Private Member Functions
void	goto_first_valid ()

Private Attributes
SA	show_arc

Detailed Description

template<class GT, class SA = Dft_Show_Arc<GT>>
class Aleph::In_Iterator< GT, SA >

Filtered iterator for incoming arcs of a node.

This iterator traverses the incoming arcs of a node, optionally filtered by the Show_Arc predicate.

Template Parameters

GT	The graph type
SA	Arc filter predicate (default shows all arcs)

Definition at line 1794 of file tpl_graph.H.

Member Typedef Documentation

Base

template<class GT , class SA = Dft_Show_Arc<GT>>

using Aleph::In_Iterator< GT, SA >::Base = Digraph_Iterator<GT, __In_Filt<GT> >

private

Definition at line 1796 of file tpl_graph.H.

Item_Type

template<class GT , class SA = Dft_Show_Arc<GT>>

using Aleph::In_Iterator< GT, SA >::Item_Type = typename GT::Arc *

Definition at line 1806 of file tpl_graph.H.

Constructor & Destructor Documentation

In_Iterator() [1/2]

template<class GT , class SA = Dft_Show_Arc<GT>>

Aleph::In_Iterator< GT, SA >::In_Iterator ( )

default

In_Iterator() [2/2]

template<class GT , class SA = Dft_Show_Arc<GT>>

Aleph::In_Iterator< GT, SA >::In_Iterator ( typename GT::Node *  p, SA  sa = SA()  )

inline

Definition at line 1810 of file tpl_graph.H.

References Aleph::In_Iterator< GT, SA >::goto_first_valid().

Member Function Documentation

goto_first_valid()

template<class GT , class SA = Dft_Show_Arc<GT>>

void Aleph::In_Iterator< GT, SA >::goto_first_valid ( )

inlineprivate

Definition at line 1799 of file tpl_graph.H.

References Aleph::Digraph_Iterator< GT, __In_Filt< GT > >::get_curr_ne(), Aleph::Digraph_Iterator< GT, __In_Filt< GT > >::has_curr(), Aleph::maps(), Aleph::Digraph_Iterator< GT, __In_Filt< GT > >::next_ne(), and Aleph::In_Iterator< GT, SA >::show_arc.

Referenced by Aleph::In_Iterator< GT, SA >::In_Iterator(), Aleph::In_Iterator< GT, SA >::next(), and Aleph::In_Iterator< GT, SA >::next_ne().

next()

template<class GT , class SA = Dft_Show_Arc<GT>>

void Aleph::In_Iterator< GT, SA >::next ( )

inline

Definition at line 1816 of file tpl_graph.H.

References Aleph::In_Iterator< GT, SA >::goto_first_valid(), and Aleph::Digraph_Iterator< GT, __In_Filt< GT > >::next().

next_ne()

template<class GT , class SA = Dft_Show_Arc<GT>>

void Aleph::In_Iterator< GT, SA >::next_ne ( )

inlinenoexcept

Definition at line 1822 of file tpl_graph.H.

References Aleph::In_Iterator< GT, SA >::goto_first_valid(), and Aleph::Digraph_Iterator< GT, __In_Filt< GT > >::next_ne().

Member Data Documentation

show_arc

template<class GT , class SA = Dft_Show_Arc<GT>>

SA Aleph::In_Iterator< GT, SA >::show_arc

private

Definition at line 1797 of file tpl_graph.H.

Referenced by Aleph::In_Iterator< GT, SA >::goto_first_valid().

---

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

• tpl_graph.H