COIN-OR::LEMON - Graph Library

Changeset 2476:059dcdda37c5 in lemon-0.x for doc/graphs.dox


Ignore:
Timestamp:
09/27/07 15:04:06 (12 years ago)
Author:
Peter Kovacs
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3315
Message:

Bug fixes in the documentation (mainly bad references).

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/graphs.dox

    r2391 r2476  
    1717 */
    1818
     19namespace lemon {
     20
    1921/*!
    20 
    2122\page graphs Graphs
    2223
     
    3031as  incoming and outgoing edges of a given node.
    3132
    32 Each graph should meet the \ref lemon::concepts::Graph "Graph" concept.
     33Each graph should meet the \ref concepts::Graph "Graph" concept.
    3334This concept does not make it possible to change the graph (i.e. it is
    3435not possible to add or delete edges or nodes). Most of the graph
     
    3738
    3839In case of graphs meeting the full feature
    39 \ref lemon::concepts::ErasableGraph "ErasableGraph"
    40 concept
     40\ref concepts::ErasableGraph "ErasableGraph" concept
    4141you can also erase individual edges and nodes in arbitrary order.
    4242
    4343The implemented graph structures are the following.
    44 \li \ref lemon::ListGraph "ListGraph" is the most versatile graph class. It meets
    45 the \ref lemon::concepts::ErasableGraph "ErasableGraph" concept
     44\li \ref ListGraph is the most versatile graph class. It meets
     45the \ref concepts::ErasableGraph "ErasableGraph" concept
    4646and it also has some convenient extra features.
    47 \li \ref lemon::SmartGraph "SmartGraph" is a more memory
    48 efficient version of \ref lemon::ListGraph "ListGraph". The
    49 price of this is that it only meets the
    50 \ref lemon::concepts::ExtendableGraph "ExtendableGraph" concept,
     47\li \ref SmartGraph is a more memory efficient version of \ref ListGraph.
     48The price of this is that it only meets the
     49\ref concepts::ExtendableGraph "ExtendableGraph" concept,
    5150so you cannot delete individual edges or nodes.
    52 \li \ref lemon::FullGraph "FullGraph"
     51\li \ref FullGraph "FullGraph"
    5352implements a complete graph. It is a
    54 \ref lemon::concepts::Graph "Graph", so you cannot
     53\ref concepts::Graph "Graph", so you cannot
    5554change the number of nodes once it is constructed. It is extremely memory
    5655efficient: it uses constant amount of memory independently from the number of
     
    5857\ref maps-page "EdgeMap"'s will depend on the number of nodes.
    5958
    60 \li \ref lemon::NodeSet "NodeSet" implements a graph with no edges. This class
     59\li \ref NodeSet "NodeSet" implements a graph with no edges. This class
    6160can be used as a base class of \ref lemon::EdgeSet "EdgeSet".
    62 \li \ref lemon::EdgeSet "EdgeSet" can be used to create a new graph on
     61\li \ref EdgeSet "EdgeSet" can be used to create a new graph on
    6362the node set of another graph. The base graph can be an arbitrary graph and it
    64 is possible to attach several \ref lemon::EdgeSet "EdgeSet"'s to a base graph.
     63is possible to attach several \ref EdgeSet "EdgeSet"'s to a base graph.
    6564
    6665\todo Don't we need SmartNodeSet and SmartEdgeSet?
     
    121120step to the next node. Using operator++ on the iterator pointing to the last
    122121node invalidates the iterator i.e. sets its value to
    123 \ref lemon::INVALID "INVALID". This is what we exploit in the stop condition.
     122\ref INVALID. This is what we exploit in the stop condition.
    124123
    125124The previous code fragment prints out the following:
     
    201200
    202201*/
     202
     203}
     204
Note: See TracChangeset for help on using the changeset viewer.