# Ticket #303: 303-doc-impr-4ac30454f1c1.patch

File 303-doc-impr-4ac30454f1c1.patch, 8.7 KB (added by Peter Kovacs, 10 years ago)
• ## doc/groups.dox

# HG changeset patch
# User Peter Kovacs <kpeter@inf.elte.hu>
# Date 1248424060 -7200
# Node ID 4ac30454f1c13ba27b62fec6b649a2a6a944480e
# Parent  9f529abcaebf13f19e61ba24fdd2c3631860af91
Small doc improvements

diff --git a/doc/groups.dox b/doc/groups.dox
 a 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: 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 */ /**
• ## lemon/bfs.h

diff --git a/lemon/bfs.h b/lemon/bfs.h
 a ///\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. /// \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.
• ## lemon/circulation.h

diff --git a/lemon/circulation.h b/lemon/circulation.h
 a /// 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 FlowMap; #else typedef typename Digraph::template ArcMap FlowMap; #endif /// \brief Instantiates a FlowMap. /// /// /// The elevator type used by the algorithm. /// /// \sa Elevator /// \sa LinkedElevator /// \sa Elevator, LinkedElevator #ifdef DOXYGEN typedef lemon::Elevator Elevator; #else typedef lemon::Elevator Elevator; #endif /// \brief Instantiates an Elevator. /// /// \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. ///@{
• ## lemon/dfs.h

diff --git a/lemon/dfs.h b/lemon/dfs.h
 a ///\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. /// \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.
• ## lemon/dijkstra.h

diff --git a/lemon/dijkstra.h b/lemon/dijkstra.h
 a ///\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.
• ## lemon/gomory_hu.h

diff --git a/lemon/gomory_hu.h b/lemon/gomory_hu.h
 a /// This example counts the nodes in the minimum cut separating \c s from /// \c t. /// \code /// GomoruHu gom(g, capacities); /// GomoryHu gom(g, capacities); /// gom.run(); /// int cnt=0; /// for(GomoruHu::MinCutNodeIt n(gom,s,t); n!=INVALID; ++n) ++cnt; /// for(GomoryHu::MinCutNodeIt n(gom,s,t); n!=INVALID; ++n) ++cnt; /// \endcode class MinCutNodeIt { /// This example computes the value of the minimum cut separating \c s from /// \c t. /// \code /// GomoruHu gom(g, capacities); /// GomoryHu gom(g, capacities); /// gom.run(); /// int value=0; /// for(GomoruHu::MinCutEdgeIt e(gom,s,t); e!=INVALID; ++e) /// for(GomoryHu::MinCutEdgeIt e(gom,s,t); e!=INVALID; ++e) ///   value+=capacities[e]; /// \endcode /// The result will be the same as the value returned by
• ## lemon/min_cost_arborescence.h

diff --git a/lemon/min_cost_arborescence.h b/lemon/min_cost_arborescence.h
 a /// \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.
• ## lemon/preflow.h

diff --git a/lemon/preflow.h b/lemon/preflow.h
 a /// /// The type of the map that stores the flow values. /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. #ifdef DOXYGEN typedef GR::ArcMap FlowMap; #else typedef typename Digraph::template ArcMap FlowMap; #endif /// \brief Instantiates a FlowMap. /// /// /// The elevator type used by Preflow algorithm. /// /// \sa Elevator /// \sa LinkedElevator typedef LinkedElevator Elevator; /// \sa Elevator, LinkedElevator #ifdef DOXYGEN typedef lemon::Elevator Elevator; #else typedef lemon::Elevator Elevator; #endif /// \brief Instantiates an Elevator. /// /// \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(). ///@{