COIN-OR::LEMON - Graph Library

Changeset 1438:826bdac3525a in lemon-0.x for lemon


Ignore:
Timestamp:
05/26/05 17:33:16 (15 years ago)
Author:
athos
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1913
Message:

Some documentation got revised.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/dfs.h

    r1435 r1438  
    601601    ///
    602602    ///\param nm must be a bool (or convertible) edge map. The algorithm
    603     ///will stop when it reaches a edge \c v with <tt>nm[v]==true</tt>.
    604     ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c mn is an edge map,
     603    ///will stop when it reaches an edge \c e with <tt>nm[e]==true</tt>.
     604    ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c nm is an edge map,
    605605    ///not a node map.
    606606    template<class NM>
     
    664664   
    665665    ///This function copies the path on the DFS tree to \c t into \c p.
    666     ///If it \c \t is a source itself or unreachable, then it does not
     666    ///If \c t is a source itself or unreachable, then it does not
    667667    ///alter \c p.
    668     ///\todo Is it the right way to handle unreachable nodes?
     668    ///\todo Is this the right way to handle unreachable nodes?
     669    ///
    669670    ///\return Returns \c true if a path to \c t was actually copied to \c p,
    670671    ///\c false otherwise.
     
    688689    ///Returns the distance of a node from the root(s).
    689690    ///\pre \ref run() must be called before using this function.
    690     ///\warning If node \c v in unreachable from the root(s) the return value
     691    ///\warning If node \c v is unreachable from the root(s) then the return value
    691692    ///of this funcion is undefined.
    692693    int dist(Node v) const { return (*_dist)[v]; }
     
    745746    ///Checks if a node is reachable from the root.
    746747
    747     ///Returns \c true if \c v is reachable from the root.
    748     ///\warning The source nodes are inditated as unreached.
     748    ///Returns \c true if \c v is reachable from the root(s).
     749    ///\warning The source nodes are inditated as unreachable.
    749750    ///\pre Either \ref run() or \ref start()
    750751    ///must be called before using this function.
     
    917918  ///
    918919  /// It does not have own \ref run method. When its \ref run method is called
    919   /// it initiates a plain \ref Dfs class, and calls the \ref Dfs::run
     920  /// it initiates a plain \ref Dfs object, and calls the \ref Dfs::run
    920921  /// method of it.
    921922  template<class TR>
Note: See TracChangeset for help on using the changeset viewer.