lemon/list_graph.h
changeset 834 c2230649a493
parent 788 10c9c3a35b83
child 835 c92296660262
     1.1 --- a/lemon/list_graph.h	Thu Nov 05 15:50:01 2009 +0100
     1.2 +++ b/lemon/list_graph.h	Sun Nov 15 19:57:02 2009 +0100
     1.3 @@ -324,6 +324,8 @@
     1.4    ///Most of its member functions and nested classes are documented
     1.5    ///only in the concept class.
     1.6    ///
     1.7 +  ///This class provides only linear time counting for nodes and arcs.
     1.8 +  ///
     1.9    ///\sa concepts::Digraph
    1.10    ///\sa ListGraph
    1.11    class ListDigraph : public ExtendedListDigraphBase {
    1.12 @@ -360,12 +362,19 @@
    1.13  
    1.14      ///\brief Erase a node from the digraph.
    1.15      ///
    1.16 -    ///This function erases the given node from the digraph.
    1.17 +    ///This function erases the given node along with its outgoing and
    1.18 +    ///incoming arcs from the digraph.
    1.19 +    ///
    1.20 +    ///\note All iterators referencing the removed node or the connected
    1.21 +    ///arcs are invalidated, of course.
    1.22      void erase(Node n) { Parent::erase(n); }
    1.23  
    1.24      ///\brief Erase an arc from the digraph.
    1.25      ///
    1.26      ///This function erases the given arc from the digraph.
    1.27 +    ///
    1.28 +    ///\note All iterators referencing the removed arc are invalidated,
    1.29 +    ///of course.
    1.30      void erase(Arc a) { Parent::erase(a); }
    1.31  
    1.32      /// Node validity check
    1.33 @@ -510,6 +519,7 @@
    1.34  
    1.35      ///This function erases all nodes and arcs from the digraph.
    1.36      ///
    1.37 +    ///\note All iterators of the digraph are invalidated, of course.
    1.38      void clear() {
    1.39        Parent::clear();
    1.40      }
    1.41 @@ -1179,6 +1189,8 @@
    1.42    ///Most of its member functions and nested classes are documented
    1.43    ///only in the concept class.
    1.44    ///
    1.45 +  ///This class provides only linear time counting for nodes, edges and arcs.
    1.46 +  ///
    1.47    ///\sa concepts::Graph
    1.48    ///\sa ListDigraph
    1.49    class ListGraph : public ExtendedListGraphBase {
    1.50 @@ -1217,12 +1229,19 @@
    1.51  
    1.52      ///\brief Erase a node from the graph.
    1.53      ///
    1.54 -    /// This function erases the given node from the graph.
    1.55 +    /// This function erases the given node along with its incident arcs
    1.56 +    /// from the graph.
    1.57 +    ///
    1.58 +    /// \note All iterators referencing the removed node or the incident
    1.59 +    /// edges are invalidated, of course.
    1.60      void erase(Node n) { Parent::erase(n); }
    1.61  
    1.62      ///\brief Erase an edge from the graph.
    1.63      ///
    1.64      /// This function erases the given edge from the graph.
    1.65 +    ///
    1.66 +    /// \note All iterators referencing the removed edge are invalidated,
    1.67 +    /// of course.
    1.68      void erase(Edge e) { Parent::erase(e); }
    1.69      /// Node validity check
    1.70  
    1.71 @@ -1312,6 +1331,7 @@
    1.72  
    1.73      ///This function erases all nodes and arcs from the graph.
    1.74      ///
    1.75 +    ///\note All iterators of the graph are invalidated, of course.
    1.76      void clear() {
    1.77        Parent::clear();
    1.78      }