New Doxygen module for path/flow algs.
authoralpar
Thu, 05 Aug 2004 11:38:26 +0000
changeset 75849b1a30c4dc4
parent 757 8680351d0c28
child 759 2d2d41010cb9
New Doxygen module for path/flow algs.
doc/groups.dox
src/hugo/dijkstra.h
src/hugo/max_flow.h
src/hugo/mincostflows.h
src/work/johanna/kruskal.h
     1.1 --- a/doc/groups.dox	Thu Aug 05 08:53:09 2004 +0000
     1.2 +++ b/doc/groups.dox	Thu Aug 05 11:38:26 2004 +0000
     1.3 @@ -45,10 +45,10 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 -@defgroup spantree Minimum Cost Spanning Tree Algorithms
     1.8 -\brief This group containes the algorithms for finding a minimum cost spanning
     1.9 -tree in a graph
    1.10 +@defgroup flowalgs Path and Flow Algorithms
    1.11  @ingroup galgs
    1.12 +\brief This group describes the algorithms
    1.13 +for finding paths and flows in graphs.
    1.14  */
    1.15  
    1.16  /**
     2.1 --- a/src/hugo/dijkstra.h	Thu Aug 05 08:53:09 2004 +0000
     2.2 +++ b/src/hugo/dijkstra.h	Thu Aug 05 11:38:26 2004 +0000
     2.3 @@ -2,7 +2,7 @@
     2.4  #ifndef HUGO_DIJKSTRA_H
     2.5  #define HUGO_DIJKSTRA_H
     2.6  
     2.7 -///\ingroup galgs
     2.8 +///\ingroup flowalgs
     2.9  ///\file
    2.10  ///\brief Dijkstra algorithm.
    2.11  
    2.12 @@ -11,7 +11,7 @@
    2.13  
    2.14  namespace hugo {
    2.15  
    2.16 -/// \addtogroup galgs
    2.17 +/// \addtogroup flowalgs
    2.18  /// @{
    2.19  
    2.20    ///%Dijkstra algorithm class.
     3.1 --- a/src/hugo/max_flow.h	Thu Aug 05 08:53:09 2004 +0000
     3.2 +++ b/src/hugo/max_flow.h	Thu Aug 05 11:38:26 2004 +0000
     3.3 @@ -10,12 +10,13 @@
     3.4  #include <hugo/maps.h>
     3.5  
     3.6  /// \file
     3.7 -/// \ingroup galgs
     3.8 +/// \ingroup flowalgs
     3.9  
    3.10  namespace hugo {
    3.11  
    3.12 -  /// \addtogroup galgs
    3.13 -  /// @{                                                                                                                                        
    3.14 +  /// \addtogroup flowalgs
    3.15 +  /// @{                                                   
    3.16 +
    3.17    ///Maximum flow algorithms class.
    3.18  
    3.19    ///This class provides various algorithms for finding a flow of
    3.20 @@ -26,17 +27,19 @@
    3.21    ///functions \ref setSource, \ref setTarget, \ref setCap and
    3.22    ///\ref setFlow. Before any subsequent runs of any algorithm of
    3.23    ///the class \ref setFlow should be called. 
    3.24 -
    3.25 +  ///
    3.26    ///After running an algorithm of the class, the actual flow value 
    3.27    ///can be obtained by calling \ref flowValue(). The minimum
    3.28    ///value cut can be written into a \c node map of \c bools by
    3.29    ///calling \ref minCut. (\ref minMinCut and \ref maxMinCut writes
    3.30    ///the inclusionwise minimum and maximum of the minimum value
    3.31 -  ///cuts, resp.)                                                                                                                               
    3.32 +  ///cuts, resp.)
    3.33 +  ///
    3.34    ///\param Graph The directed graph type the algorithm runs on.
    3.35    ///\param Num The number type of the capacities and the flow values.
    3.36    ///\param CapMap The capacity map type.
    3.37 -  ///\param FlowMap The flow map type.                                                                                                           
    3.38 +  ///\param FlowMap The flow map type.
    3.39 +  ///
    3.40    ///\author Marton Makai, Jacint Szabo 
    3.41    template <typename Graph, typename Num,
    3.42  	    typename CapMap=typename Graph::template EdgeMap<Num>,
     4.1 --- a/src/hugo/mincostflows.h	Thu Aug 05 08:53:09 2004 +0000
     4.2 +++ b/src/hugo/mincostflows.h	Thu Aug 05 11:38:26 2004 +0000
     4.3 @@ -2,7 +2,7 @@
     4.4  #ifndef HUGO_MINCOSTFLOWS_H
     4.5  #define HUGO_MINCOSTFLOWS_H
     4.6  
     4.7 -///\ingroup galgs
     4.8 +///\ingroup flowalgs
     4.9  ///\file
    4.10  ///\brief An algorithm for finding a flow of value \c k (for small values of \c k) having minimal total cost 
    4.11  
    4.12 @@ -15,7 +15,7 @@
    4.13  
    4.14  namespace hugo {
    4.15  
    4.16 -/// \addtogroup galgs
    4.17 +/// \addtogroup flowalgs
    4.18  /// @{
    4.19  
    4.20    ///\brief Implementation of an algorithm for finding a flow of value \c k 
     5.1 --- a/src/work/johanna/kruskal.h	Thu Aug 05 08:53:09 2004 +0000
     5.2 +++ b/src/work/johanna/kruskal.h	Thu Aug 05 11:38:26 2004 +0000
     5.3 @@ -5,11 +5,22 @@
     5.4  #include <algorithm>
     5.5  #include <hugo/unionfind.h>
     5.6  
     5.7 +/**
     5.8 +@defgroup spantree Minimum Cost Spanning Tree Algorithms
     5.9 +\brief This group containes the algorithms for finding a minimum cost spanning
    5.10 +tree in a graph
    5.11 +@ingroup galgs
    5.12 +*/
    5.13 +
    5.14 +///\ingroup spantree
    5.15  ///\file
    5.16  ///\brief Kruskal's algorithm to compute a minimum cost tree
    5.17  
    5.18  namespace hugo {
    5.19  
    5.20 +  /// \addtogroup spantree
    5.21 +  /// @{
    5.22 +
    5.23    /// Kruskal's algorithm to find a minimum cost tree of a graph.
    5.24  
    5.25    /// This function runs Kruskal's algorithm to find a minimum cost tree.
    5.26 @@ -293,6 +304,7 @@
    5.27      return kruskal(G, iv, out);
    5.28    }
    5.29  
    5.30 +  /// @}
    5.31  
    5.32  } //namespace hugo
    5.33