Slight changes in doc.
1.1 --- a/lemon/bits/graph_extender.h Mon Jun 19 13:44:06 2006 +0000
1.2 +++ b/lemon/bits/graph_extender.h Tue Jun 20 15:20:08 2006 +0000
1.3 @@ -189,13 +189,13 @@
1.4
1.5 /// \brief Base node of the iterator
1.6 ///
1.7 - /// Returns the base node (ie. the source in this case) of the iterator
1.8 + /// Returns the base node (i.e. the source in this case) of the iterator
1.9 Node baseNode(const OutEdgeIt &e) const {
1.10 return Parent::source(e);
1.11 }
1.12 /// \brief Running node of the iterator
1.13 ///
1.14 - /// Returns the running node (ie. the target in this case) of the
1.15 + /// Returns the running node (i.e. the target in this case) of the
1.16 /// iterator
1.17 Node runningNode(const OutEdgeIt &e) const {
1.18 return Parent::target(e);
1.19 @@ -203,13 +203,13 @@
1.20
1.21 /// \brief Base node of the iterator
1.22 ///
1.23 - /// Returns the base node (ie. the target in this case) of the iterator
1.24 + /// Returns the base node (i.e. the target in this case) of the iterator
1.25 Node baseNode(const InEdgeIt &e) const {
1.26 return Parent::target(e);
1.27 }
1.28 /// \brief Running node of the iterator
1.29 ///
1.30 - /// Returns the running node (ie. the source in this case) of the
1.31 + /// Returns the running node (i.e. the source in this case) of the
1.32 /// iterator
1.33 Node runningNode(const InEdgeIt &e) const {
1.34 return Parent::source(e);
2.1 --- a/lemon/list_graph.h Mon Jun 19 13:44:06 2006 +0000
2.2 +++ b/lemon/list_graph.h Tue Jun 20 15:20:08 2006 +0000
2.3 @@ -316,8 +316,8 @@
2.4
2.5 ///This is a simple and fast erasable graph implementation.
2.6 ///
2.7 - ///It addition that it conforms to the
2.8 - ///\ref concept::ErasableGraph "ErasableGraph" concept,
2.9 + ///It conforms to the
2.10 + ///\ref concept::ErasableGraph "ErasableGraph" concept and
2.11 ///it also provides several additional useful extra functionalities.
2.12 ///\sa concept::ErasableGraph.
2.13
2.14 @@ -330,9 +330,9 @@
2.15
2.16 /// Changes the target of \c e to \c n
2.17 ///
2.18 - ///\note The <tt>Edge</tt>'s and <tt>OutEdge</tt>'s
2.19 + ///\note The <tt>Edge</tt>s and <tt>OutEdge</tt>s
2.20 ///referencing the changed edge remain
2.21 - ///valid. However <tt>InEdge</tt>'s are invalidated.
2.22 + ///valid. However <tt>InEdge</tt>s are invalidated.
2.23 void changeTarget(Edge e, Node n) {
2.24 _changeTarget(e,n);
2.25 }
2.26 @@ -340,27 +340,27 @@
2.27
2.28 /// Changes the source of \c e to \c n
2.29 ///
2.30 - ///\note The <tt>Edge</tt>'s and <tt>InEdge</tt>'s
2.31 + ///\note The <tt>Edge</tt>s and <tt>InEdge</tt>s
2.32 ///referencing the changed edge remain
2.33 - ///valid. However <tt>OutEdge</tt>'s are invalidated.
2.34 + ///valid. However <tt>OutEdge</tt>s are invalidated.
2.35 void changeSource(Edge e, Node n) {
2.36 _changeSource(e,n);
2.37 }
2.38
2.39 /// Invert the direction of an edge.
2.40
2.41 - ///\note The <tt>Edge</tt>'s
2.42 + ///\note The <tt>Edge</tt>s
2.43 ///referencing the changed edge remain
2.44 - ///valid. However <tt>OutEdge</tt>'s and <tt>InEdge</tt>'s are invalidated.
2.45 + ///valid. However <tt>OutEdge</tt>s and <tt>InEdge</tt>s are invalidated.
2.46 void reverseEdge(Edge e) {
2.47 Node t=target(e);
2.48 _changeTarget(e,source(e));
2.49 _changeSource(e,t);
2.50 }
2.51
2.52 - ///Using this it possible to avoid the superfluous memory allocation.
2.53 + ///Using this it is possible to avoid the superfluous memory allocation.
2.54
2.55 - ///Using this it possible to avoid the superfluous memory allocation.
2.56 + ///Using this it is possible to avoid the superfluous memory allocation.
2.57 ///\todo more docs...
2.58 void reserveEdge(int n) { edges.reserve(n); };
2.59
2.60 @@ -369,13 +369,13 @@
2.61 ///This function contracts two nodes.
2.62 ///
2.63 ///Node \p b will be removed but instead of deleting
2.64 - ///its neighboring edges, they will be joined to \p a.
2.65 + ///incident edges, they will be joined to \p a.
2.66 ///The last parameter \p r controls whether to remove loops. \c true
2.67 ///means that loops will be removed.
2.68 ///
2.69 ///\note The <tt>Edge</tt>s
2.70 ///referencing a moved edge remain
2.71 - ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
2.72 + ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
2.73 ///may be invalidated.
2.74 void contract(Node a, Node b, bool r = true)
2.75 {
2.76 @@ -406,7 +406,7 @@
2.77 ///
2.78 ///\note The <tt>Edge</tt>s
2.79 ///referencing a moved edge remain
2.80 - ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
2.81 + ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
2.82 ///may be invalidated.
2.83 ///\warning This functionality cannot be used together with the Snapshot
2.84 ///feature.
2.85 @@ -426,12 +426,12 @@
2.86
2.87 ///Split an edge.
2.88
2.89 - ///This function splits an edge. First a new node \c b is added to the graph,
2.90 - ///then the original edge is re-targetes to \c b. Finally an edge
2.91 - ///from \c b to the original target is added.
2.92 - ///\return The newly created node.
2.93 - ///\warning This functionality cannot be used together with the Snapshot
2.94 - ///feature.
2.95 + ///This function splits an edge. First a new node \c b is added to
2.96 + ///the graph, then the original edge is re-targeted to \c
2.97 + ///b. Finally an edge from \c b to the original target is added.
2.98 + ///\return The newly created node.
2.99 + ///\warning This functionality
2.100 + ///cannot be used together with the Snapshot feature.
2.101 Node split(Edge e)
2.102 {
2.103 Node b = addNode();
2.104 @@ -440,9 +440,9 @@
2.105 return b;
2.106 }
2.107
2.108 - ///Class to make a snapshot of the graph and to restrore to it later.
2.109 + ///Class to make a snapshot of the graph and to restore it later.
2.110
2.111 - ///Class to make a snapshot of the graph and to restrore to it later.
2.112 + ///Class to make a snapshot of the graph and to restore it later.
2.113 ///
2.114 ///The newly added nodes and edges can be removed using the
2.115 ///restore() function.