Changeset 1953:d4f411003580 in lemon-0.x

Timestamp:

02/03/06 16:58:24 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2528

Message:

Polish the doc.

Files:

• doc/graph_orientation.dox (modified) (5 diffs)
• lemon/fredman_tarjan.h (modified) (1 diff)
• lemon/iterable_maps.h (modified) (3 diffs)
• lemon/johnson.h (modified) (2 diffs)
• lemon/preflow.h (modified) (1 diff)
• lemon/prim.h (modified) (6 diffs)
• lemon/time_measure.h (modified) (1 diff)
• lemon/tolerance.h (modified) (1 diff)

doc/graph_orientation.dox

@@ -64 +64 @@
 \until {
 
-First we check whether the program is called with exactly 1 parameter.
+First we check whether the program is called with exactly one parameter.
 If it isn't, we print a short help message end exit.
 The vast majority of people would probably skip this block.
@@ -72 +72 @@
 Now, we read a graph \c g, and a map \c f containing
 the in-deg requirements from a \ref graph-io-page ".lgf (Lemon Graph Format)"
-file. To generate the output picture, we also read the node titles (\c id) and
+file. To generate the output picture, we also read the node titles (\c label)
+and
 coordinates (\c coords).
 So, first we create the graph
@@ -87 +88 @@
 \until }
 
-The algorithm needs a "level" integer value assigned to each node. In the
-beginning, the nodes are on level 0.
+The algorithm needs an integer value assigned to each node. We call this "level" and the nodes are on level 0 at the
+beginning of the execution.
+
 \skipline level
 
@@ -102 +104 @@
 \until def
 
-We also store in a bool map indicating which edges are reverted. Actually this is only
+We also store in a bool map indicating which edges are reverted.
+Actually this map called \c rev is only
 used to draw these edges with different color in the output picture. The
-algorithm will update this map called \c rev, but will not use it otherwise.
+algorithm updates this map, but will not use it otherwise.
 \skip rev
 \until reversed
@@ -112 +115 @@
 
 Here comes the algorithms itself. 
-In each iteration we choose an active node (\c act will store it). If there is
+In each iteration we choose an active node (\c act will do it for us).
+If there is
 no such a node, then the orientation is feasible so we are done.
 \skip act

lemon/fredman_tarjan.h

@@ -457 +457 @@
     ///Sets the TreeMap of the edges of the minimum spanning tree.
     ///The map values belonging to the edges of the minimum
-    ///spanning tree are set to \param tree_edge_value or \c true by default 
+    ///spanning tree are set to \c tree_edge_value or \c true by default 
     ///while the edge values not belonging to the minimum spanning tree are 
     ///set to
-    ///\param tree_default_value or \c false by default.
+    ///\c tree_default_value or \c false by default.
     ///
     ///\pre \ref run() or \ref start() must be called before using this 

lemon/iterable_maps.h

@@ -200 +200 @@
       /// Creates an iterator. It iterates on the 
       /// keys which mapped to true.
-      /// \param map The IterableIntMap
+      /// \param _map The IterableIntMap
       TrueIt(const IterableBoolMap& _map) 
         : Parent(_map.sep > 0 ? _map.array[_map.sep - 1] : INVALID), 
@@ -240 +240 @@
       /// Creates an iterator. It iterates on the 
       /// keys which mapped to false.
-      /// \param map The IterableIntMap
+      /// \param _map The IterableIntMap
       FalseIt(const IterableBoolMap& _map) 
         : Parent(_map.sep < (int)_map.array.size() ? 
@@ -279 +279 @@
       /// Creates an iterator. It iterates on the 
       /// keys which mapped to false.
-      /// \param map The IterableIntMap
+      /// \param _map The IterableIntMap
       /// \param value Which elements should be iterated.
       ItemIt(const IterableBoolMap& _map, bool value) 

lemon/johnson.h

@@ -152 +152 @@
     /// 
     /// This function instantiates a \ref PredMap. 
-    /// \param G is the graph, to which we would like to define the PredMap.
+    /// \param graph is the graph, to which we would like to define the PredMap.
     /// \todo The graph alone may be insufficient for the initialization
     static PredMap *createPredMap(const Graph& graph) {
@@ -168 +168 @@
     ///
     /// This function instantiates a \ref DistMap. 
-    /// \param G is the graph, to which we would like to define the 
+    /// \param graph is the graph, to which we would like to define the 
     /// \ref DistMap
     static DistMap *createDistMap(const _Graph& graph) {

lemon/preflow.h

@@ -153 +153 @@
     ///\param _cap The capacity of the edges. 
     ///\param _f The flow of the edges. 
+    ///\param tol Tolerance class.
     ///Except the graph, all of these parameters can be reset by
     ///calling \ref source, \ref target, \ref capacityMap and \ref

lemon/prim.h

@@ -57 +57 @@
 
     ///This function instantiates a \ref HeapCrossRef. 
-    /// \param G is the graph, to which we would like to define the 
+    /// \param _graph is the graph, to which we would like to define the 
     /// HeapCrossRef.
     static HeapCrossRef *createHeapCrossRef(const GR &_graph){
@@ -87 +87 @@
  
     ///This function instantiates a \ref PredMap. 
-    ///\param G is the graph, to which we would like to define the PredMap.
+    ///\param _graph is the graph, to which we would like to define the PredMap.
     static PredMap *createPredMap(const GR &_graph){
       return new PredMap(_graph);
@@ -102 +102 @@
 
     ///This function instantiates a \ref TreeMap.
-    ///\param g is the graph, to which
+    ///
+    ///The first parameter is the graph, to which
     ///we would like to define the \ref TreeMap
     static TreeMap *createTreeMap(const GR &){
@@ -117 +118 @@
  
     ///This function instantiates a \ref ProcessedMap. 
-    ///\param g is the graph, to which
+    ///\param _graph is the graph, to which
     ///we would like to define the \ref ProcessedMap
 #ifdef DOXYGEN
@@ -704 +705 @@
     ///Sets the TreeMap of the edges of the minimum spanning tree.
     ///The map values belonging to the edges of the minimum
-    ///spanning tree are set to \param tree_edge_value or \c true by default,
+    ///spanning tree are set to \c tree_edge_value or \c true by default,
     ///the other map values remain untouched.
     ///
@@ -722 +723 @@
     ///Sets the TreeMap of the edges of the minimum spanning tree.
     ///The map values belonging to the edges of the minimum
-    ///spanning tree are set to \param tree_edge_value or \c true by default while
+    ///spanning tree are set to \c tree_edge_value or \c true by default while
     ///the edge values not belonging to the minimum spanning tree are set to
-    ///\param tree_default_value or \c false by default.
+    ///\c tree_default_value or \c false by default.
     ///
     ///\pre \ref run() or \ref start() must be called before using this function.

lemon/time_measure.h

@@ -273 +273 @@
     ///Constructor.
 
-    ///\param _running indicates whether or not the timer starts immediately.
+    ///\param run indicates whether or not the timer starts immediately.
     ///
     Timer(bool run=true) :_running(run) {_reset();}

lemon/tolerance.h

@@ -40 +40 @@
   ///
   ///This is an abstract class, it should be specialized for all numerical
-  ///data types. These specialized classes like \ref Tolerance<double>
+  ///data types. These specialized classes like \ref Tolerance\<double\>
   ///may offer additional tuning parameters.
   ///