# HG changeset patch # User alpar # Date 1091705906 0 # Node ID 49b1a30c4dc4365bf94e0d71038ee05d54a0cadb # Parent 8680351d0c28f5deb6f0b55f51c12d98e1a3af07 New Doxygen module for path/flow algs. diff -r 8680351d0c28 -r 49b1a30c4dc4 doc/groups.dox --- a/doc/groups.dox Thu Aug 05 08:53:09 2004 +0000 +++ b/doc/groups.dox Thu Aug 05 11:38:26 2004 +0000 @@ -45,10 +45,10 @@ */ /** -@defgroup spantree Minimum Cost Spanning Tree Algorithms -\brief This group containes the algorithms for finding a minimum cost spanning -tree in a graph +@defgroup flowalgs Path and Flow Algorithms @ingroup galgs +\brief This group describes the algorithms +for finding paths and flows in graphs. */ /** diff -r 8680351d0c28 -r 49b1a30c4dc4 src/hugo/dijkstra.h --- a/src/hugo/dijkstra.h Thu Aug 05 08:53:09 2004 +0000 +++ b/src/hugo/dijkstra.h Thu Aug 05 11:38:26 2004 +0000 @@ -2,7 +2,7 @@ #ifndef HUGO_DIJKSTRA_H #define HUGO_DIJKSTRA_H -///\ingroup galgs +///\ingroup flowalgs ///\file ///\brief Dijkstra algorithm. @@ -11,7 +11,7 @@ namespace hugo { -/// \addtogroup galgs +/// \addtogroup flowalgs /// @{ ///%Dijkstra algorithm class. diff -r 8680351d0c28 -r 49b1a30c4dc4 src/hugo/max_flow.h --- a/src/hugo/max_flow.h Thu Aug 05 08:53:09 2004 +0000 +++ b/src/hugo/max_flow.h Thu Aug 05 11:38:26 2004 +0000 @@ -10,12 +10,13 @@ #include /// \file -/// \ingroup galgs +/// \ingroup flowalgs namespace hugo { - /// \addtogroup galgs - /// @{ + /// \addtogroup flowalgs + /// @{ + ///Maximum flow algorithms class. ///This class provides various algorithms for finding a flow of @@ -26,17 +27,19 @@ ///functions \ref setSource, \ref setTarget, \ref setCap and ///\ref setFlow. Before any subsequent runs of any algorithm of ///the class \ref setFlow should be called. - + /// ///After running an algorithm of the class, the actual flow value ///can be obtained by calling \ref flowValue(). The minimum ///value cut can be written into a \c node map of \c bools by ///calling \ref minCut. (\ref minMinCut and \ref maxMinCut writes ///the inclusionwise minimum and maximum of the minimum value - ///cuts, resp.) + ///cuts, resp.) + /// ///\param Graph The directed graph type the algorithm runs on. ///\param Num The number type of the capacities and the flow values. ///\param CapMap The capacity map type. - ///\param FlowMap The flow map type. + ///\param FlowMap The flow map type. + /// ///\author Marton Makai, Jacint Szabo template , diff -r 8680351d0c28 -r 49b1a30c4dc4 src/hugo/mincostflows.h --- a/src/hugo/mincostflows.h Thu Aug 05 08:53:09 2004 +0000 +++ b/src/hugo/mincostflows.h Thu Aug 05 11:38:26 2004 +0000 @@ -2,7 +2,7 @@ #ifndef HUGO_MINCOSTFLOWS_H #define HUGO_MINCOSTFLOWS_H -///\ingroup galgs +///\ingroup flowalgs ///\file ///\brief An algorithm for finding a flow of value \c k (for small values of \c k) having minimal total cost @@ -15,7 +15,7 @@ namespace hugo { -/// \addtogroup galgs +/// \addtogroup flowalgs /// @{ ///\brief Implementation of an algorithm for finding a flow of value \c k diff -r 8680351d0c28 -r 49b1a30c4dc4 src/work/johanna/kruskal.h --- a/src/work/johanna/kruskal.h Thu Aug 05 08:53:09 2004 +0000 +++ b/src/work/johanna/kruskal.h Thu Aug 05 11:38:26 2004 +0000 @@ -5,11 +5,22 @@ #include #include +/** +@defgroup spantree Minimum Cost Spanning Tree Algorithms +\brief This group containes the algorithms for finding a minimum cost spanning +tree in a graph +@ingroup galgs +*/ + +///\ingroup spantree ///\file ///\brief Kruskal's algorithm to compute a minimum cost tree namespace hugo { + /// \addtogroup spantree + /// @{ + /// Kruskal's algorithm to find a minimum cost tree of a graph. /// This function runs Kruskal's algorithm to find a minimum cost tree. @@ -293,6 +304,7 @@ return kruskal(G, iv, out); } + /// @} } //namespace hugo