1.1 --- a/lemon/edmonds_karp.h Tue Apr 04 10:40:02 2006 +0000
1.2 +++ b/lemon/edmonds_karp.h Tue Apr 04 17:43:23 2006 +0000
1.3 @@ -101,12 +101,12 @@
1.4 /// \brief The constructor of the class.
1.5 ///
1.6 /// The constructor of the class.
1.7 - /// \param _graph The directed graph the algorithm runs on.
1.8 - /// \param _source The source node.
1.9 - /// \param _target The target node.
1.10 - /// \param _capacity The capacity of the edges.
1.11 - /// \param _flow The flow of the edges.
1.12 - /// \param _tolerance Tolerance class.
1.13 + /// \param graph The directed graph the algorithm runs on.
1.14 + /// \param source The source node.
1.15 + /// \param target The target node.
1.16 + /// \param capacity The capacity of the edges.
1.17 + /// \param flow The flow of the edges.
1.18 + /// \param tolerance Tolerance class.
1.19 /// Except the graph, all of these parameters can be reset by
1.20 /// calling \ref source, \ref target, \ref capacityMap and \ref
1.21 /// flowMap, resp.
1.22 @@ -252,6 +252,7 @@
1.23 ///
1.24 /// Sets \c cut to the characteristic vector of a minimum value cut
1.25 /// It simply calls the minMinCut member.
1.26 + /// \retval cut Write node bool map.
1.27 template <typename CutMap>
1.28 void minCut(CutMap& cut) const {
1.29 minMinCut(cut);
1.30 @@ -262,6 +263,7 @@
1.31 /// Sets \c cut to the characteristic vector of the minimum value cut
1.32 /// which is inclusionwise minimum. It is computed by processing a
1.33 /// bfs from the source node \c source in the residual graph.
1.34 + /// \retval cut Write node bool map.
1.35 template <typename CutMap>
1.36 void minMinCut(CutMap& cut) const {
1.37
1.38 @@ -283,6 +285,7 @@
1.39 /// Sets \c cut to the characteristic vector of the minimum value cut
1.40 /// which is inclusionwise minimum. It is computed by processing a
1.41 /// bfs from the source node \c source in the residual graph.
1.42 + /// \retval cut Write node bool map.
1.43 template <typename CutMap>
1.44 void maxMinCut(CutMap& cut) const {
1.45
2.1 --- a/lemon/graph_adaptor.h Tue Apr 04 10:40:02 2006 +0000
2.2 +++ b/lemon/graph_adaptor.h Tue Apr 04 17:43:23 2006 +0000
2.3 @@ -19,13 +19,13 @@
2.4 #ifndef LEMON_GRAPH_ADAPTOR_H
2.5 #define LEMON_GRAPH_ADAPTOR_H
2.6
2.7 -/// \ingroup graph_adaptors
2.8 -/// \file
2.9 -/// \brief Several graph adaptors.
2.10 +///\ingroup graph_adaptors
2.11 +///\file
2.12 +///\brief Several graph adaptors.
2.13 ///
2.14 -/// This file contains several useful graph adaptor functions.
2.15 +///This file contains several useful graph adaptor functions.
2.16 ///
2.17 -/// \author Marton Makai and Balazs Dezso
2.18 +///\author Marton Makai and Balazs Dezso
2.19
2.20 #include <lemon/bits/invalid.h>
2.21 #include <lemon/maps.h>
2.22 @@ -74,9 +74,6 @@
2.23 public:
2.24 GraphAdaptorBase(Graph& _graph) : graph(&_graph) { }
2.25
2.26 - Graph& getGraph() { return *graph; }
2.27 - const Graph& getGraph() const { return *graph; }
2.28 -
2.29 typedef typename Graph::Node Node;
2.30 typedef typename Graph::Edge Edge;
2.31
2.32 @@ -1479,39 +1476,39 @@
2.33
2.34 ///\brief An adaptor for composing the residual
2.35 ///graph for directed flow and circulation problems.
2.36 + ///
2.37 ///\ingroup graph_adaptors
2.38 ///
2.39 ///An adaptor for composing the residual graph for
2.40 ///directed flow and circulation problems.
2.41 - ///Let \f$ G=(V, A) \f$ be a directed graph and let \f$ F \f$ be a
2.42 - ///number type. Let moreover
2.43 - ///\f$ f,c:A\to F \f$, be functions on the edge-set.
2.44 - ///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands for a flow
2.45 - ///and \f$ c \f$ for a capacity function.
2.46 - ///Suppose that a graph instange \c g of type
2.47 - ///\c ListGraph implements \f$ G \f$.
2.48 - ///\code
2.49 - /// ListGraph g;
2.50 - ///\endcode
2.51 - ///Then RevGraphAdaptor implements the graph structure with node-set
2.52 - ///\f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$, where
2.53 - ///\f$ A_{forward}=\{uv : uv\in A, f(uv)<c(uv)\} \f$ and
2.54 - ///\f$ A_{backward}=\{vu : uv\in A, f(uv)>0\} \f$,
2.55 - ///i.e. the so called residual graph.
2.56 - ///When we take the union \f$ A_{forward}\cup A_{backward} \f$,
2.57 - ///multilicities are counted, i.e. if an edge is in both
2.58 - ///\f$ A_{forward} \f$ and \f$ A_{backward} \f$, then in the adaptor it
2.59 - ///appears twice.
2.60 - ///The following code shows how
2.61 - ///such an instance can be constructed.
2.62 - ///\code
2.63 - ///typedef ListGraph Graph;
2.64 - ///Graph::EdgeMap<int> f(g);
2.65 - ///Graph::EdgeMap<int> c(g);
2.66 - ///ResGraphAdaptor<Graph, int, Graph::EdgeMap<int>, Graph::EdgeMap<int> > ga(g);
2.67 - ///\endcode
2.68 - ///\author Marton Makai
2.69 - ///
2.70 +// ///Let \f$ G=(V, A) \f$ be a directed graph and let \f$ F \f$ be a
2.71 +// ///number type. Let moreover
2.72 +// ///\f$ f,c:A\to F \f$, be functions on the edge-set.
2.73 +// ///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands for a
2.74 +// ///flow and \f$ c \f$ for a capacity function.
2.75 +// ///Suppose that a graph instange \c g of type
2.76 +// ///\c ListGraph implements \f$ G \f$.
2.77 +// ///\code
2.78 +// /// ListGraph g;
2.79 +// ///\endcode
2.80 +// ///Then RevGraphAdaptor implements the graph structure with node-set
2.81 +// ///\f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$, where
2.82 +// ///\f$ A_{forward}=\{uv : uv\in A, f(uv)<c(uv)\} \f$ and
2.83 +// ///\f$ A_{backward}=\{vu : uv\in A, f(uv)>0\} \f$,
2.84 +// ///i.e. the so called residual graph.
2.85 +// ///When we take the union \f$ A_{forward}\cup A_{backward} \f$,
2.86 +// ///multilicities are counted, i.e. if an edge is in both
2.87 +// ///\f$ A_{forward} \f$ and \f$ A_{backward} \f$, then in the adaptor it
2.88 +// ///appears twice. The following code shows how such an instance can be
2.89 +// ///constructed.
2.90 +// ///\code
2.91 +// /// typedef ListGraph Graph;
2.92 +// /// Graph::EdgeMap<int> f(g);
2.93 +// /// Graph::EdgeMap<int> c(g);
2.94 +// /// ResGraphAdaptor<Graph, int, Graph::EdgeMap<int>, Graph::EdgeMap<int> > ga(g);
2.95 +// ///\endcode
2.96 +// ///\author Marton Makai
2.97 +// ///
2.98 template<typename Graph, typename Number,
2.99 typename CapacityMap, typename FlowMap,
2.100 typename Tolerance = Tolerance<Number> >
2.101 @@ -1561,8 +1558,6 @@
2.102
2.103 public:
2.104
2.105 - const Graph& getGraph() const { return ugraph.getGraph(); }
2.106 -
2.107 /// \brief Constructor of the residual graph.
2.108 ///
2.109 /// Constructor of the residual graph. The parameters are the graph type,
3.1 --- a/lemon/graph_reader.h Tue Apr 04 10:40:02 2006 +0000
3.2 +++ b/lemon/graph_reader.h Tue Apr 04 17:43:23 2006 +0000
3.3 @@ -39,10 +39,6 @@
3.4 /// Before you read this documentation it might be useful to read the general
3.5 /// description of \ref graph-io-page "Graph Input-Output".
3.6 ///
3.7 - /// If you don't need very sophisticated
3.8 - /// behaviour then you can use the versions of the public function
3.9 - /// \ref readGraph() to read a graph (or a max flow instance etc).
3.10 - ///
3.11 /// The file to be read may contain several maps and labeled nodes or
3.12 /// edges.
3.13 ///
3.14 @@ -384,10 +380,6 @@
3.15 /// Before you read this documentation it might be useful to read the general
3.16 /// description of \ref graph-io-page "Graph Input-Output".
3.17 ///
3.18 - /// If you don't need very sophisticated
3.19 - /// behaviour then you can use the versions of the public function
3.20 - /// \ref readGraph() to read a graph (or a max flow instance etc).
3.21 - ///
3.22 /// The given file format may contain several maps and labeled nodes or
3.23 /// edges.
3.24 ///
4.1 --- a/lemon/graph_writer.h Tue Apr 04 10:40:02 2006 +0000
4.2 +++ b/lemon/graph_writer.h Tue Apr 04 17:43:23 2006 +0000
4.3 @@ -40,10 +40,6 @@
4.4 /// Before you read this documentation it might be useful to read the general
4.5 /// description of \ref graph-io-page "Graph Input-Output".
4.6 ///
4.7 - /// If you don't need very sophisticated
4.8 - /// behaviour then you can use the versions of the public function
4.9 - /// \ref writeGraph() to output a graph (or a max flow instance etc).
4.10 - ///
4.11 /// To write a graph
4.12 /// you should first give writing commands to the writer. You can declare
4.13 /// write commands as \c NodeMap or \c EdgeMap writing and labeled Node and
5.1 --- a/lemon/grid_ugraph.h Tue Apr 04 10:40:02 2006 +0000
5.2 +++ b/lemon/grid_ugraph.h Tue Apr 04 17:43:23 2006 +0000
5.3 @@ -371,8 +371,8 @@
5.4 /// }
5.5 ///\endcode
5.6 ///
5.7 - /// The graph type is fully conform to the \ref concept::UUGraph
5.8 - /// "Undirected UGraph" concept.
5.9 + /// The graph type is fully conform to the \ref concept::UGraph
5.10 + /// "Undirected Graph" concept.
5.11 ///
5.12 /// \author Balazs Dezso
5.13 /// \see GridUGraphBase
6.1 --- a/lemon/min_cost_arborescence.h Tue Apr 04 10:40:02 2006 +0000
6.2 +++ b/lemon/min_cost_arborescence.h Tue Apr 04 17:43:23 2006 +0000
6.3 @@ -57,7 +57,7 @@
6.4 /// in the arborescence.
6.5 ///
6.6 /// The type of the map that stores which edges are in the arborescence.
6.7 - /// It must meet the \ref concept::WritedMap "WriteMap" concept.
6.8 + /// It must meet the \ref concept::WriteMap "WriteMap" concept.
6.9 /// Initially it will be setted to false on each edge. After it
6.10 /// will set all arborescence edges once.
6.11 typedef typename Graph::template EdgeMap<bool> ArborescenceMap;
7.1 --- a/lemon/min_cut.h Tue Apr 04 10:40:02 2006 +0000
7.2 +++ b/lemon/min_cut.h Tue Apr 04 17:43:23 2006 +0000
7.3 @@ -120,7 +120,7 @@
7.4 /// \brief Instantiates a ProcessedMap.
7.5 ///
7.6 /// This function instantiates a \ref ProcessedMap.
7.7 - /// \param g is the graph, to which
7.8 + /// \param graph is the graph, to which
7.9 /// we would like to define the \ref ProcessedMap
7.10 #ifdef DOXYGEN
7.11 static ProcessedMap *createProcessedMap(const Graph &graph)
7.12 @@ -362,8 +362,8 @@
7.13
7.14 /// \brief Constructor.
7.15 ///
7.16 - ///\param _graph the graph the algorithm will run on.
7.17 - ///\param _capacity the capacity map used by the algorithm.
7.18 + ///\param graph the graph the algorithm will run on.
7.19 + ///\param capacity the capacity map used by the algorithm.
7.20 MaxCardinalitySearch(const Graph& graph, const CapacityMap& capacity) :
7.21 _graph(&graph), _capacity(&capacity),
7.22 _cardinality(0), local_cardinality(false),
8.1 --- a/lemon/ugraph_adaptor.h Tue Apr 04 10:40:02 2006 +0000
8.2 +++ b/lemon/ugraph_adaptor.h Tue Apr 04 17:43:23 2006 +0000
8.3 @@ -64,9 +64,6 @@
8.4
8.5 void setGraph(Graph& _graph) { graph=&_graph; }
8.6
8.7 - Graph& getGraph() { return *graph; }
8.8 - const Graph& getGraph() const { return *graph; }
8.9 -
8.10 public:
8.11 UGraphAdaptorBase(Graph& _graph) : graph(&_graph) {}
8.12