1.1 --- a/lemon/list_graph.h Mon Jun 19 13:44:06 2006 +0000
1.2 +++ b/lemon/list_graph.h Tue Jun 20 15:20:08 2006 +0000
1.3 @@ -316,8 +316,8 @@
1.4
1.5 ///This is a simple and fast erasable graph implementation.
1.6 ///
1.7 - ///It addition that it conforms to the
1.8 - ///\ref concept::ErasableGraph "ErasableGraph" concept,
1.9 + ///It conforms to the
1.10 + ///\ref concept::ErasableGraph "ErasableGraph" concept and
1.11 ///it also provides several additional useful extra functionalities.
1.12 ///\sa concept::ErasableGraph.
1.13
1.14 @@ -330,9 +330,9 @@
1.15
1.16 /// Changes the target of \c e to \c n
1.17 ///
1.18 - ///\note The <tt>Edge</tt>'s and <tt>OutEdge</tt>'s
1.19 + ///\note The <tt>Edge</tt>s and <tt>OutEdge</tt>s
1.20 ///referencing the changed edge remain
1.21 - ///valid. However <tt>InEdge</tt>'s are invalidated.
1.22 + ///valid. However <tt>InEdge</tt>s are invalidated.
1.23 void changeTarget(Edge e, Node n) {
1.24 _changeTarget(e,n);
1.25 }
1.26 @@ -340,27 +340,27 @@
1.27
1.28 /// Changes the source of \c e to \c n
1.29 ///
1.30 - ///\note The <tt>Edge</tt>'s and <tt>InEdge</tt>'s
1.31 + ///\note The <tt>Edge</tt>s and <tt>InEdge</tt>s
1.32 ///referencing the changed edge remain
1.33 - ///valid. However <tt>OutEdge</tt>'s are invalidated.
1.34 + ///valid. However <tt>OutEdge</tt>s are invalidated.
1.35 void changeSource(Edge e, Node n) {
1.36 _changeSource(e,n);
1.37 }
1.38
1.39 /// Invert the direction of an edge.
1.40
1.41 - ///\note The <tt>Edge</tt>'s
1.42 + ///\note The <tt>Edge</tt>s
1.43 ///referencing the changed edge remain
1.44 - ///valid. However <tt>OutEdge</tt>'s and <tt>InEdge</tt>'s are invalidated.
1.45 + ///valid. However <tt>OutEdge</tt>s and <tt>InEdge</tt>s are invalidated.
1.46 void reverseEdge(Edge e) {
1.47 Node t=target(e);
1.48 _changeTarget(e,source(e));
1.49 _changeSource(e,t);
1.50 }
1.51
1.52 - ///Using this it possible to avoid the superfluous memory allocation.
1.53 + ///Using this it is possible to avoid the superfluous memory allocation.
1.54
1.55 - ///Using this it possible to avoid the superfluous memory allocation.
1.56 + ///Using this it is possible to avoid the superfluous memory allocation.
1.57 ///\todo more docs...
1.58 void reserveEdge(int n) { edges.reserve(n); };
1.59
1.60 @@ -369,13 +369,13 @@
1.61 ///This function contracts two nodes.
1.62 ///
1.63 ///Node \p b will be removed but instead of deleting
1.64 - ///its neighboring edges, they will be joined to \p a.
1.65 + ///incident edges, they will be joined to \p a.
1.66 ///The last parameter \p r controls whether to remove loops. \c true
1.67 ///means that loops will be removed.
1.68 ///
1.69 ///\note The <tt>Edge</tt>s
1.70 ///referencing a moved edge remain
1.71 - ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
1.72 + ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
1.73 ///may be invalidated.
1.74 void contract(Node a, Node b, bool r = true)
1.75 {
1.76 @@ -406,7 +406,7 @@
1.77 ///
1.78 ///\note The <tt>Edge</tt>s
1.79 ///referencing a moved edge remain
1.80 - ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
1.81 + ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
1.82 ///may be invalidated.
1.83 ///\warning This functionality cannot be used together with the Snapshot
1.84 ///feature.
1.85 @@ -426,12 +426,12 @@
1.86
1.87 ///Split an edge.
1.88
1.89 - ///This function splits an edge. First a new node \c b is added to the graph,
1.90 - ///then the original edge is re-targetes to \c b. Finally an edge
1.91 - ///from \c b to the original target is added.
1.92 - ///\return The newly created node.
1.93 - ///\warning This functionality cannot be used together with the Snapshot
1.94 - ///feature.
1.95 + ///This function splits an edge. First a new node \c b is added to
1.96 + ///the graph, then the original edge is re-targeted to \c
1.97 + ///b. Finally an edge from \c b to the original target is added.
1.98 + ///\return The newly created node.
1.99 + ///\warning This functionality
1.100 + ///cannot be used together with the Snapshot feature.
1.101 Node split(Edge e)
1.102 {
1.103 Node b = addNode();
1.104 @@ -440,9 +440,9 @@
1.105 return b;
1.106 }
1.107
1.108 - ///Class to make a snapshot of the graph and to restrore to it later.
1.109 + ///Class to make a snapshot of the graph and to restore it later.
1.110
1.111 - ///Class to make a snapshot of the graph and to restrore to it later.
1.112 + ///Class to make a snapshot of the graph and to restore it later.
1.113 ///
1.114 ///The newly added nodes and edges can be removed using the
1.115 ///restore() function.