doc
authoralpar
Mon, 14 Jun 2004 09:47:54 +0000
changeset 6821ea8162ce638
parent 681 06a3cba90f94
child 683 3cbf51510180
doc
src/work/Doxyfile
src/work/jacint/max_matching.h
src/work/johanna/kruskal.h
src/work/klao/path.h
     1.1 --- a/src/work/Doxyfile	Mon Jun 14 09:46:03 2004 +0000
     1.2 +++ b/src/work/Doxyfile	Mon Jun 14 09:47:54 2004 +0000
     1.3 @@ -198,7 +198,7 @@
     1.4  # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
     1.5  # will be included in the documentation.
     1.6  
     1.7 -EXTRACT_PRIVATE        = NO
     1.8 +EXTRACT_PRIVATE        = YES
     1.9  
    1.10  # If the EXTRACT_STATIC tag is set to YES all static members of a file 
    1.11  # will be included in the documentation.
    1.12 @@ -391,17 +391,27 @@
    1.13  # directories like "/usr/src/myproject". Separate the files or directories 
    1.14  # with spaces.
    1.15  
    1.16 -INPUT                  = ../hugo \
    1.17 +INPUT                  = ../../doc/mainpage.dox \
    1.18 +			 ../../doc/graphs.dox \
    1.19 +                         ../../doc/maps.dox ../../doc/coding_style.dox \
    1.20 +                         ../../doc/groups.dox \
    1.21 +                         ../hugo \
    1.22                           ../hugo/skeletons \
    1.23                           ../test/test_tools.h \
    1.24                           klao/path.h \
    1.25 +                         klao/debug.h \
    1.26                           jacint/max_flow.h \
    1.27                           jacint/max_matching.h \ 
    1.28  			 marci/bfs_dfs.h \
    1.29  	  		 marci/bfs_dfs_misc.h \
    1.30  			 jacint/graph_gen.h \
    1.31  			 marci/max_bipartite_matching.h \
    1.32 -			 marci/bipartite_graph_wrapper.h
    1.33 +			 marci/bipartite_graph_wrapper.h \
    1.34 +                         deba/map_registry.h \
    1.35 +                         deba/map_defines.h \
    1.36 +                         deba/array_map_factory.h \
    1.37 +                         johanna/kruskal.h \
    1.38 +                         
    1.39  
    1.40  # If the value of the INPUT tag contains directories, you can use the 
    1.41  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
     2.1 --- a/src/work/jacint/max_matching.h	Mon Jun 14 09:46:03 2004 +0000
     2.2 +++ b/src/work/jacint/max_matching.h	Mon Jun 14 09:47:54 2004 +0000
     2.3 @@ -25,7 +25,7 @@
     2.4    ///resulting maximum matching can be attained by write-out functions
     2.5    ///\ref writeNMapNode, \ref writeNMapEdge or \ref writeEMapBool
     2.6    ///depending on the preferred container. 
     2.7 -
     2.8 +  ///
     2.9    ///The dual side of a mathcing is a map of the nodes to
    2.10    ///MaxMatching::pos_enum, having values D, A and C showing the
    2.11    ///Gallai-Edmonds decomposition of the graph. The nodes in D induce
    2.12 @@ -34,9 +34,9 @@
    2.13    ///matching. This decomposition can be attained by calling \ref
    2.14    ///writePos after running the algorithm. Before subsequent runs,
    2.15    ///the function \ref resetPos() must be called.
    2.16 -
    2.17 +  ///
    2.18    ///\param Graph The undirected graph type the algorithm runs on.
    2.19 -
    2.20 +  ///
    2.21    ///\author Jacint Szabo  
    2.22    template <typename Graph>
    2.23    class MaxMatching {
    2.24 @@ -239,7 +239,8 @@
    2.25  
    2.26      ///After calling any run methods of the class, and before calling
    2.27      ///\ref resetPos(), it writes the Gallai-Edmonds canonical
    2.28 -    ///decomposition of the graph. \c map must be a node map of \ref pos_enum 's.
    2.29 +    ///decomposition of the graph. \c map must be a node map
    2.30 +    ///of \ref pos_enum 's.
    2.31      template<typename NMapEnum>
    2.32      void writePos (NMapEnum& map) const {
    2.33        NodeIt v;
     3.1 --- a/src/work/johanna/kruskal.h	Mon Jun 14 09:46:03 2004 +0000
     3.2 +++ b/src/work/johanna/kruskal.h	Mon Jun 14 09:47:54 2004 +0000
     3.3 @@ -6,6 +6,9 @@
     3.4  #include <unionfind.h>
     3.5  #include <for_each_macros.h>
     3.6  
     3.7 +///\file
     3.8 +///\brief Kruskal's algorithm to compute a minimum cost tree
     3.9 +
    3.10  namespace hugo {
    3.11  
    3.12    /// Kruskal's algorithm to compute a minimum cost tree
     4.1 --- a/src/work/klao/path.h	Mon Jun 14 09:46:03 2004 +0000
     4.2 +++ b/src/work/klao/path.h	Mon Jun 14 09:47:54 2004 +0000
     4.3 @@ -227,7 +227,7 @@
     4.4       * PathConcept) while the builder is active (after the first modifying
     4.5       * operation and until the commit()) the original Path is in a
     4.6       * "transitional" state (operations ot it have undefined result). But
     4.7 -     * in the case of DirPath the original path is unchanged until the
     4.8 +     * in the case of DirPath the original path remains unchanged until the
     4.9       * commit. However we don't recomend that you use this feature.
    4.10       */
    4.11      class Builder {