1.1 --- a/doc/min_cost_flow.dox Fri Nov 13 17:30:26 2009 +0100
1.2 +++ b/doc/min_cost_flow.dox Fri Nov 13 18:10:06 2009 +0100
1.3 @@ -78,7 +78,7 @@
1.4 - if \f$lower(uv)<f(uv)<upper(uv)\f$, then \f$cost^\pi(uv)=0\f$;
1.5 - if \f$cost^\pi(uv)<0\f$, then \f$f(uv)=upper(uv)\f$.
1.6 - For all \f$u\in V\f$ nodes:
1.7 - - \f$\pi(u)<=0\f$;
1.8 + - \f$\pi(u)\leq 0\f$;
1.9 - if \f$\sum_{uv\in A} f(uv) - \sum_{vu\in A} f(vu) \neq sup(u)\f$,
1.10 then \f$\pi(u)=0\f$.
1.11
1.12 @@ -145,7 +145,7 @@
1.13 - if \f$lower(uv)<f(uv)<upper(uv)\f$, then \f$cost^\pi(uv)=0\f$;
1.14 - if \f$cost^\pi(uv)<0\f$, then \f$f(uv)=upper(uv)\f$.
1.15 - For all \f$u\in V\f$ nodes:
1.16 - - \f$\pi(u)>=0\f$;
1.17 + - \f$\pi(u)\geq 0\f$;
1.18 - if \f$\sum_{uv\in A} f(uv) - \sum_{vu\in A} f(vu) \neq sup(u)\f$,
1.19 then \f$\pi(u)=0\f$.
1.20
2.1 --- a/lemon/bellman_ford.h Fri Nov 13 17:30:26 2009 +0100
2.2 +++ b/lemon/bellman_ford.h Fri Nov 13 18:10:06 2009 +0100
2.3 @@ -299,7 +299,7 @@
2.4 ///
2.5 /// \ref named-templ-param "Named parameter" for setting
2.6 /// \c OperationTraits type.
2.7 - /// For more information see \ref BellmanFordDefaultOperationTraits.
2.8 + /// For more information, see \ref BellmanFordDefaultOperationTraits.
2.9 template <class T>
2.10 struct SetOperationTraits
2.11 : public BellmanFord< Digraph, LengthMap, SetOperationTraitsTraits<T> > {
2.12 @@ -717,7 +717,7 @@
2.13 /// is not reached from the root(s) or if \c v is a root.
2.14 ///
2.15 /// The shortest path tree used here is equal to the shortest path
2.16 - /// tree used in \ref predNode() and \predMap().
2.17 + /// tree used in \ref predNode() and \ref predMap().
2.18 ///
2.19 /// \pre Either \ref run() or \ref init() must be called before
2.20 /// using this function.
2.21 @@ -732,7 +732,7 @@
2.22 /// is not reached from the root(s) or if \c v is a root.
2.23 ///
2.24 /// The shortest path tree used here is equal to the shortest path
2.25 - /// tree used in \ref predArc() and \predMap().
2.26 + /// tree used in \ref predArc() and \ref predMap().
2.27 ///
2.28 /// \pre Either \ref run() or \ref init() must be called before
2.29 /// using this function.
3.1 --- a/lemon/bfs.h Fri Nov 13 17:30:26 2009 +0100
3.2 +++ b/lemon/bfs.h Fri Nov 13 18:10:06 2009 +0100
3.3 @@ -63,7 +63,7 @@
3.4
3.5 ///The type of the map that indicates which nodes are processed.
3.6 ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
3.7 - ///By default it is a NullMap.
3.8 + ///By default, it is a NullMap.
3.9 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
3.10 ///Instantiates a \c ProcessedMap.
3.11
3.12 @@ -852,7 +852,7 @@
3.13
3.14 ///The type of the map that indicates which nodes are processed.
3.15 ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
3.16 - ///By default it is a NullMap.
3.17 + ///By default, it is a NullMap.
3.18 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
3.19 ///Instantiates a ProcessedMap.
3.20
4.1 --- a/lemon/circulation.h Fri Nov 13 17:30:26 2009 +0100
4.2 +++ b/lemon/circulation.h Fri Nov 13 18:10:06 2009 +0100
4.3 @@ -306,7 +306,7 @@
4.4 /// The Elevator should have standard constructor interface to be
4.5 /// able to automatically created by the algorithm (i.e. the
4.6 /// digraph and the maximum level should be passed to it).
4.7 - /// However an external elevator object could also be passed to the
4.8 + /// However, an external elevator object could also be passed to the
4.9 /// algorithm with the \ref elevator(Elevator&) "elevator()" function
4.10 /// before calling \ref run() or \ref init().
4.11 /// \sa SetElevator
5.1 --- a/lemon/concepts/digraph.h Fri Nov 13 17:30:26 2009 +0100
5.2 +++ b/lemon/concepts/digraph.h Fri Nov 13 18:10:06 2009 +0100
5.3 @@ -107,7 +107,7 @@
5.4 /// Iterator class for the nodes.
5.5
5.6 /// This iterator goes through each node of the digraph.
5.7 - /// Its usage is quite simple, for example you can count the number
5.8 + /// Its usage is quite simple, for example, you can count the number
5.9 /// of nodes in a digraph \c g of type \c %Digraph like this:
5.10 ///\code
5.11 /// int count=0;
5.12 @@ -196,7 +196,7 @@
5.13
5.14 /// This iterator goes trough the \e outgoing arcs of a certain node
5.15 /// of a digraph.
5.16 - /// Its usage is quite simple, for example you can count the number
5.17 + /// Its usage is quite simple, for example, you can count the number
5.18 /// of outgoing arcs of a node \c n
5.19 /// in a digraph \c g of type \c %Digraph as follows.
5.20 ///\code
5.21 @@ -241,7 +241,7 @@
5.22
5.23 /// This iterator goes trough the \e incoming arcs of a certain node
5.24 /// of a digraph.
5.25 - /// Its usage is quite simple, for example you can count the number
5.26 + /// Its usage is quite simple, for example, you can count the number
5.27 /// of incoming arcs of a node \c n
5.28 /// in a digraph \c g of type \c %Digraph as follows.
5.29 ///\code
5.30 @@ -285,7 +285,7 @@
5.31 /// Iterator class for the arcs.
5.32
5.33 /// This iterator goes through each arc of the digraph.
5.34 - /// Its usage is quite simple, for example you can count the number
5.35 + /// Its usage is quite simple, for example, you can count the number
5.36 /// of arcs in a digraph \c g of type \c %Digraph as follows:
5.37 ///\code
5.38 /// int count=0;
6.1 --- a/lemon/concepts/graph.h Fri Nov 13 17:30:26 2009 +0100
6.2 +++ b/lemon/concepts/graph.h Fri Nov 13 18:10:06 2009 +0100
6.3 @@ -140,7 +140,7 @@
6.4 /// Iterator class for the nodes.
6.5
6.6 /// This iterator goes through each node of the graph.
6.7 - /// Its usage is quite simple, for example you can count the number
6.8 + /// Its usage is quite simple, for example, you can count the number
6.9 /// of nodes in a graph \c g of type \c %Graph like this:
6.10 ///\code
6.11 /// int count=0;
6.12 @@ -228,7 +228,7 @@
6.13 /// Iterator class for the edges.
6.14
6.15 /// This iterator goes through each edge of the graph.
6.16 - /// Its usage is quite simple, for example you can count the number
6.17 + /// Its usage is quite simple, for example, you can count the number
6.18 /// of edges in a graph \c g of type \c %Graph as follows:
6.19 ///\code
6.20 /// int count=0;
6.21 @@ -272,7 +272,7 @@
6.22
6.23 /// This iterator goes trough the incident undirected edges
6.24 /// of a certain node of a graph.
6.25 - /// Its usage is quite simple, for example you can compute the
6.26 + /// Its usage is quite simple, for example, you can compute the
6.27 /// degree (i.e. the number of incident edges) of a node \c n
6.28 /// in a graph \c g of type \c %Graph as follows.
6.29 ///
6.30 @@ -369,7 +369,7 @@
6.31 /// Iterator class for the arcs.
6.32
6.33 /// This iterator goes through each directed arc of the graph.
6.34 - /// Its usage is quite simple, for example you can count the number
6.35 + /// Its usage is quite simple, for example, you can count the number
6.36 /// of arcs in a graph \c g of type \c %Graph as follows:
6.37 ///\code
6.38 /// int count=0;
6.39 @@ -413,7 +413,7 @@
6.40
6.41 /// This iterator goes trough the \e outgoing directed arcs of a
6.42 /// certain node of a graph.
6.43 - /// Its usage is quite simple, for example you can count the number
6.44 + /// Its usage is quite simple, for example, you can count the number
6.45 /// of outgoing arcs of a node \c n
6.46 /// in a graph \c g of type \c %Graph as follows.
6.47 ///\code
6.48 @@ -461,7 +461,7 @@
6.49
6.50 /// This iterator goes trough the \e incoming directed arcs of a
6.51 /// certain node of a graph.
6.52 - /// Its usage is quite simple, for example you can count the number
6.53 + /// Its usage is quite simple, for example, you can count the number
6.54 /// of incoming arcs of a node \c n
6.55 /// in a graph \c g of type \c %Graph as follows.
6.56 ///\code
6.57 @@ -587,7 +587,7 @@
6.58 ///
6.59 /// Returns the first node of the given edge.
6.60 ///
6.61 - /// Edges don't have source and target nodes, however methods
6.62 + /// Edges don't have source and target nodes, however, methods
6.63 /// u() and v() are used to query the two end-nodes of an edge.
6.64 /// The orientation of an edge that arises this way is called
6.65 /// the inherent direction, it is used to define the default
6.66 @@ -600,7 +600,7 @@
6.67 ///
6.68 /// Returns the second node of the given edge.
6.69 ///
6.70 - /// Edges don't have source and target nodes, however methods
6.71 + /// Edges don't have source and target nodes, however, methods
6.72 /// u() and v() are used to query the two end-nodes of an edge.
6.73 /// The orientation of an edge that arises this way is called
6.74 /// the inherent direction, it is used to define the default
7.1 --- a/lemon/concepts/graph_components.h Fri Nov 13 17:30:26 2009 +0100
7.2 +++ b/lemon/concepts/graph_components.h Fri Nov 13 18:10:06 2009 +0100
7.3 @@ -18,7 +18,7 @@
7.4
7.5 ///\ingroup graph_concepts
7.6 ///\file
7.7 -///\brief The concept of graph components.
7.8 +///\brief The concepts of graph components.
7.9
7.10 #ifndef LEMON_CONCEPTS_GRAPH_COMPONENTS_H
7.11 #define LEMON_CONCEPTS_GRAPH_COMPONENTS_H
8.1 --- a/lemon/counter.h Fri Nov 13 17:30:26 2009 +0100
8.2 +++ b/lemon/counter.h Fri Nov 13 18:10:06 2009 +0100
8.3 @@ -212,7 +212,7 @@
8.4
8.5 /// 'Do nothing' version of Counter.
8.6
8.7 - /// This class can be used in the same way as \ref Counter however it
8.8 + /// This class can be used in the same way as \ref Counter, but it
8.9 /// does not count at all and does not print report on destruction.
8.10 ///
8.11 /// Replacing a \ref Counter with a \ref NoCounter makes it possible
9.1 --- a/lemon/dfs.h Fri Nov 13 17:30:26 2009 +0100
9.2 +++ b/lemon/dfs.h Fri Nov 13 18:10:06 2009 +0100
9.3 @@ -63,7 +63,7 @@
9.4
9.5 ///The type of the map that indicates which nodes are processed.
9.6 ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
9.7 - ///By default it is a NullMap.
9.8 + ///By default, it is a NullMap.
9.9 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
9.10 ///Instantiates a \c ProcessedMap.
9.11
9.12 @@ -782,7 +782,7 @@
9.13
9.14 ///The type of the map that indicates which nodes are processed.
9.15 ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
9.16 - ///By default it is a NullMap.
9.17 + ///By default, it is a NullMap.
9.18 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
9.19 ///Instantiates a ProcessedMap.
9.20
10.1 --- a/lemon/dijkstra.h Fri Nov 13 17:30:26 2009 +0100
10.2 +++ b/lemon/dijkstra.h Fri Nov 13 18:10:06 2009 +0100
10.3 @@ -132,7 +132,7 @@
10.4
10.5 ///The type of the map that indicates which nodes are processed.
10.6 ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
10.7 - ///By default it is a NullMap.
10.8 + ///By default, it is a NullMap.
10.9 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
10.10 ///Instantiates a \c ProcessedMap.
10.11
10.12 @@ -426,7 +426,7 @@
10.13 ///automatically created by the algorithm (i.e. the digraph should be
10.14 ///passed to the constructor of the cross reference and the cross
10.15 ///reference should be passed to the constructor of the heap).
10.16 - ///However external heap and cross reference objects could also be
10.17 + ///However, external heap and cross reference objects could also be
10.18 ///passed to the algorithm using the \ref heap() function before
10.19 ///calling \ref run(Node) "run()" or \ref init().
10.20 ///\sa SetHeap
10.21 @@ -447,7 +447,7 @@
10.22 ///
10.23 ///\ref named-templ-param "Named parameter" for setting
10.24 ///\c OperationTraits type.
10.25 - /// For more information see \ref DijkstraDefaultOperationTraits.
10.26 + /// For more information, see \ref DijkstraDefaultOperationTraits.
10.27 template <class T>
10.28 struct SetOperationTraits
10.29 : public Dijkstra<Digraph, LengthMap, SetOperationTraitsTraits<T> > {
10.30 @@ -996,7 +996,7 @@
10.31
10.32 ///The type of the map that indicates which nodes are processed.
10.33 ///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
10.34 - ///By default it is a NullMap.
10.35 + ///By default, it is a NullMap.
10.36 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
10.37 ///Instantiates a ProcessedMap.
10.38
11.1 --- a/lemon/gomory_hu.h Fri Nov 13 17:30:26 2009 +0100
11.2 +++ b/lemon/gomory_hu.h Fri Nov 13 18:10:06 2009 +0100
11.3 @@ -294,11 +294,9 @@
11.4 ///
11.5 /// \pre \ref run() must be called before using this function.
11.6 template <typename CutMap>
11.7 - Value minCutMap(const Node& s, ///<
11.8 + Value minCutMap(const Node& s,
11.9 const Node& t,
11.10 - ///<
11.11 CutMap& cutMap
11.12 - ///<
11.13 ) const {
11.14 Node sn = s, tn = t;
11.15 bool s_root=false;
11.16 @@ -394,7 +392,7 @@
11.17 /// MinCutNodeIt(gomory, t, s, false);
11.18 /// \endcode
11.19 /// does not necessarily give the same set of nodes.
11.20 - /// However it is ensured that
11.21 + /// However, it is ensured that
11.22 /// \code
11.23 /// MinCutNodeIt(gomory, s, t, true);
11.24 /// \endcode
12.1 --- a/lemon/graph_to_eps.h Fri Nov 13 17:30:26 2009 +0100
12.2 +++ b/lemon/graph_to_eps.h Fri Nov 13 18:10:06 2009 +0100
12.3 @@ -142,7 +142,7 @@
12.4 ///Constructor
12.5 ///\param gr Reference to the graph to be printed.
12.6 ///\param ost Reference to the output stream.
12.7 - ///By default it is <tt>std::cout</tt>.
12.8 + ///By default, it is <tt>std::cout</tt>.
12.9 ///\param pros If it is \c true, then the \c ostream referenced by \c os
12.10 ///will be explicitly deallocated by the destructor.
12.11 DefaultGraphToEpsTraits(const GR &gr, std::ostream& ost = std::cout,
12.12 @@ -512,7 +512,7 @@
12.13
12.14 ///Turn on/off pre-scaling
12.15
12.16 - ///By default graphToEps() rescales the whole image in order to avoid
12.17 + ///By default, graphToEps() rescales the whole image in order to avoid
12.18 ///very big or very small bounding boxes.
12.19 ///
12.20 ///This (p)rescaling can be turned off with this function.
12.21 @@ -1114,7 +1114,7 @@
12.22 ///Generates an EPS file from a graph.
12.23 ///\param g Reference to the graph to be printed.
12.24 ///\param os Reference to the output stream.
12.25 -///By default it is <tt>std::cout</tt>.
12.26 +///By default, it is <tt>std::cout</tt>.
12.27 ///
12.28 ///This function also has a lot of
12.29 ///\ref named-templ-func-param "named parameters",
12.30 @@ -1126,7 +1126,7 @@
12.31 /// .arcWidthScale(.4).run();
12.32 ///\endcode
12.33 ///
12.34 -///For more detailed examples see the \ref graph_to_eps_demo.cc demo file.
12.35 +///For more detailed examples, see the \ref graph_to_eps_demo.cc demo file.
12.36 ///
12.37 ///\warning Don't forget to put the \ref GraphToEps::run() "run()"
12.38 ///to the end of the parameter list.
13.1 --- a/lemon/hypercube_graph.h Fri Nov 13 17:30:26 2009 +0100
13.2 +++ b/lemon/hypercube_graph.h Fri Nov 13 18:10:06 2009 +0100
13.3 @@ -287,7 +287,7 @@
13.4 /// Two nodes are connected in the graph if and only if their indices
13.5 /// differ only on one position in the binary form.
13.6 /// This class is completely static and it needs constant memory space.
13.7 - /// Thus you can neither add nor delete nodes or edges, however
13.8 + /// Thus you can neither add nor delete nodes or edges, however,
13.9 /// the structure can be resized using resize().
13.10 ///
13.11 /// This type fully conforms to the \ref concepts::Graph "Graph concept".
14.1 --- a/lemon/lgf_reader.h Fri Nov 13 17:30:26 2009 +0100
14.2 +++ b/lemon/lgf_reader.h Fri Nov 13 18:10:06 2009 +0100
14.3 @@ -427,7 +427,7 @@
14.4 /// run();
14.5 ///\endcode
14.6 ///
14.7 - /// By default the reader uses the first section in the file of the
14.8 + /// By default, the reader uses the first section in the file of the
14.9 /// proper type. If a section has an optional name, then it can be
14.10 /// selected for reading by giving an optional name parameter to the
14.11 /// \c nodes(), \c arcs() or \c attributes() functions.
14.12 @@ -2221,7 +2221,7 @@
14.13 /// and the comment lines are filtered out, and the leading
14.14 /// whitespaces are trimmed from each processed string.
14.15 ///
14.16 - /// For example let's see a section, which contain several
14.17 + /// For example, let's see a section, which contain several
14.18 /// integers, which should be inserted into a vector.
14.19 ///\code
14.20 /// @numbers
15.1 --- a/lemon/list_graph.h Fri Nov 13 17:30:26 2009 +0100
15.2 +++ b/lemon/list_graph.h Fri Nov 13 18:10:06 2009 +0100
15.3 @@ -391,7 +391,7 @@
15.4 /// This function changes the target node of the given arc \c a to \c n.
15.5 ///
15.6 ///\note \c ArcIt and \c OutArcIt iterators referencing the changed
15.7 - ///arc remain valid, however \c InArcIt iterators are invalidated.
15.8 + ///arc remain valid, but \c InArcIt iterators are invalidated.
15.9 ///
15.10 ///\warning This functionality cannot be used together with the Snapshot
15.11 ///feature.
15.12 @@ -403,7 +403,7 @@
15.13 /// This function changes the source node of the given arc \c a to \c n.
15.14 ///
15.15 ///\note \c InArcIt iterators referencing the changed arc remain
15.16 - ///valid, however \c ArcIt and \c OutArcIt iterators are invalidated.
15.17 + ///valid, but \c ArcIt and \c OutArcIt iterators are invalidated.
15.18 ///
15.19 ///\warning This functionality cannot be used together with the Snapshot
15.20 ///feature.
15.21 @@ -549,7 +549,7 @@
15.22 /// \warning Node and arc deletions and other modifications (e.g.
15.23 /// reversing, contracting, splitting arcs or nodes) cannot be
15.24 /// restored. These events invalidate the snapshot.
15.25 - /// However the arcs and nodes that were added to the digraph after
15.26 + /// However, the arcs and nodes that were added to the digraph after
15.27 /// making the current snapshot can be removed without invalidating it.
15.28 class Snapshot {
15.29 protected:
15.30 @@ -1267,7 +1267,7 @@
15.31 /// This function changes the second node of the given edge \c e to \c n.
15.32 ///
15.33 ///\note \c EdgeIt iterators referencing the changed edge remain
15.34 - ///valid, however \c ArcIt iterators referencing the changed edge and
15.35 + ///valid, but \c ArcIt iterators referencing the changed edge and
15.36 ///all other iterators whose base node is the changed node are also
15.37 ///invalidated.
15.38 ///
15.39 @@ -1351,7 +1351,7 @@
15.40 /// \warning Node and edge deletions and other modifications
15.41 /// (e.g. changing the end-nodes of edges or contracting nodes)
15.42 /// cannot be restored. These events invalidate the snapshot.
15.43 - /// However the edges and nodes that were added to the graph after
15.44 + /// However, the edges and nodes that were added to the graph after
15.45 /// making the current snapshot can be removed without invalidating it.
15.46 class Snapshot {
15.47 protected:
16.1 --- a/lemon/lp_base.h Fri Nov 13 17:30:26 2009 +0100
16.2 +++ b/lemon/lp_base.h Fri Nov 13 18:10:06 2009 +0100
16.3 @@ -146,7 +146,7 @@
16.4
16.5 ///Iterator for iterate over the columns of an LP problem
16.6
16.7 - /// Its usage is quite simple, for example you can count the number
16.8 + /// Its usage is quite simple, for example, you can count the number
16.9 /// of columns in an LP \c lp:
16.10 ///\code
16.11 /// int count=0;
16.12 @@ -241,7 +241,7 @@
16.13
16.14 ///Iterator for iterate over the rows of an LP problem
16.15
16.16 - /// Its usage is quite simple, for example you can count the number
16.17 + /// Its usage is quite simple, for example, you can count the number
16.18 /// of rows in an LP \c lp:
16.19 ///\code
16.20 /// int count=0;
17.1 --- a/lemon/maps.h Fri Nov 13 17:30:26 2009 +0100
17.2 +++ b/lemon/maps.h Fri Nov 13 18:10:06 2009 +0100
17.3 @@ -230,10 +230,10 @@
17.4 ///
17.5 /// This map is essentially a wrapper for \c std::vector. It assigns
17.6 /// values to integer keys from the range <tt>[0..size-1]</tt>.
17.7 - /// It can be used with some data structures, for example
17.8 - /// \c UnionFind, \c BinHeap, when the used items are small
17.9 + /// It can be used together with some data structures, e.g.
17.10 + /// heap types and \c UnionFind, when the used items are small
17.11 /// integers. This map conforms to the \ref concepts::ReferenceMap
17.12 - /// "ReferenceMap" concept.
17.13 + /// "ReferenceMap" concept.
17.14 ///
17.15 /// The simplest way of using this map is through the rangeMap()
17.16 /// function.
17.17 @@ -348,9 +348,9 @@
17.18 /// keys (i.e. the map is "sparse").
17.19 /// The name of this type also refers to this important usage.
17.20 ///
17.21 - /// Apart form that this map can be used in many other cases since it
17.22 + /// Apart form that, this map can be used in many other cases since it
17.23 /// is based on \c std::map, which is a general associative container.
17.24 - /// However keep in mind that it is usually not as efficient as other
17.25 + /// However, keep in mind that it is usually not as efficient as other
17.26 /// maps.
17.27 ///
17.28 /// The simplest way of using this map is through the sparseMap()
17.29 @@ -1785,7 +1785,7 @@
17.30 ///
17.31 /// The most important usage of it is storing certain nodes or arcs
17.32 /// that were marked \c true by an algorithm.
17.33 - /// For example it makes easier to store the nodes in the processing
17.34 + /// For example, it makes easier to store the nodes in the processing
17.35 /// order of Dfs algorithm, as the following examples show.
17.36 /// \code
17.37 /// std::vector<Node> v;
17.38 @@ -1800,7 +1800,7 @@
17.39 /// for the elements or the iterator should be an inserter iterator.
17.40 ///
17.41 /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
17.42 - /// it cannot be used when a readable map is needed, for example as
17.43 + /// it cannot be used when a readable map is needed, for example, as
17.44 /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
17.45 ///
17.46 /// \relates LoggerBoolMap
17.47 @@ -1922,7 +1922,7 @@
17.48 /// items with the same value.
17.49 /// Otherwise consider to use \c IterableValueMap, which is more
17.50 /// suitable and more efficient for such cases. It provides iterators
17.51 - /// to traverse the items with the same associated value, however
17.52 + /// to traverse the items with the same associated value, but
17.53 /// it does not have \c InverseMap.
17.54 ///
17.55 /// This type is not reference map, so it cannot be modified with
17.56 @@ -3466,7 +3466,7 @@
17.57 /// \warning Besides \c addNode() and \c addArc(), a digraph structure
17.58 /// may provide alternative ways to modify the digraph.
17.59 /// The correct behavior of InDegMap is not guarantied if these additional
17.60 - /// features are used. For example the functions
17.61 + /// features are used. For example, the functions
17.62 /// \ref ListDigraph::changeSource() "changeSource()",
17.63 /// \ref ListDigraph::changeTarget() "changeTarget()" and
17.64 /// \ref ListDigraph::reverseArc() "reverseArc()"
17.65 @@ -3596,7 +3596,7 @@
17.66 /// \warning Besides \c addNode() and \c addArc(), a digraph structure
17.67 /// may provide alternative ways to modify the digraph.
17.68 /// The correct behavior of OutDegMap is not guarantied if these additional
17.69 - /// features are used. For example the functions
17.70 + /// features are used. For example, the functions
17.71 /// \ref ListDigraph::changeSource() "changeSource()",
17.72 /// \ref ListDigraph::changeTarget() "changeTarget()" and
17.73 /// \ref ListDigraph::reverseArc() "reverseArc()"
18.1 --- a/lemon/network_simplex.h Fri Nov 13 17:30:26 2009 +0100
18.2 +++ b/lemon/network_simplex.h Fri Nov 13 18:10:06 2009 +0100
18.3 @@ -48,7 +48,7 @@
18.4 /// In general this class is the fastest implementation available
18.5 /// in LEMON for the minimum cost flow problem.
18.6 /// Moreover it supports both directions of the supply/demand inequality
18.7 - /// constraints. For more information see \ref SupplyType.
18.8 + /// constraints. For more information, see \ref SupplyType.
18.9 ///
18.10 /// Most of the parameters of the problem (except for the digraph)
18.11 /// can be given using separate functions, and the algorithm can be
18.12 @@ -57,16 +57,16 @@
18.13 ///
18.14 /// \tparam GR The digraph type the algorithm runs on.
18.15 /// \tparam V The value type used for flow amounts, capacity bounds
18.16 - /// and supply values in the algorithm. By default it is \c int.
18.17 + /// and supply values in the algorithm. By default, it is \c int.
18.18 /// \tparam C The value type used for costs and potentials in the
18.19 - /// algorithm. By default it is the same as \c V.
18.20 + /// algorithm. By default, it is the same as \c V.
18.21 ///
18.22 /// \warning Both value types must be signed and all input data must
18.23 /// be integer.
18.24 ///
18.25 /// \note %NetworkSimplex provides five different pivot rule
18.26 /// implementations, from which the most efficient one is used
18.27 - /// by default. For more information see \ref PivotRule.
18.28 + /// by default. For more information, see \ref PivotRule.
18.29 template <typename GR, typename V = int, typename C = V>
18.30 class NetworkSimplex
18.31 {
18.32 @@ -122,35 +122,35 @@
18.33 /// \ref NetworkSimplex provides five different pivot rule
18.34 /// implementations that significantly affect the running time
18.35 /// of the algorithm.
18.36 - /// By default \ref BLOCK_SEARCH "Block Search" is used, which
18.37 + /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
18.38 /// proved to be the most efficient and the most robust on various
18.39 /// test inputs according to our benchmark tests.
18.40 - /// However another pivot rule can be selected using the \ref run()
18.41 + /// However, another pivot rule can be selected using the \ref run()
18.42 /// function with the proper parameter.
18.43 enum PivotRule {
18.44
18.45 - /// The First Eligible pivot rule.
18.46 + /// The \e First \e Eligible pivot rule.
18.47 /// The next eligible arc is selected in a wraparound fashion
18.48 /// in every iteration.
18.49 FIRST_ELIGIBLE,
18.50
18.51 - /// The Best Eligible pivot rule.
18.52 + /// The \e Best \e Eligible pivot rule.
18.53 /// The best eligible arc is selected in every iteration.
18.54 BEST_ELIGIBLE,
18.55
18.56 - /// The Block Search pivot rule.
18.57 + /// The \e Block \e Search pivot rule.
18.58 /// A specified number of arcs are examined in every iteration
18.59 /// in a wraparound fashion and the best eligible arc is selected
18.60 /// from this block.
18.61 BLOCK_SEARCH,
18.62
18.63 - /// The Candidate List pivot rule.
18.64 + /// The \e Candidate \e List pivot rule.
18.65 /// In a major iteration a candidate list is built from eligible arcs
18.66 /// in a wraparound fashion and in the following minor iterations
18.67 /// the best eligible arc is selected from this list.
18.68 CANDIDATE_LIST,
18.69
18.70 - /// The Altering Candidate List pivot rule.
18.71 + /// The \e Altering \e Candidate \e List pivot rule.
18.72 /// It is a modified version of the Candidate List method.
18.73 /// It keeps only the several best eligible arcs from the former
18.74 /// candidate list and extends this list in every iteration.
18.75 @@ -810,7 +810,7 @@
18.76 /// If it is not used before calling \ref run(), the \ref GEQ supply
18.77 /// type will be used.
18.78 ///
18.79 - /// For more information see \ref SupplyType.
18.80 + /// For more information, see \ref SupplyType.
18.81 ///
18.82 /// \return <tt>(*this)</tt>
18.83 NetworkSimplex& supplyType(SupplyType supply_type) {
18.84 @@ -842,11 +842,11 @@
18.85 /// that have been given are kept for the next call, unless
18.86 /// \ref reset() is called, thus only the modified parameters
18.87 /// have to be set again. See \ref reset() for examples.
18.88 - /// However the underlying digraph must not be modified after this
18.89 + /// However, the underlying digraph must not be modified after this
18.90 /// class have been constructed, since it copies and extends the graph.
18.91 ///
18.92 /// \param pivot_rule The pivot rule that will be used during the
18.93 - /// algorithm. For more information see \ref PivotRule.
18.94 + /// algorithm. For more information, see \ref PivotRule.
18.95 ///
18.96 /// \return \c INFEASIBLE if no feasible flow exists,
18.97 /// \n \c OPTIMAL if the problem has optimal solution
18.98 @@ -871,7 +871,7 @@
18.99 /// It is useful for multiple run() calls. If this function is not
18.100 /// used, all the parameters given before are kept for the next
18.101 /// \ref run() call.
18.102 - /// However the underlying digraph must not be modified after this
18.103 + /// However, the underlying digraph must not be modified after this
18.104 /// class have been constructed, since it copies and extends the graph.
18.105 ///
18.106 /// For example,
19.1 --- a/lemon/preflow.h Fri Nov 13 17:30:26 2009 +0100
19.2 +++ b/lemon/preflow.h Fri Nov 13 18:10:06 2009 +0100
19.3 @@ -264,7 +264,7 @@
19.4 /// The Elevator should have standard constructor interface to be
19.5 /// able to automatically created by the algorithm (i.e. the
19.6 /// digraph and the maximum level should be passed to it).
19.7 - /// However an external elevator object could also be passed to the
19.8 + /// However, an external elevator object could also be passed to the
19.9 /// algorithm with the \ref elevator(Elevator&) "elevator()" function
19.10 /// before calling \ref run() or \ref init().
19.11 /// \sa SetElevator
20.1 --- a/lemon/time_measure.h Fri Nov 13 17:30:26 2009 +0100
20.2 +++ b/lemon/time_measure.h Fri Nov 13 18:10:06 2009 +0100
20.3 @@ -375,7 +375,7 @@
20.4
20.5 ///This function returns the number of stop() exections that is
20.6 ///necessary to really stop the timer.
20.7 - ///For example the timer
20.8 + ///For example, the timer
20.9 ///is running if and only if the return value is \c true
20.10 ///(i.e. greater than
20.11 ///zero).
21.1 --- a/lemon/unionfind.h Fri Nov 13 17:30:26 2009 +0100
21.2 +++ b/lemon/unionfind.h Fri Nov 13 18:10:06 2009 +0100
21.3 @@ -43,7 +43,7 @@
21.4 /// the find operation uses path compression.
21.5 /// This is a very simple but efficient implementation, providing
21.6 /// only four methods: join (union), find, insert and size.
21.7 - /// For more features see the \ref UnionFindEnum class.
21.8 + /// For more features, see the \ref UnionFindEnum class.
21.9 ///
21.10 /// It is primarily used in Kruskal algorithm for finding minimal
21.11 /// cost spanning tree in a graph.