COIN-OR::LEMON - Graph Library

Changeset 1438:826bdac3525a in lemon-0.x


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

Some documentation got revised.

Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/named-param.dox

    r1141 r1438  
    4545
    4646The procedure above can also be applied when defining classes. In this case the type of the attributes can be changed.
    47 Initially we have to define a class with the default attribute types. This is the se called Traits Class. Later on
    48 the types of these attributes can be changed, as described below. In our software \ref DijkstraDefaultTraits is an example of how a traits class look like.
     47Initially we have to define a class with the default attribute types. This is the so called Traits Class. Later on
     48the types of these attributes can be changed, as described below. In our software \ref DijkstraDefaultTraits is an example of how a traits class looks like.
    4949
    5050\section named-templ-param Named Class Template Parameters
    5151
    52 If we would like to change the type of an attribute in a class that was instantiated by using a traits class as a template parameter, and the class contains named parameters, we do not have to reinstantiate the class with new traits class. Instead of that adaptor classes can be used like in the following cases.
     52If we would like to change the type of an attribute in a class that was instantiated by using a traits class as a template parameter, and the class contains named parameters, we do not have to reinstantiate the class with new traits class. Instead of that, adaptor classes can be used like in the following cases.
    5353
    5454\code
  • 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.