[Lemon-commits] [lemon_svn] alpar: r2528 - in hugo/trunk: doc lemon
Lemon SVN
svn at lemon.cs.elte.hu
Mon Nov 6 20:53:18 CET 2006
Author: alpar
Date: Fri Feb 3 16:58:24 2006
New Revision: 2528
Modified:
hugo/trunk/doc/graph_orientation.dox
hugo/trunk/lemon/fredman_tarjan.h
hugo/trunk/lemon/iterable_maps.h
hugo/trunk/lemon/johnson.h
hugo/trunk/lemon/preflow.h
hugo/trunk/lemon/prim.h
hugo/trunk/lemon/time_measure.h
hugo/trunk/lemon/tolerance.h
Log:
Polish the doc.
Modified: hugo/trunk/doc/graph_orientation.dox
==============================================================================
--- hugo/trunk/doc/graph_orientation.dox (original)
+++ hugo/trunk/doc/graph_orientation.dox Fri Feb 3 16:58:24 2006
@@ -63,7 +63,7 @@
\skip main
\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.
\skip if
@@ -71,7 +71,8 @@
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
\skipline ListGraph
@@ -86,8 +87,9 @@
\until }
\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
The deficiency (\c def) of a node is the in-degree requirement minus the
@@ -101,9 +103,10 @@
\skip active
\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
@@ -111,7 +114,8 @@
\skipline nodeNum
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
\until while
Modified: hugo/trunk/lemon/fredman_tarjan.h
==============================================================================
--- hugo/trunk/lemon/fredman_tarjan.h (original)
+++ hugo/trunk/lemon/fredman_tarjan.h Fri Feb 3 16:58:24 2006
@@ -456,10 +456,10 @@
///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
///function.
Modified: hugo/trunk/lemon/iterable_maps.h
==============================================================================
--- hugo/trunk/lemon/iterable_maps.h (original)
+++ hugo/trunk/lemon/iterable_maps.h Fri Feb 3 16:58:24 2006
@@ -199,7 +199,7 @@
///
/// 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),
map(&_map) {}
@@ -239,7 +239,7 @@
///
/// 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() ?
_map.array.back() : INVALID), map(&_map) {}
@@ -278,7 +278,7 @@
///
/// 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)
: Parent(value ? (_map.sep > 0 ? _map.array[_map.sep - 1] : INVALID) :
Modified: hugo/trunk/lemon/johnson.h
==============================================================================
--- hugo/trunk/lemon/johnson.h (original)
+++ hugo/trunk/lemon/johnson.h Fri Feb 3 16:58:24 2006
@@ -151,7 +151,7 @@
/// \brief Instantiates a PredMap.
///
/// 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) {
return new PredMap(graph);
@@ -167,7 +167,7 @@
/// \brief Instantiates a DistMap.
///
/// 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) {
return new DistMap(graph);
Modified: hugo/trunk/lemon/preflow.h
==============================================================================
--- hugo/trunk/lemon/preflow.h (original)
+++ hugo/trunk/lemon/preflow.h Fri Feb 3 16:58:24 2006
@@ -152,6 +152,7 @@
///\param _t The target node.
///\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
///flowMap, resp.
Modified: hugo/trunk/lemon/prim.h
==============================================================================
--- hugo/trunk/lemon/prim.h (original)
+++ hugo/trunk/lemon/prim.h Fri Feb 3 16:58:24 2006
@@ -56,7 +56,7 @@
///Instantiates a HeapCrossRef.
///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){
return new HeapCrossRef(_graph);
@@ -86,7 +86,7 @@
///Instantiates a PredMap.
///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);
}
@@ -101,7 +101,8 @@
///Instantiates a TreeMap.
///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 &){
return new TreeMap();
@@ -116,7 +117,7 @@
///Instantiates a ProcessedMap.
///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
static ProcessedMap *createProcessedMap(const GR &_graph)
@@ -703,7 +704,7 @@
///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.
///
///\pre \ref run() or \ref start() must be called before using this function.
@@ -721,9 +722,9 @@
///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.
Modified: hugo/trunk/lemon/time_measure.h
==============================================================================
--- hugo/trunk/lemon/time_measure.h (original)
+++ hugo/trunk/lemon/time_measure.h Fri Feb 3 16:58:24 2006
@@ -272,7 +272,7 @@
public:
///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();}
Modified: hugo/trunk/lemon/tolerance.h
==============================================================================
--- hugo/trunk/lemon/tolerance.h (original)
+++ hugo/trunk/lemon/tolerance.h Fri Feb 3 16:58:24 2006
@@ -39,7 +39,7 @@
///as a result of a probably inexact computation.
///
///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.
///
///\sa Tolerance<float>
More information about the Lemon-commits
mailing list