Improved docs.
authoralpar
Thu, 09 Sep 2004 07:09:41 +0000
changeset 825738abd9d1262
parent 824 157115b5814a
child 826 056fbb112b30
Improved docs.
src/hugo/list_graph.h
src/test/test_tools.h
     1.1 --- a/src/hugo/list_graph.h	Thu Sep 09 07:09:11 2004 +0000
     1.2 +++ b/src/hugo/list_graph.h	Thu Sep 09 07:09:41 2004 +0000
     1.3 @@ -25,15 +25,13 @@
     1.4  /// \addtogroup graphs
     1.5  /// @{
     1.6  
     1.7 -//  class SymListGraph;
     1.8 -
     1.9    ///A list graph class.
    1.10  
    1.11    ///This is a simple and fast erasable graph implementation.
    1.12    ///
    1.13    ///It conforms to the graph interface documented under
    1.14 -  ///the description of \ref GraphSkeleton.
    1.15 -  ///\sa \ref GraphSkeleton.
    1.16 +  ///the description of \ref ErasableGraphSkeleton.
    1.17 +  ///\sa \ref ErasableGraphSkeleton.
    1.18    class ListGraph {
    1.19  
    1.20      //Nodes are double linked.
    1.21 @@ -42,7 +40,6 @@
    1.22      {
    1.23        int first_in,first_out;
    1.24        int prev, next;
    1.25 -      //      NodeT() {}
    1.26      };
    1.27      //Edges are double linked.
    1.28      //The free edges are only single linked using the "next_in" field.
    1.29 @@ -51,8 +48,6 @@
    1.30        int head, tail;
    1.31        int prev_in, prev_out;
    1.32        int next_in, next_out;
    1.33 -      //FIXME: is this necessary?
    1.34 -      //      EdgeT() : next_in(-1), next_out(-1) prev_in(-1), prev_out(-1) {}  
    1.35      };
    1.36  
    1.37      std::vector<NodeT> nodes;
     2.1 --- a/src/test/test_tools.h	Thu Sep 09 07:09:11 2004 +0000
     2.2 +++ b/src/test/test_tools.h	Thu Sep 09 07:09:41 2004 +0000
     2.3 @@ -34,10 +34,16 @@
     2.4  ///
     2.5  template<class Graph> struct PetStruct
     2.6  {
     2.7 -  ///.
     2.8 -  std::vector<typename Graph::Node> outer, inner;
     2.9 -  ///.
    2.10 -  std::vector<typename Graph::Edge> outcir, incir, chords;
    2.11 +  ///Vector containing the outer nodes.
    2.12 +  std::vector<typename Graph::Node> outer;
    2.13 +  ///Vector containing the inner nodes.
    2.14 +  std::vector<typename Graph::Node> inner;
    2.15 +  ///Vector containing the edges of the inner circle.
    2.16 +  std::vector<typename Graph::Edge> incir;
    2.17 +  ///Vector containing the edges of the outer circle.
    2.18 +  std::vector<typename Graph::Edge> outcir;
    2.19 +  ///Vector containing the chord edges.
    2.20 +  std::vector<typename Graph::Edge> chords;
    2.21  };
    2.22  
    2.23  
    2.24 @@ -45,7 +51,7 @@
    2.25  ///Adds a Petersen graph to \c G.
    2.26  
    2.27  ///Adds a Petersen graph to \c G.
    2.28 -///The nodes end edges will be listed in the return structure.
    2.29 +///\return The nodes end edges og the generated graph.
    2.30  
    2.31  template<typename Graph>
    2.32  PetStruct<Graph> addPetersen(Graph &G,int num=5)