# HG changeset patch # User deba # Date 1144172603 0 # Node ID 32e4bebee6163f84b67c69381813628cd9316bd9 # Parent 9d0c8a205e58731c1a7bcf641f40a1691dff11ba Doxygen log corrections doc of ResGraphAdaptor has a bug in graph_adaptor.h diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/edmonds_karp.h --- a/lemon/edmonds_karp.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/edmonds_karp.h Tue Apr 04 17:43:23 2006 +0000 @@ -101,12 +101,12 @@ /// \brief The constructor of the class. /// /// The constructor of the class. - /// \param _graph The directed graph the algorithm runs on. - /// \param _source The source node. - /// \param _target The target node. - /// \param _capacity The capacity of the edges. - /// \param _flow The flow of the edges. - /// \param _tolerance Tolerance class. + /// \param graph The directed graph the algorithm runs on. + /// \param source The source node. + /// \param target The target node. + /// \param capacity The capacity of the edges. + /// \param flow The flow of the edges. + /// \param tolerance Tolerance class. /// Except the graph, all of these parameters can be reset by /// calling \ref source, \ref target, \ref capacityMap and \ref /// flowMap, resp. @@ -252,6 +252,7 @@ /// /// Sets \c cut to the characteristic vector of a minimum value cut /// It simply calls the minMinCut member. + /// \retval cut Write node bool map. template void minCut(CutMap& cut) const { minMinCut(cut); @@ -262,6 +263,7 @@ /// Sets \c cut to the characteristic vector of the minimum value cut /// which is inclusionwise minimum. It is computed by processing a /// bfs from the source node \c source in the residual graph. + /// \retval cut Write node bool map. template void minMinCut(CutMap& cut) const { @@ -283,6 +285,7 @@ /// Sets \c cut to the characteristic vector of the minimum value cut /// which is inclusionwise minimum. It is computed by processing a /// bfs from the source node \c source in the residual graph. + /// \retval cut Write node bool map. template void maxMinCut(CutMap& cut) const { diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/graph_adaptor.h --- a/lemon/graph_adaptor.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/graph_adaptor.h Tue Apr 04 17:43:23 2006 +0000 @@ -19,13 +19,13 @@ #ifndef LEMON_GRAPH_ADAPTOR_H #define LEMON_GRAPH_ADAPTOR_H -/// \ingroup graph_adaptors -/// \file -/// \brief Several graph adaptors. +///\ingroup graph_adaptors +///\file +///\brief Several graph adaptors. /// -/// This file contains several useful graph adaptor functions. +///This file contains several useful graph adaptor functions. /// -/// \author Marton Makai and Balazs Dezso +///\author Marton Makai and Balazs Dezso #include #include @@ -74,9 +74,6 @@ public: GraphAdaptorBase(Graph& _graph) : graph(&_graph) { } - Graph& getGraph() { return *graph; } - const Graph& getGraph() const { return *graph; } - typedef typename Graph::Node Node; typedef typename Graph::Edge Edge; @@ -1479,39 +1476,39 @@ ///\brief An adaptor for composing the residual ///graph for directed flow and circulation problems. + /// ///\ingroup graph_adaptors /// ///An adaptor for composing the residual graph for ///directed flow and circulation problems. - ///Let \f$ G=(V, A) \f$ be a directed graph and let \f$ F \f$ be a - ///number type. Let moreover - ///\f$ f,c:A\to F \f$, be functions on the edge-set. - ///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands for a flow - ///and \f$ c \f$ for a capacity function. - ///Suppose that a graph instange \c g of type - ///\c ListGraph implements \f$ G \f$. - ///\code - /// ListGraph g; - ///\endcode - ///Then RevGraphAdaptor implements the graph structure with node-set - ///\f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$, where - ///\f$ A_{forward}=\{uv : uv\in A, f(uv)0\} \f$, - ///i.e. the so called residual graph. - ///When we take the union \f$ A_{forward}\cup A_{backward} \f$, - ///multilicities are counted, i.e. if an edge is in both - ///\f$ A_{forward} \f$ and \f$ A_{backward} \f$, then in the adaptor it - ///appears twice. - ///The following code shows how - ///such an instance can be constructed. - ///\code - ///typedef ListGraph Graph; - ///Graph::EdgeMap f(g); - ///Graph::EdgeMap c(g); - ///ResGraphAdaptor, Graph::EdgeMap > ga(g); - ///\endcode - ///\author Marton Makai - /// +// ///Let \f$ G=(V, A) \f$ be a directed graph and let \f$ F \f$ be a +// ///number type. Let moreover +// ///\f$ f,c:A\to F \f$, be functions on the edge-set. +// ///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands for a +// ///flow and \f$ c \f$ for a capacity function. +// ///Suppose that a graph instange \c g of type +// ///\c ListGraph implements \f$ G \f$. +// ///\code +// /// ListGraph g; +// ///\endcode +// ///Then RevGraphAdaptor implements the graph structure with node-set +// ///\f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$, where +// ///\f$ A_{forward}=\{uv : uv\in A, f(uv)0\} \f$, +// ///i.e. the so called residual graph. +// ///When we take the union \f$ A_{forward}\cup A_{backward} \f$, +// ///multilicities are counted, i.e. if an edge is in both +// ///\f$ A_{forward} \f$ and \f$ A_{backward} \f$, then in the adaptor it +// ///appears twice. The following code shows how such an instance can be +// ///constructed. +// ///\code +// /// typedef ListGraph Graph; +// /// Graph::EdgeMap f(g); +// /// Graph::EdgeMap c(g); +// /// ResGraphAdaptor, Graph::EdgeMap > ga(g); +// ///\endcode +// ///\author Marton Makai +// /// template > @@ -1561,8 +1558,6 @@ public: - const Graph& getGraph() const { return ugraph.getGraph(); } - /// \brief Constructor of the residual graph. /// /// Constructor of the residual graph. The parameters are the graph type, diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/graph_reader.h --- a/lemon/graph_reader.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/graph_reader.h Tue Apr 04 17:43:23 2006 +0000 @@ -39,10 +39,6 @@ /// Before you read this documentation it might be useful to read the general /// description of \ref graph-io-page "Graph Input-Output". /// - /// If you don't need very sophisticated - /// behaviour then you can use the versions of the public function - /// \ref readGraph() to read a graph (or a max flow instance etc). - /// /// The file to be read may contain several maps and labeled nodes or /// edges. /// @@ -384,10 +380,6 @@ /// Before you read this documentation it might be useful to read the general /// description of \ref graph-io-page "Graph Input-Output". /// - /// If you don't need very sophisticated - /// behaviour then you can use the versions of the public function - /// \ref readGraph() to read a graph (or a max flow instance etc). - /// /// The given file format may contain several maps and labeled nodes or /// edges. /// diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/graph_writer.h --- a/lemon/graph_writer.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/graph_writer.h Tue Apr 04 17:43:23 2006 +0000 @@ -40,10 +40,6 @@ /// Before you read this documentation it might be useful to read the general /// description of \ref graph-io-page "Graph Input-Output". /// - /// If you don't need very sophisticated - /// behaviour then you can use the versions of the public function - /// \ref writeGraph() to output a graph (or a max flow instance etc). - /// /// To write a graph /// you should first give writing commands to the writer. You can declare /// write commands as \c NodeMap or \c EdgeMap writing and labeled Node and diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/grid_ugraph.h --- a/lemon/grid_ugraph.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/grid_ugraph.h Tue Apr 04 17:43:23 2006 +0000 @@ -371,8 +371,8 @@ /// } ///\endcode /// - /// The graph type is fully conform to the \ref concept::UUGraph - /// "Undirected UGraph" concept. + /// The graph type is fully conform to the \ref concept::UGraph + /// "Undirected Graph" concept. /// /// \author Balazs Dezso /// \see GridUGraphBase diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/min_cost_arborescence.h --- a/lemon/min_cost_arborescence.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/min_cost_arborescence.h Tue Apr 04 17:43:23 2006 +0000 @@ -57,7 +57,7 @@ /// in the arborescence. /// /// The type of the map that stores which edges are in the arborescence. - /// It must meet the \ref concept::WritedMap "WriteMap" concept. + /// It must meet the \ref concept::WriteMap "WriteMap" concept. /// Initially it will be setted to false on each edge. After it /// will set all arborescence edges once. typedef typename Graph::template EdgeMap ArborescenceMap; diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/min_cut.h --- a/lemon/min_cut.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/min_cut.h Tue Apr 04 17:43:23 2006 +0000 @@ -120,7 +120,7 @@ /// \brief 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 Graph &graph) @@ -362,8 +362,8 @@ /// \brief Constructor. /// - ///\param _graph the graph the algorithm will run on. - ///\param _capacity the capacity map used by the algorithm. + ///\param graph the graph the algorithm will run on. + ///\param capacity the capacity map used by the algorithm. MaxCardinalitySearch(const Graph& graph, const CapacityMap& capacity) : _graph(&graph), _capacity(&capacity), _cardinality(0), local_cardinality(false), diff -r 9d0c8a205e58 -r 32e4bebee616 lemon/ugraph_adaptor.h --- a/lemon/ugraph_adaptor.h Tue Apr 04 10:40:02 2006 +0000 +++ b/lemon/ugraph_adaptor.h Tue Apr 04 17:43:23 2006 +0000 @@ -64,9 +64,6 @@ void setGraph(Graph& _graph) { graph=&_graph; } - Graph& getGraph() { return *graph; } - const Graph& getGraph() const { return *graph; } - public: UGraphAdaptorBase(Graph& _graph) : graph(&_graph) {}