1.1 --- a/doc/graph_orientation.dox Fri Feb 03 14:22:45 2006 +0000
1.2 +++ b/doc/graph_orientation.dox Fri Feb 03 15:58:24 2006 +0000
1.3 @@ -63,7 +63,7 @@
1.4 \skip main
1.5 \until {
1.6
1.7 -First we check whether the program is called with exactly 1 parameter.
1.8 +First we check whether the program is called with exactly one parameter.
1.9 If it isn't, we print a short help message end exit.
1.10 The vast majority of people would probably skip this block.
1.11 \skip if
1.12 @@ -71,7 +71,8 @@
1.13
1.14 Now, we read a graph \c g, and a map \c f containing
1.15 the in-deg requirements from a \ref graph-io-page ".lgf (Lemon Graph Format)"
1.16 -file. To generate the output picture, we also read the node titles (\c id) and
1.17 +file. To generate the output picture, we also read the node titles (\c label)
1.18 +and
1.19 coordinates (\c coords).
1.20 So, first we create the graph
1.21 \skipline ListGraph
1.22 @@ -86,8 +87,9 @@
1.23 \until }
1.24 \until }
1.25
1.26 -The algorithm needs a "level" integer value assigned to each node. In the
1.27 -beginning, the nodes are on level 0.
1.28 +The algorithm needs an integer value assigned to each node. We call this "level" and the nodes are on level 0 at the
1.29 +beginning of the execution.
1.30 +
1.31 \skipline level
1.32
1.33 The deficiency (\c def) of a node is the in-degree requirement minus the
1.34 @@ -101,9 +103,10 @@
1.35 \skip active
1.36 \until def
1.37
1.38 -We also store in a bool map indicating which edges are reverted. Actually this is only
1.39 +We also store in a bool map indicating which edges are reverted.
1.40 +Actually this map called \c rev is only
1.41 used to draw these edges with different color in the output picture. The
1.42 -algorithm will update this map called \c rev, but will not use it otherwise.
1.43 +algorithm updates this map, but will not use it otherwise.
1.44 \skip rev
1.45 \until reversed
1.46
1.47 @@ -111,7 +114,8 @@
1.48 \skipline nodeNum
1.49
1.50 Here comes the algorithms itself.
1.51 -In each iteration we choose an active node (\c act will store it). If there is
1.52 +In each iteration we choose an active node (\c act will do it for us).
1.53 +If there is
1.54 no such a node, then the orientation is feasible so we are done.
1.55 \skip act
1.56 \until while
2.1 --- a/lemon/fredman_tarjan.h Fri Feb 03 14:22:45 2006 +0000
2.2 +++ b/lemon/fredman_tarjan.h Fri Feb 03 15:58:24 2006 +0000
2.3 @@ -456,10 +456,10 @@
2.4
2.5 ///Sets the TreeMap of the edges of the minimum spanning tree.
2.6 ///The map values belonging to the edges of the minimum
2.7 - ///spanning tree are set to \param tree_edge_value or \c true by default
2.8 + ///spanning tree are set to \c tree_edge_value or \c true by default
2.9 ///while the edge values not belonging to the minimum spanning tree are
2.10 ///set to
2.11 - ///\param tree_default_value or \c false by default.
2.12 + ///\c tree_default_value or \c false by default.
2.13 ///
2.14 ///\pre \ref run() or \ref start() must be called before using this
2.15 ///function.
3.1 --- a/lemon/iterable_maps.h Fri Feb 03 14:22:45 2006 +0000
3.2 +++ b/lemon/iterable_maps.h Fri Feb 03 15:58:24 2006 +0000
3.3 @@ -199,7 +199,7 @@
3.4 ///
3.5 /// Creates an iterator. It iterates on the
3.6 /// keys which mapped to true.
3.7 - /// \param map The IterableIntMap
3.8 + /// \param _map The IterableIntMap
3.9 TrueIt(const IterableBoolMap& _map)
3.10 : Parent(_map.sep > 0 ? _map.array[_map.sep - 1] : INVALID),
3.11 map(&_map) {}
3.12 @@ -239,7 +239,7 @@
3.13 ///
3.14 /// Creates an iterator. It iterates on the
3.15 /// keys which mapped to false.
3.16 - /// \param map The IterableIntMap
3.17 + /// \param _map The IterableIntMap
3.18 FalseIt(const IterableBoolMap& _map)
3.19 : Parent(_map.sep < (int)_map.array.size() ?
3.20 _map.array.back() : INVALID), map(&_map) {}
3.21 @@ -278,7 +278,7 @@
3.22 ///
3.23 /// Creates an iterator. It iterates on the
3.24 /// keys which mapped to false.
3.25 - /// \param map The IterableIntMap
3.26 + /// \param _map The IterableIntMap
3.27 /// \param value Which elements should be iterated.
3.28 ItemIt(const IterableBoolMap& _map, bool value)
3.29 : Parent(value ? (_map.sep > 0 ? _map.array[_map.sep - 1] : INVALID) :
4.1 --- a/lemon/johnson.h Fri Feb 03 14:22:45 2006 +0000
4.2 +++ b/lemon/johnson.h Fri Feb 03 15:58:24 2006 +0000
4.3 @@ -151,7 +151,7 @@
4.4 /// \brief Instantiates a PredMap.
4.5 ///
4.6 /// This function instantiates a \ref PredMap.
4.7 - /// \param G is the graph, to which we would like to define the PredMap.
4.8 + /// \param graph is the graph, to which we would like to define the PredMap.
4.9 /// \todo The graph alone may be insufficient for the initialization
4.10 static PredMap *createPredMap(const Graph& graph) {
4.11 return new PredMap(graph);
4.12 @@ -167,7 +167,7 @@
4.13 /// \brief Instantiates a DistMap.
4.14 ///
4.15 /// This function instantiates a \ref DistMap.
4.16 - /// \param G is the graph, to which we would like to define the
4.17 + /// \param graph is the graph, to which we would like to define the
4.18 /// \ref DistMap
4.19 static DistMap *createDistMap(const _Graph& graph) {
4.20 return new DistMap(graph);
5.1 --- a/lemon/preflow.h Fri Feb 03 14:22:45 2006 +0000
5.2 +++ b/lemon/preflow.h Fri Feb 03 15:58:24 2006 +0000
5.3 @@ -152,6 +152,7 @@
5.4 ///\param _t The target node.
5.5 ///\param _cap The capacity of the edges.
5.6 ///\param _f The flow of the edges.
5.7 + ///\param tol Tolerance class.
5.8 ///Except the graph, all of these parameters can be reset by
5.9 ///calling \ref source, \ref target, \ref capacityMap and \ref
5.10 ///flowMap, resp.
6.1 --- a/lemon/prim.h Fri Feb 03 14:22:45 2006 +0000
6.2 +++ b/lemon/prim.h Fri Feb 03 15:58:24 2006 +0000
6.3 @@ -56,7 +56,7 @@
6.4 ///Instantiates a HeapCrossRef.
6.5
6.6 ///This function instantiates a \ref HeapCrossRef.
6.7 - /// \param G is the graph, to which we would like to define the
6.8 + /// \param _graph is the graph, to which we would like to define the
6.9 /// HeapCrossRef.
6.10 static HeapCrossRef *createHeapCrossRef(const GR &_graph){
6.11 return new HeapCrossRef(_graph);
6.12 @@ -86,7 +86,7 @@
6.13 ///Instantiates a PredMap.
6.14
6.15 ///This function instantiates a \ref PredMap.
6.16 - ///\param G is the graph, to which we would like to define the PredMap.
6.17 + ///\param _graph is the graph, to which we would like to define the PredMap.
6.18 static PredMap *createPredMap(const GR &_graph){
6.19 return new PredMap(_graph);
6.20 }
6.21 @@ -101,7 +101,8 @@
6.22 ///Instantiates a TreeMap.
6.23
6.24 ///This function instantiates a \ref TreeMap.
6.25 - ///\param g is the graph, to which
6.26 + ///
6.27 + ///The first parameter is the graph, to which
6.28 ///we would like to define the \ref TreeMap
6.29 static TreeMap *createTreeMap(const GR &){
6.30 return new TreeMap();
6.31 @@ -116,7 +117,7 @@
6.32 ///Instantiates a ProcessedMap.
6.33
6.34 ///This function instantiates a \ref ProcessedMap.
6.35 - ///\param g is the graph, to which
6.36 + ///\param _graph is the graph, to which
6.37 ///we would like to define the \ref ProcessedMap
6.38 #ifdef DOXYGEN
6.39 static ProcessedMap *createProcessedMap(const GR &_graph)
6.40 @@ -703,7 +704,7 @@
6.41
6.42 ///Sets the TreeMap of the edges of the minimum spanning tree.
6.43 ///The map values belonging to the edges of the minimum
6.44 - ///spanning tree are set to \param tree_edge_value or \c true by default,
6.45 + ///spanning tree are set to \c tree_edge_value or \c true by default,
6.46 ///the other map values remain untouched.
6.47 ///
6.48 ///\pre \ref run() or \ref start() must be called before using this function.
6.49 @@ -721,9 +722,9 @@
6.50
6.51 ///Sets the TreeMap of the edges of the minimum spanning tree.
6.52 ///The map values belonging to the edges of the minimum
6.53 - ///spanning tree are set to \param tree_edge_value or \c true by default while
6.54 + ///spanning tree are set to \c tree_edge_value or \c true by default while
6.55 ///the edge values not belonging to the minimum spanning tree are set to
6.56 - ///\param tree_default_value or \c false by default.
6.57 + ///\c tree_default_value or \c false by default.
6.58 ///
6.59 ///\pre \ref run() or \ref start() must be called before using this function.
6.60
7.1 --- a/lemon/time_measure.h Fri Feb 03 14:22:45 2006 +0000
7.2 +++ b/lemon/time_measure.h Fri Feb 03 15:58:24 2006 +0000
7.3 @@ -272,7 +272,7 @@
7.4 public:
7.5 ///Constructor.
7.6
7.7 - ///\param _running indicates whether or not the timer starts immediately.
7.8 + ///\param run indicates whether or not the timer starts immediately.
7.9 ///
7.10 Timer(bool run=true) :_running(run) {_reset();}
7.11
8.1 --- a/lemon/tolerance.h Fri Feb 03 14:22:45 2006 +0000
8.2 +++ b/lemon/tolerance.h Fri Feb 03 15:58:24 2006 +0000
8.3 @@ -39,7 +39,7 @@
8.4 ///as a result of a probably inexact computation.
8.5 ///
8.6 ///This is an abstract class, it should be specialized for all numerical
8.7 - ///data types. These specialized classes like \ref Tolerance<double>
8.8 + ///data types. These specialized classes like \ref Tolerance\<double\>
8.9 ///may offer additional tuning parameters.
8.10 ///
8.11 ///\sa Tolerance<float>