COIN-OR::LEMON - Graph Library

Changeset 1443:70781827eb2f in lemon-0.x


Ignore:
Timestamp:
06/02/05 16:43:45 (14 years ago)
Author:
athos
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1920
Message:

Documentation review.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/dfs.h

    r1438 r1443  
    500500    ///Adds a new source node to the set of nodes to be processed.
    501501    ///
    502     ///\bug dist's are wrong (or at least strange) in case of multiple sources.
     502    ///\bug dists are wrong (or at least strange) in case of multiple sources.
    503503    void addSource(Node s)
    504504    {
     
    517517    ///Processes the next node.
    518518    ///
    519     ///\warning The stack must not be empty!
     519    ///\pre The stack must not be empty!
    520520    void processNextEdge()
    521521    {
     
    566566    ///%DFS path to each node. The algorithm computes
    567567    ///- The %DFS tree.
    568     ///- The distance of each node from the root(s).
     568    ///- The distance of each node from the root(s) in the %DFS tree.
    569569    ///
    570570    void start()
     
    585585    ///%DFS path to \c dest. The algorithm computes
    586586    ///- The %DFS path to \c  dest.
    587     ///- The distance of \c dest from the root(s).
     587    ///- The distance of \c dest from the root(s) in the %DFS tree.
    588588    ///
    589589    void start(Node dest)
     
    602602    ///\param nm must be a bool (or convertible) edge map. The algorithm
    603603    ///will stop when it reaches an edge \c e with <tt>nm[e]==true</tt>.
     604    ///
    604605    ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c nm is an edge map,
    605606    ///not a node map.
     
    617618    ///%DFS path to each node. The algorithm computes
    618619    ///- The %DFS tree.
    619     ///- The distance of each node from the root.
     620    ///- The distance of each node from the root in the %DFS tree.
    620621    ///
    621622    ///\note d.run(s) is just a shortcut of the following code.
     
    663664    ///Copies the path to \c t on the DFS tree into \c p
    664665   
    665     ///This function copies the path on the DFS tree to \c t into \c p.
     666    ///This function copies the path to \c t on the DFS tree into \c p.
    666667    ///If \c t is a source itself or unreachable, then it does not
    667668    ///alter \c p.
     
    901902  };
    902903 
    903   /// A class to make the usage of Dfs algorithm easier
    904 
    905   /// This class is created to make it easier to use Dfs algorithm.
     904  /// A class to make the usage of the Dfs algorithm easier
     905
     906  /// This class is created to make it easier to use the Dfs algorithm.
    906907  /// It uses the functions and features of the plain \ref Dfs,
    907908  /// but it is much simpler to use it.
     
    948949//     ///nodes of the %DFS paths.
    949950//     typedef typename TR::PredNodeMap PredNodeMap;
    950     ///The type of the map that stores the dists of the nodes.
     951    ///The type of the map that stores the distances of the nodes.
    951952    typedef typename TR::DistMap DistMap;
    952953
Note: See TracChangeset for help on using the changeset viewer.