COIN-OR::LEMON - Graph Library

Changeset 1124:12623f7ecb37 in lemon-0.x


Ignore:
Timestamp:
02/05/05 14:40:01 (15 years ago)
Author:
Hegyi Péter
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1523
Message:

Dijkstra documentation is getting ready, but one decision is missing about naming conventions about named_params

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/work/alpar/dijkstra.h

    r1123 r1124  
    4949    ///The type of the map that stores the edge lengths.
    5050
     51    ///The type of the map that stores the edge lengths.
    5152    ///It must meet the \ref concept::ReadMap "ReadMap" concept.
    52     ///
    5353    typedef LM LengthMap;
    5454    //The type of the length of the edges.
     
    6868    ///edges of the shortest paths.
    6969    ///
     70    ///The type of the map that stores the last
     71    ///edges of the shortest paths.
    7072    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    7173    ///
     
    8385    ///nodes of the shortest paths.
    8486    ///
     87    ///The type of the map that stores the last but one
     88    ///nodes of the shortest paths.
    8589    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    8690    ///
     
    97101    ///The type of the map that stores whether a nodes is reached.
    98102 
     103    ///The type of the map that stores whether a nodes is reached.
    99104    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    100105    ///By default it is a NullMap.
     
    112117    ///The type of the map that stores the dists of the nodes.
    113118 
     119    ///The type of the map that stores the dists of the nodes.
    114120    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    115121    ///
     
    510516  /// Default traits used by \ref DijkstraWizard
    511517
    512   /// To make it easier to use Dijkstra algorithm we created a wizard class.
    513   /// This \ref DijkstraWizard class also needs default traits.
     518  /// To make it easier to use Dijkstra algorithm we have created a wizard class.
     519  /// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
    514520  /// The \ref DijkstraWizardBase is a class to be the default traits of the
    515521  /// \ref DijkstraWizard class.
     
    565571  /// Simplicity means that the way to change the types defined
    566572  /// in the traits class is based on functions that returns the new class
    567   /// and not on templatable built-in classes. When using the plain \Dijkstra
    568   /// the new class with the modified type comes from the original by using the ::
    569   /// operator. In this case only a function have to be called and it will
     573  /// and not on templatable built-in classes. When using the plain \ref Dijkstra
     574  /// the new class with the modified type comes from the original class by using the ::
     575  /// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
    570576  /// return the needed class.
    571577  ///
     
    609615
    610616    /// Constructor that requires parameters.
     617
     618    /// Constructor that requires parameters.
    611619    /// These parameters will be the default values for the traits class.
    612620    DijkstraWizard(const Graph &g,const LengthMap &l, Node s=INVALID) :
     
    632640    }
    633641
    634     ///Runs Dijkstra algorithm from a given node.
    635 
    636     ///Runs Dijkstra algorithm from a given node.
     642    ///Runs Dijkstra algorithm from the given node.
     643
     644    ///Runs Dijkstra algorithm from the given node.
    637645    ///\param s is the given source.
    638646    void run(Node s)
     
    652660
    653661    /// \ref named-templ-param "Named parameter" function for setting PredMap type
     662    ///
    654663    template<class T>
    655664    DijkstraWizard<DefPredMapBase<T> > predMap(const T &t)
     
    670679
    671680    /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
     681    ///
    672682    template<class T>
    673683    DijkstraWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t)
     
    687697
    688698    /// \ref named-templ-param "Named parameter" function for setting DistMap type
     699    ///
    689700    template<class T>
    690701    DijkstraWizard<DefDistMapBase<T> > distMap(const T &t)
Note: See TracChangeset for help on using the changeset viewer.