# HG changeset patch
# User Peter Kovacs <kpeter@inf.elte.hu>
# Date 1248424060 -7200
# Node ID 4ac30454f1c13ba27b62fec6b649a2a6a944480e
# Parent 9f529abcaebf13f19e61ba24fdd2c3631860af91
Small doc improvements
diff -r 9f529abcaebf -r 4ac30454f1c1 doc/groups.dox
--- a/doc/groups.dox Thu Jun 11 23:13:24 2009 +0200
+++ b/doc/groups.dox Fri Jul 24 10:27:40 2009 +0200
@@ -375,7 +375,7 @@
cut is the \f$X\f$ solution of the next optimization problem:
\f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}
- \sum_{uv\in A, u\in X, v\not\in X}cap(uv) \f]
+ \sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f]
LEMON contains several algorithms related to minimum cut problems:
@@ -398,8 +398,8 @@
This group contains the algorithms for discovering the graph properties
like connectivity, bipartiteness, euler property, simplicity etc.
-\image html edge_biconnected_components.png
-\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
+\image html connected_components.png
+\image latex connected_components.eps "Connected components" width=\textwidth
*/
/**
diff -r 9f529abcaebf -r 4ac30454f1c1 lemon/bfs.h
--- a/lemon/bfs.h Thu Jun 11 23:13:24 2009 +0200
+++ b/lemon/bfs.h Fri Jul 24 10:27:40 2009 +0200
@@ -413,8 +413,8 @@
///\name Execution Control
///The simplest way to execute the BFS algorithm is to use one of the
///member functions called \ref run(Node) "run()".\n
- ///If you need more control on the execution, first you have to call
- ///\ref init(), then you can add several source nodes with
+ ///If you need better control on the execution, you have to call
+ ///\ref init() first, then you can add several source nodes with
///\ref addSource(). Finally the actual path computation can be
///performed with one of the \ref start() functions.
@@ -1425,8 +1425,8 @@
/// \name Execution Control
/// The simplest way to execute the BFS algorithm is to use one of the
/// member functions called \ref run(Node) "run()".\n
- /// If you need more control on the execution, first you have to call
- /// \ref init(), then you can add several source nodes with
+ /// If you need better control on the execution, you have to call
+ /// \ref init() first, then you can add several source nodes with
/// \ref addSource(). Finally the actual path computation can be
/// performed with one of the \ref start() functions.
diff -r 9f529abcaebf -r 4ac30454f1c1 lemon/circulation.h
--- a/lemon/circulation.h Thu Jun 11 23:13:24 2009 +0200
+++ b/lemon/circulation.h Fri Jul 24 10:27:40 2009 +0200
@@ -72,7 +72,11 @@
/// The type of the map that stores the flow values.
/// It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap"
/// concept.
+#ifdef DOXYGEN
+ typedef GR::ArcMap<Value> FlowMap;
+#else
typedef typename Digraph::template ArcMap<Value> FlowMap;
+#endif
/// \brief Instantiates a FlowMap.
///
@@ -87,9 +91,12 @@
///
/// The elevator type used by the algorithm.
///
- /// \sa Elevator
- /// \sa LinkedElevator
+ /// \sa Elevator, LinkedElevator
+#ifdef DOXYGEN
+ typedef lemon::Elevator<GR, GR::Node> Elevator;
+#else
typedef lemon::Elevator<Digraph, typename Digraph::Node> Elevator;
+#endif
/// \brief Instantiates an Elevator.
///
@@ -467,8 +474,8 @@
/// \name Execution Control
/// The simplest way to execute the algorithm is to call \ref run().\n
- /// If you need more control on the initial solution or the execution,
- /// first you have to call one of the \ref init() functions, then
+ /// If you need better control on the initial solution or the execution,
+ /// you have to call one of the \ref init() functions first, then
/// the \ref start() function.
///@{
diff -r 9f529abcaebf -r 4ac30454f1c1 lemon/dfs.h
--- a/lemon/dfs.h Thu Jun 11 23:13:24 2009 +0200
+++ b/lemon/dfs.h Fri Jul 24 10:27:40 2009 +0200
@@ -411,8 +411,8 @@
///\name Execution Control
///The simplest way to execute the DFS algorithm is to use one of the
///member functions called \ref run(Node) "run()".\n
- ///If you need more control on the execution, first you have to call
- ///\ref init(), then you can add a source node with \ref addSource()
+ ///If you need better control on the execution, you have to call
+ ///\ref init() first, then you can add a source node with \ref addSource()
///and perform the actual computation with \ref start().
///This procedure can be repeated if there are nodes that have not
///been reached.
@@ -1369,8 +1369,8 @@
/// \name Execution Control
/// The simplest way to execute the DFS algorithm is to use one of the
/// member functions called \ref run(Node) "run()".\n
- /// If you need more control on the execution, first you have to call
- /// \ref init(), then you can add a source node with \ref addSource()
+ /// If you need better control on the execution, you have to call
+ /// \ref init() first, then you can add a source node with \ref addSource()
/// and perform the actual computation with \ref start().
/// This procedure can be repeated if there are nodes that have not
/// been reached.
diff -r 9f529abcaebf -r 4ac30454f1c1 lemon/dijkstra.h
--- a/lemon/dijkstra.h Thu Jun 11 23:13:24 2009 +0200
+++ b/lemon/dijkstra.h Fri Jul 24 10:27:40 2009 +0200
@@ -584,8 +584,8 @@
///\name Execution Control
///The simplest way to execute the %Dijkstra algorithm is to use
///one of the member functions called \ref run(Node) "run()".\n
- ///If you need more control on the execution, first you have to call
- ///\ref init(), then you can add several source nodes with
+ ///If you need better control on the execution, you have to call
+ ///\ref init() first, then you can add several source nodes with
///\ref addSource(). Finally the actual path computation can be
///performed with one of the \ref start() functions.
diff -r 9f529abcaebf -r 4ac30454f1c1 lemon/gomory_hu.h
--- a/lemon/gomory_hu.h Thu Jun 11 23:13:24 2009 +0200
+++ b/lemon/gomory_hu.h Fri Jul 24 10:27:40 2009 +0200
@@ -359,10 +359,10 @@
/// This example counts the nodes in the minimum cut separating \c s from
/// \c t.
/// \code
- /// GomoruHu<Graph> gom(g, capacities);
+ /// GomoryHu<Graph> gom(g, capacities);
/// gom.run();
/// int cnt=0;
- /// for(GomoruHu<Graph>::MinCutNodeIt n(gom,s,t); n!=INVALID; ++n) ++cnt;
+ /// for(GomoryHu<Graph>::MinCutNodeIt n(gom,s,t); n!=INVALID; ++n) ++cnt;
/// \endcode
class MinCutNodeIt
{
@@ -456,10 +456,10 @@
/// This example computes the value of the minimum cut separating \c s from
/// \c t.
/// \code
- /// GomoruHu<Graph> gom(g, capacities);
+ /// GomoryHu<Graph> gom(g, capacities);
/// gom.run();
/// int value=0;
- /// for(GomoruHu<Graph>::MinCutEdgeIt e(gom,s,t); e!=INVALID; ++e)
+ /// for(GomoryHu<Graph>::MinCutEdgeIt e(gom,s,t); e!=INVALID; ++e)
/// value+=capacities[e];
/// \endcode
/// The result will be the same as the value returned by
diff -r 9f529abcaebf -r 4ac30454f1c1 lemon/min_cost_arborescence.h
--- a/lemon/min_cost_arborescence.h Thu Jun 11 23:13:24 2009 +0200
+++ b/lemon/min_cost_arborescence.h Fri Jul 24 10:27:40 2009 +0200
@@ -488,8 +488,8 @@
/// \name Execution Control
/// The simplest way to execute the algorithm is to use
/// one of the member functions called \c run(...). \n
- /// If you need more control on the execution,
- /// first you must call \ref init(), then you can add several
+ /// If you need better control on the execution,
+ /// you have to call \ref init() first, then you can add several
/// source nodes with \ref addSource().
/// Finally \ref start() will perform the arborescence
/// computation.
diff -r 9f529abcaebf -r 4ac30454f1c1 lemon/preflow.h
--- a/lemon/preflow.h Thu Jun 11 23:13:24 2009 +0200
+++ b/lemon/preflow.h Fri Jul 24 10:27:40 2009 +0200
@@ -52,7 +52,11 @@
///
/// The type of the map that stores the flow values.
/// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
+#ifdef DOXYGEN
+ typedef GR::ArcMap<Value> FlowMap;
+#else
typedef typename Digraph::template ArcMap<Value> FlowMap;
+#endif
/// \brief Instantiates a FlowMap.
///
@@ -67,9 +71,12 @@
///
/// The elevator type used by Preflow algorithm.
///
- /// \sa Elevator
- /// \sa LinkedElevator
- typedef LinkedElevator<Digraph, typename Digraph::Node> Elevator;
+ /// \sa Elevator, LinkedElevator
+#ifdef DOXYGEN
+ typedef lemon::Elevator<GR, GR::Node> Elevator;
+#else
+ typedef lemon::Elevator<Digraph, typename Digraph::Node> Elevator;
+#endif
/// \brief Instantiates an Elevator.
///
@@ -389,8 +396,8 @@
/// \name Execution Control
/// The simplest way to execute the preflow algorithm is to use
/// \ref run() or \ref runMinCut().\n
- /// If you need more control on the initial solution or the execution,
- /// first you have to call one of the \ref init() functions, then
+ /// If you need better control on the initial solution or the execution,
+ /// you have to call one of the \ref init() functions first, then
/// \ref startFirstPhase() and if you need it \ref startSecondPhase().
///@{