doc/graphs.dox
changeset 2476 059dcdda37c5
parent 2391 14a343be7a5a
child 2553 bfced05fa852
     1.1 --- a/doc/graphs.dox	Wed Sep 26 14:37:48 2007 +0000
     1.2 +++ b/doc/graphs.dox	Thu Sep 27 13:04:06 2007 +0000
     1.3 @@ -16,8 +16,9 @@
     1.4   *
     1.5   */
     1.6  
     1.7 +namespace lemon {
     1.8 +
     1.9  /*!
    1.10 -
    1.11  \page graphs Graphs
    1.12  
    1.13  \todo Write a new Graphs page. I think it should be contain the Graph,
    1.14 @@ -29,39 +30,37 @@
    1.15  functionalities to list the nodes and the edges of the graph as well
    1.16  as  incoming and outgoing edges of a given node. 
    1.17  
    1.18 -Each graph should meet the \ref lemon::concepts::Graph "Graph" concept.
    1.19 +Each graph should meet the \ref concepts::Graph "Graph" concept.
    1.20  This concept does not make it possible to change the graph (i.e. it is
    1.21  not possible to add or delete edges or nodes). Most of the graph
    1.22  algorithms will run on these graphs.
    1.23  
    1.24  
    1.25  In case of graphs meeting the full feature
    1.26 -\ref lemon::concepts::ErasableGraph "ErasableGraph"
    1.27 -concept
    1.28 +\ref concepts::ErasableGraph "ErasableGraph" concept
    1.29  you can also erase individual edges and nodes in arbitrary order.
    1.30  
    1.31  The implemented graph structures are the following.
    1.32 -\li \ref lemon::ListGraph "ListGraph" is the most versatile graph class. It meets
    1.33 -the \ref lemon::concepts::ErasableGraph "ErasableGraph" concept
    1.34 +\li \ref ListGraph is the most versatile graph class. It meets
    1.35 +the \ref concepts::ErasableGraph "ErasableGraph" concept
    1.36  and it also has some convenient extra features.
    1.37 -\li \ref lemon::SmartGraph "SmartGraph" is a more memory
    1.38 -efficient version of \ref lemon::ListGraph "ListGraph". The
    1.39 -price of this is that it only meets the
    1.40 -\ref lemon::concepts::ExtendableGraph "ExtendableGraph" concept,
    1.41 +\li \ref SmartGraph is a more memory efficient version of \ref ListGraph.
    1.42 +The price of this is that it only meets the
    1.43 +\ref concepts::ExtendableGraph "ExtendableGraph" concept,
    1.44  so you cannot delete individual edges or nodes.
    1.45 -\li \ref lemon::FullGraph "FullGraph"
    1.46 +\li \ref FullGraph "FullGraph"
    1.47  implements a complete graph. It is a
    1.48 -\ref lemon::concepts::Graph "Graph", so you cannot
    1.49 +\ref concepts::Graph "Graph", so you cannot
    1.50  change the number of nodes once it is constructed. It is extremely memory
    1.51  efficient: it uses constant amount of memory independently from the number of
    1.52  the nodes of the graph. Of course, the size of the \ref maps-page "NodeMap"'s and
    1.53  \ref maps-page "EdgeMap"'s will depend on the number of nodes.
    1.54  
    1.55 -\li \ref lemon::NodeSet "NodeSet" implements a graph with no edges. This class
    1.56 +\li \ref NodeSet "NodeSet" implements a graph with no edges. This class
    1.57  can be used as a base class of \ref lemon::EdgeSet "EdgeSet".
    1.58 -\li \ref lemon::EdgeSet "EdgeSet" can be used to create a new graph on
    1.59 +\li \ref EdgeSet "EdgeSet" can be used to create a new graph on
    1.60  the node set of another graph. The base graph can be an arbitrary graph and it
    1.61 -is possible to attach several \ref lemon::EdgeSet "EdgeSet"'s to a base graph.
    1.62 +is possible to attach several \ref EdgeSet "EdgeSet"'s to a base graph.
    1.63  
    1.64  \todo Don't we need SmartNodeSet and SmartEdgeSet?
    1.65  \todo Some cross-refs are wrong.
    1.66 @@ -120,7 +119,7 @@
    1.67  node iterator to initialize it to the first node. The operator++ is used to
    1.68  step to the next node. Using operator++ on the iterator pointing to the last
    1.69  node invalidates the iterator i.e. sets its value to
    1.70 -\ref lemon::INVALID "INVALID". This is what we exploit in the stop condition.
    1.71 +\ref INVALID. This is what we exploit in the stop condition.
    1.72  
    1.73  The previous code fragment prints out the following:
    1.74  
    1.75 @@ -200,3 +199,6 @@
    1.76  your own maps. You can read more about using maps \ref maps-page "here".
    1.77  
    1.78  */
    1.79 +
    1.80 +}
    1.81 +