lemon/dijkstra.h
changeset 317 a0ab96ad65fe
parent 301 9db8964f0cf6
child 397 62f9787c516c
child 405 6b9057cdcd8b
     1.1 --- a/lemon/dijkstra.h	Thu Oct 09 16:47:01 2008 +0200
     1.2 +++ b/lemon/dijkstra.h	Thu Oct 09 16:20:37 2008 +0100
     1.3 @@ -139,11 +139,11 @@
     1.4      ///arcs of the shortest paths.
     1.5      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
     1.6      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
     1.7 -    ///Instantiates a \ref PredMap.
     1.8 +    ///Instantiates a PredMap.
     1.9  
    1.10 -    ///This function instantiates a \ref PredMap.
    1.11 +    ///This function instantiates a PredMap.
    1.12      ///\param g is the digraph, to which we would like to define the
    1.13 -    ///\ref PredMap.
    1.14 +    ///PredMap.
    1.15      static PredMap *createPredMap(const Digraph &g)
    1.16      {
    1.17        return new PredMap(g);
    1.18 @@ -155,11 +155,11 @@
    1.19      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.20      ///By default it is a NullMap.
    1.21      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    1.22 -    ///Instantiates a \ref ProcessedMap.
    1.23 +    ///Instantiates a ProcessedMap.
    1.24  
    1.25 -    ///This function instantiates a \ref ProcessedMap.
    1.26 +    ///This function instantiates a ProcessedMap.
    1.27      ///\param g is the digraph, to which
    1.28 -    ///we would like to define the \ref ProcessedMap
    1.29 +    ///we would like to define the ProcessedMap
    1.30  #ifdef DOXYGEN
    1.31      static ProcessedMap *createProcessedMap(const Digraph &g)
    1.32  #else
    1.33 @@ -174,11 +174,11 @@
    1.34      ///The type of the map that stores the distances of the nodes.
    1.35      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.36      typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
    1.37 -    ///Instantiates a \ref DistMap.
    1.38 +    ///Instantiates a DistMap.
    1.39  
    1.40 -    ///This function instantiates a \ref DistMap.
    1.41 +    ///This function instantiates a DistMap.
    1.42      ///\param g is the digraph, to which we would like to define
    1.43 -    ///the \ref DistMap
    1.44 +    ///the DistMap
    1.45      static DistMap *createDistMap(const Digraph &g)
    1.46      {
    1.47        return new DistMap(g);
    1.48 @@ -327,10 +327,10 @@
    1.49        }
    1.50      };
    1.51      ///\brief \ref named-templ-param "Named parameter" for setting
    1.52 -    ///\ref PredMap type.
    1.53 +    ///PredMap type.
    1.54      ///
    1.55      ///\ref named-templ-param "Named parameter" for setting
    1.56 -    ///\ref PredMap type.
    1.57 +    ///PredMap type.
    1.58      template <class T>
    1.59      struct SetPredMap
    1.60        : public Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > {
    1.61 @@ -347,10 +347,10 @@
    1.62        }
    1.63      };
    1.64      ///\brief \ref named-templ-param "Named parameter" for setting
    1.65 -    ///\ref DistMap type.
    1.66 +    ///DistMap type.
    1.67      ///
    1.68      ///\ref named-templ-param "Named parameter" for setting
    1.69 -    ///\ref DistMap type.
    1.70 +    ///DistMap type.
    1.71      template <class T>
    1.72      struct SetDistMap
    1.73        : public Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > {
    1.74 @@ -367,10 +367,10 @@
    1.75        }
    1.76      };
    1.77      ///\brief \ref named-templ-param "Named parameter" for setting
    1.78 -    ///\ref ProcessedMap type.
    1.79 +    ///ProcessedMap type.
    1.80      ///
    1.81      ///\ref named-templ-param "Named parameter" for setting
    1.82 -    ///\ref ProcessedMap type.
    1.83 +    ///ProcessedMap type.
    1.84      template <class T>
    1.85      struct SetProcessedMap
    1.86        : public Dijkstra< Digraph, LengthMap, SetProcessedMapTraits<T> > {
    1.87 @@ -385,10 +385,10 @@
    1.88        }
    1.89      };
    1.90      ///\brief \ref named-templ-param "Named parameter" for setting
    1.91 -    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
    1.92 +    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
    1.93      ///
    1.94      ///\ref named-templ-param "Named parameter" for setting
    1.95 -    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
    1.96 +    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
    1.97      ///If you don't set it explicitly, it will be automatically allocated.
    1.98      struct SetStandardProcessedMap
    1.99        : public Dijkstra< Digraph, LengthMap, SetStandardProcessedMapTraits > {
   1.100 @@ -453,7 +453,7 @@
   1.101      };
   1.102  
   1.103      /// \brief \ref named-templ-param "Named parameter" for setting
   1.104 -    ///\ref OperationTraits type
   1.105 +    ///\c OperationTraits type
   1.106      ///
   1.107      ///\ref named-templ-param "Named parameter" for setting
   1.108      ///\ref OperationTraits type.
   1.109 @@ -986,11 +986,11 @@
   1.110      ///arcs of the shortest paths.
   1.111      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   1.112      typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
   1.113 -    ///Instantiates a \ref PredMap.
   1.114 +    ///Instantiates a PredMap.
   1.115  
   1.116 -    ///This function instantiates a \ref PredMap.
   1.117 +    ///This function instantiates a PredMap.
   1.118      ///\param g is the digraph, to which we would like to define the
   1.119 -    ///\ref PredMap.
   1.120 +    ///PredMap.
   1.121      static PredMap *createPredMap(const Digraph &g)
   1.122      {
   1.123        return new PredMap(g);
   1.124 @@ -1002,11 +1002,11 @@
   1.125      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   1.126      ///By default it is a NullMap.
   1.127      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
   1.128 -    ///Instantiates a \ref ProcessedMap.
   1.129 +    ///Instantiates a ProcessedMap.
   1.130  
   1.131 -    ///This function instantiates a \ref ProcessedMap.
   1.132 +    ///This function instantiates a ProcessedMap.
   1.133      ///\param g is the digraph, to which
   1.134 -    ///we would like to define the \ref ProcessedMap.
   1.135 +    ///we would like to define the ProcessedMap.
   1.136  #ifdef DOXYGEN
   1.137      static ProcessedMap *createProcessedMap(const Digraph &g)
   1.138  #else
   1.139 @@ -1021,11 +1021,11 @@
   1.140      ///The type of the map that stores the distances of the nodes.
   1.141      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
   1.142      typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
   1.143 -    ///Instantiates a \ref DistMap.
   1.144 +    ///Instantiates a DistMap.
   1.145  
   1.146 -    ///This function instantiates a \ref DistMap.
   1.147 +    ///This function instantiates a DistMap.
   1.148      ///\param g is the digraph, to which we would like to define
   1.149 -    ///the \ref DistMap
   1.150 +    ///the DistMap
   1.151      static DistMap *createDistMap(const Digraph &g)
   1.152      {
   1.153        return new DistMap(g);
   1.154 @@ -1038,7 +1038,7 @@
   1.155      typedef lemon::Path<Digraph> Path;
   1.156    };
   1.157  
   1.158 -  /// Default traits class used by \ref DijkstraWizard
   1.159 +  /// Default traits class used by DijkstraWizard
   1.160  
   1.161    /// To make it easier to use Dijkstra algorithm
   1.162    /// we have created a wizard class.
   1.163 @@ -1198,10 +1198,10 @@
   1.164        SetPredMapBase(const TR &b) : TR(b) {}
   1.165      };
   1.166      ///\brief \ref named-func-param "Named parameter"
   1.167 -    ///for setting \ref PredMap object.
   1.168 +    ///for setting PredMap object.
   1.169      ///
   1.170      ///\ref named-func-param "Named parameter"
   1.171 -    ///for setting \ref PredMap object.
   1.172 +    ///for setting PredMap object.
   1.173      template<class T>
   1.174      DijkstraWizard<SetPredMapBase<T> > predMap(const T &t)
   1.175      {
   1.176 @@ -1216,10 +1216,10 @@
   1.177        SetDistMapBase(const TR &b) : TR(b) {}
   1.178      };
   1.179      ///\brief \ref named-func-param "Named parameter"
   1.180 -    ///for setting \ref DistMap object.
   1.181 +    ///for setting DistMap object.
   1.182      ///
   1.183      ///\ref named-func-param "Named parameter"
   1.184 -    ///for setting \ref DistMap object.
   1.185 +    ///for setting DistMap object.
   1.186      template<class T>
   1.187      DijkstraWizard<SetDistMapBase<T> > distMap(const T &t)
   1.188      {
   1.189 @@ -1234,10 +1234,10 @@
   1.190        SetProcessedMapBase(const TR &b) : TR(b) {}
   1.191      };
   1.192      ///\brief \ref named-func-param "Named parameter"
   1.193 -    ///for setting \ref ProcessedMap object.
   1.194 +    ///for setting ProcessedMap object.
   1.195      ///
   1.196      /// \ref named-func-param "Named parameter"
   1.197 -    ///for setting \ref ProcessedMap object.
   1.198 +    ///for setting ProcessedMap object.
   1.199      template<class T>
   1.200      DijkstraWizard<SetProcessedMapBase<T> > processedMap(const T &t)
   1.201      {