Iterator on the arcs of a graph. More...
#include <tpl_graph.H>
Public Types | |
| using | Item_Type = Arc * |
| using | Set_Type = Node * |
| The type of data of set. | |
 Public Types inherited from Aleph::Dlink::Iterator | |
| using | Set_Type = Dlink |
| The set type. | |
| using | Item_Type = Dlink * |
| The type of elements of container. | |
Public Member Functions | |
| Node_Arc_Iterator ()=default | |
| The container type (a node) | |
| Node_Arc_Iterator (Node *src) noexcept | |
| Constructs an iterator on the node src. | |
| Arc_Node * | get_current_arc_node () const |
| Arc_Node * | get_current_arc_node_ne () const noexcept |
| Arc * | get_curr () const |
| Arc * | get_curr_ne () const noexcept |
| Arc * | get_current_arc () const |
| Return the current arc. | |
| Arc * | get_current_arc_ne () const noexcept |
| Node * | get_tgt_node () const |
| Return the connected node to source node (src passed in construction time) through the current arc. | |
| Node * | get_tgt_node_ne () const noexcept |
| Node * | get_node () const |
| Node * | get_node_ne () const noexcept |
| Public Member Functions inherited from Aleph::Dlink::Iterator | |
| Iterator (Dlink *head_ptr) noexcept | |
Initialize an iterator on the first item of the list pointed by head_ptr. | |
| Iterator (const Dlink &list) noexcept | |
Initialize an iterator on the first item of list. | |
| void | set (Dlink *new_curr) noexcept |
| Set the current node . | |
| Iterator () noexcept | |
| void | reset_first () noexcept |
| Reset the iterator to the first item of list. | |
| void | reset_last () noexcept |
| Reset the iterator to the last item of list. | |
| void | end () noexcept |
| Put the iterator out of range. | |
| bool | has_curr () const noexcept |
Return true if the iterator has current item. | |
| bool | is_last () const noexcept |
| Dlink * | get_curr_ne () const noexcept |
| Return the current link guaranteeing no exception. Be careful. | |
| Dlink * | get_curr () const |
| Return the current node of iterator. | |
| constexpr bool | is_in_first () const noexcept |
Return true if the iterator is positiones on the first item. | |
| bool | is_in_last () const noexcept |
Return true if the iterator is positiones on the last item. | |
| void | prev_ne () noexcept |
| Move the iterator one position backward guaranteeing no exception. | |
| void | prev () |
| Move the iterator one position backward. | |
| void | next_ne () noexcept |
| Move the iterator one position backward guaranteeing no exception. | |
| void | next () |
| Move the iterator one position forward. | |
| constexpr bool | operator== (const Iterator &it) const noexcept |
Return true if this and it are positioned on the same item. | |
| constexpr bool | operator!= (const Iterator &it) const noexcept |
Return true if this and it hace different states. | |
| Dlink * | del () |
| Remove from the list the current node and move the iterator one position forward. | |
| Dlink * | del_ne () noexcept |
| constexpr bool | verify (Dlink *l) const noexcept |
Return true if the iterator is on the list pointed by l | |
| constexpr bool | verify (const Iterator &it) const noexcept |
Return true if this and it are on the same list. | |
Private Attributes | |
| Node * | src_node |
Detailed Description
class Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator
Iterator on the arcs of a graph.
This iterator scans all the arcs related to a node.
If the graph is not directed. then all the related nodes will be seen, independently of specified order when the arc was inserted. Use get_connected_node() for obtaining the target node given a source node and arc.
If you are using List_Graph as a directed graph, then this iterator has not much sense. Use Out_Iterator or In_Iterator in order to iterate on the outcoming or incoming arcs of a node.
If the graph is directed, then only the arcs specified as target (second parameter in the insert_arc() method) will be seen.
- See also
- In_Iterator Out_Iterator
Definition at line 829 of file tpl_graph.H.
Member Typedef Documentation
◆ Item_Type
| using Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::Item_Type = Arc * |
Definition at line 834 of file tpl_graph.H.
◆ Set_Type
| using Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::Set_Type = Node * |
The type of data of set.
Definition at line 836 of file tpl_graph.H.
Constructor & Destructor Documentation
◆ Node_Arc_Iterator() [1/2]
|
default |
The container type (a node)
◆ Node_Arc_Iterator() [2/2]
|
inlinenoexcept |
Constructs an iterator on the node src.
- Parameters
-
[in] src the node over whom you wish to iterate.
Definition at line 844 of file tpl_graph.H.
Member Function Documentation
◆ get_curr()
|
inline |
Definition at line 861 of file tpl_graph.H.
References Aleph::Arc_Node::arc, and Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_current_arc_node().
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_current_arc().
◆ get_curr_ne()
|
inlinenoexcept |
Definition at line 867 of file tpl_graph.H.
References Aleph::Arc_Node::arc, and Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_current_arc_node_ne().
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_current_arc_ne().
◆ get_current_arc()
|
inline |
Return the current arc.
Throw overflow_error is there is no current arc
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 874 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_curr().
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_tgt_node().
◆ get_current_arc_ne()
|
inlinenoexcept |
Definition at line 879 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_curr_ne().
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_tgt_node_ne().
◆ get_current_arc_node()
|
inline |
Definition at line 850 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::dlink_to_arc_node(), and Aleph::Dlink::Iterator::get_curr().
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_curr().
◆ get_current_arc_node_ne()
|
inlinenoexcept |
Definition at line 855 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::dlink_to_arc_node(), and Aleph::Dlink::Iterator::get_curr_ne().
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_curr_ne().
◆ get_node()
|
inline |
Definition at line 897 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_tgt_node().
◆ get_node_ne()
|
inlinenoexcept |
Definition at line 902 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_tgt_node_ne().
◆ get_tgt_node()
|
inline |
Return the connected node to source node (src passed in construction time) through the current arc.
Throw overflow_error is there is no current
Definition at line 887 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_current_arc(), and Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::src_node.
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_node().
◆ get_tgt_node_ne()
|
inlinenoexcept |
Definition at line 892 of file tpl_graph.H.
References Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_current_arc_ne(), and Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::src_node.
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_node_ne().
Member Data Documentation
◆ src_node
|
private |
Definition at line 831 of file tpl_graph.H.
Referenced by Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_tgt_node(), and Aleph::List_Graph< _Graph_Node, _Graph_Arc >::Node_Arc_Iterator::get_tgt_node_ne().
The documentation for this class was generated from the following file:
