some docs
authormarci
Tue, 11 May 2004 11:42:02 +0000
changeset 6044acd273c3009
parent 603 86458ad390a7
child 605 b3c57602c516
some docs
src/work/Doxyfile
src/work/marci/bfs_dfs.h
src/work/marci/bfs_dfs_misc.h
     1.1 --- a/src/work/Doxyfile	Tue May 11 09:30:06 2004 +0000
     1.2 +++ b/src/work/Doxyfile	Tue May 11 11:42:02 2004 +0000
     1.3 @@ -397,7 +397,10 @@
     1.4                           athos/minlengthpaths.h \
     1.5                           klao/path.h \
     1.6                           jacint/max_flow.h \
     1.7 -                         jacint/max_matching.h
     1.8 +                         jacint/max_matching.h \ 
     1.9 +			 marci/bfs_dfs.h \
    1.10 +	  		 marci/bfs_dfs_misc.h \
    1.11 +			 jacint/graph_gen.h
    1.12  
    1.13  # If the value of the INPUT tag contains directories, you can use the 
    1.14  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
     2.1 --- a/src/work/marci/bfs_dfs.h	Tue May 11 09:30:06 2004 +0000
     2.2 +++ b/src/work/marci/bfs_dfs.h	Tue May 11 11:42:02 2004 +0000
     2.3 @@ -2,6 +2,14 @@
     2.4  #ifndef HUGO_BFS_DFS_H
     2.5  #define HUGO_BFS_DFS_H
     2.6  
     2.7 +// ///\ingroup gwrappers
     2.8 +///\file
     2.9 +///\brief Bfs and dfs iterators.
    2.10 +///
    2.11 +///This file contains bfs and dfs iterator classes.
    2.12 +///
    2.13 +// ///\author Marton Makai
    2.14 +
    2.15  #include <queue>
    2.16  #include <stack>
    2.17  #include <utility>
    2.18 @@ -37,7 +45,7 @@
    2.19      BfsIterator(const Graph& _graph) : 
    2.20        graph(&_graph), reached(*(new ReachedMap(*graph /*, false*/))), 
    2.21        own_reached_map(true) { }
    2.22 -    /// The storing the reached nodes have to be destroyed if 
    2.23 +    /// The map storing the reached nodes have to be destroyed if 
    2.24      /// it was constructed dynamically
    2.25      ~BfsIterator() { if (own_reached_map) delete &reached; }
    2.26      /// This method markes \c s reached.
    2.27 @@ -161,7 +169,7 @@
    2.28      }
    2.29      /// Beside the bfs iteration, \c pred and \dist are saved in a 
    2.30      /// newly reached node. 
    2.31 -    Bfs<Graph, ReachedMap, PredMap, DistMap> operator++() {
    2.32 +    Bfs<Graph, ReachedMap, PredMap, DistMap>& operator++() {
    2.33        Parent::operator++();
    2.34        if (this->graph->valid(this->actual_edge) && this->b_node_newly_reached) 
    2.35        {
    2.36 @@ -296,7 +304,7 @@
    2.37      }
    2.38      /// Beside the dfs iteration, \c pred is saved in a 
    2.39      /// newly reached node. 
    2.40 -    Dfs<Graph, ReachedMap, PredMap> operator++() {
    2.41 +    Dfs<Graph, ReachedMap, PredMap>& operator++() {
    2.42        Parent::operator++();
    2.43        if (this->graph->valid(this->actual_edge) && this->b_node_newly_reached) 
    2.44        {
     3.1 --- a/src/work/marci/bfs_dfs_misc.h	Tue May 11 09:30:06 2004 +0000
     3.2 +++ b/src/work/marci/bfs_dfs_misc.h	Tue May 11 11:42:02 2004 +0000
     3.3 @@ -2,6 +2,14 @@
     3.4  #ifndef HUGO_BFS_DFS_MISC_H
     3.5  #define HUGO_BFS_DFS_MISC_H
     3.6  
     3.7 +// ///\ingroup gwrappers
     3.8 +///\file
     3.9 +///\brief Miscellaneous algorithms using bfs and dfs.
    3.10 +///
    3.11 +///This file contains several algorithms using bfs and dfs.
    3.12 +///
    3.13 +// ///\author Marton Makai
    3.14 +
    3.15  #include <bfs_dfs.h>
    3.16  #include <for_each_macros.h>
    3.17