1.1 --- a/lemon/bfs.h Tue Oct 07 07:08:45 2008 +0100
1.2 +++ b/lemon/bfs.h Wed Oct 08 13:40:20 2008 +0200
1.3 @@ -49,11 +49,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 @@ -64,11 +64,11 @@
1.19 ///The type of the map that indicates which nodes are processed.
1.20 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
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 @@ -83,11 +83,11 @@
1.34 ///The type of the map that indicates which nodes are reached.
1.35 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
1.36 typedef typename Digraph::template NodeMap<bool> ReachedMap;
1.37 - ///Instantiates a \ref ReachedMap.
1.38 + ///Instantiates a ReachedMap.
1.39
1.40 - ///This function instantiates a \ref ReachedMap.
1.41 + ///This function instantiates a ReachedMap.
1.42 ///\param g is the digraph, to which
1.43 - ///we would like to define the \ref ReachedMap.
1.44 + ///we would like to define the ReachedMap.
1.45 static ReachedMap *createReachedMap(const Digraph &g)
1.46 {
1.47 return new ReachedMap(g);
1.48 @@ -98,11 +98,11 @@
1.49 ///The type of the map that stores the distances of the nodes.
1.50 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
1.51 typedef typename Digraph::template NodeMap<int> DistMap;
1.52 - ///Instantiates a \ref DistMap.
1.53 + ///Instantiates a DistMap.
1.54
1.55 - ///This function instantiates a \ref DistMap.
1.56 + ///This function instantiates a DistMap.
1.57 ///\param g is the digraph, to which we would like to define the
1.58 - ///\ref DistMap.
1.59 + ///DistMap.
1.60 static DistMap *createDistMap(const Digraph &g)
1.61 {
1.62 return new DistMap(g);
1.63 @@ -227,10 +227,10 @@
1.64 }
1.65 };
1.66 ///\brief \ref named-templ-param "Named parameter" for setting
1.67 - ///\ref PredMap type.
1.68 + ///PredMap type.
1.69 ///
1.70 ///\ref named-templ-param "Named parameter" for setting
1.71 - ///\ref PredMap type.
1.72 + ///PredMap type.
1.73 template <class T>
1.74 struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > {
1.75 typedef Bfs< Digraph, SetPredMapTraits<T> > Create;
1.76 @@ -246,10 +246,10 @@
1.77 }
1.78 };
1.79 ///\brief \ref named-templ-param "Named parameter" for setting
1.80 - ///\ref DistMap type.
1.81 + ///DistMap type.
1.82 ///
1.83 ///\ref named-templ-param "Named parameter" for setting
1.84 - ///\ref DistMap type.
1.85 + ///DistMap type.
1.86 template <class T>
1.87 struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > {
1.88 typedef Bfs< Digraph, SetDistMapTraits<T> > Create;
1.89 @@ -265,10 +265,10 @@
1.90 }
1.91 };
1.92 ///\brief \ref named-templ-param "Named parameter" for setting
1.93 - ///\ref ReachedMap type.
1.94 + ///ReachedMap type.
1.95 ///
1.96 ///\ref named-templ-param "Named parameter" for setting
1.97 - ///\ref ReachedMap type.
1.98 + ///ReachedMap type.
1.99 template <class T>
1.100 struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > {
1.101 typedef Bfs< Digraph, SetReachedMapTraits<T> > Create;
1.102 @@ -284,10 +284,10 @@
1.103 }
1.104 };
1.105 ///\brief \ref named-templ-param "Named parameter" for setting
1.106 - ///\ref ProcessedMap type.
1.107 + ///ProcessedMap type.
1.108 ///
1.109 ///\ref named-templ-param "Named parameter" for setting
1.110 - ///\ref ProcessedMap type.
1.111 + ///ProcessedMap type.
1.112 template <class T>
1.113 struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > {
1.114 typedef Bfs< Digraph, SetProcessedMapTraits<T> > Create;
1.115 @@ -302,10 +302,10 @@
1.116 }
1.117 };
1.118 ///\brief \ref named-templ-param "Named parameter" for setting
1.119 - ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
1.120 + ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
1.121 ///
1.122 ///\ref named-templ-param "Named parameter" for setting
1.123 - ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
1.124 + ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
1.125 ///If you don't set it explicitly, it will be automatically allocated.
1.126 struct SetStandardProcessedMap :
1.127 public Bfs< Digraph, SetStandardProcessedMapTraits > {
1.128 @@ -835,11 +835,11 @@
1.129 ///arcs of the shortest paths.
1.130 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
1.131 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
1.132 - ///Instantiates a \ref PredMap.
1.133 + ///Instantiates a PredMap.
1.134
1.135 - ///This function instantiates a \ref PredMap.
1.136 + ///This function instantiates a PredMap.
1.137 ///\param g is the digraph, to which we would like to define the
1.138 - ///\ref PredMap.
1.139 + ///PredMap.
1.140 static PredMap *createPredMap(const Digraph &g)
1.141 {
1.142 return new PredMap(g);
1.143 @@ -851,11 +851,11 @@
1.144 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
1.145 ///By default it is a NullMap.
1.146 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
1.147 - ///Instantiates a \ref ProcessedMap.
1.148 + ///Instantiates a ProcessedMap.
1.149
1.150 - ///This function instantiates a \ref ProcessedMap.
1.151 + ///This function instantiates a ProcessedMap.
1.152 ///\param g is the digraph, to which
1.153 - ///we would like to define the \ref ProcessedMap.
1.154 + ///we would like to define the ProcessedMap.
1.155 #ifdef DOXYGEN
1.156 static ProcessedMap *createProcessedMap(const Digraph &g)
1.157 #else
1.158 @@ -870,11 +870,11 @@
1.159 ///The type of the map that indicates which nodes are reached.
1.160 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
1.161 typedef typename Digraph::template NodeMap<bool> ReachedMap;
1.162 - ///Instantiates a \ref ReachedMap.
1.163 + ///Instantiates a ReachedMap.
1.164
1.165 - ///This function instantiates a \ref ReachedMap.
1.166 + ///This function instantiates a ReachedMap.
1.167 ///\param g is the digraph, to which
1.168 - ///we would like to define the \ref ReachedMap.
1.169 + ///we would like to define the ReachedMap.
1.170 static ReachedMap *createReachedMap(const Digraph &g)
1.171 {
1.172 return new ReachedMap(g);
1.173 @@ -885,11 +885,11 @@
1.174 ///The type of the map that stores the distances of the nodes.
1.175 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
1.176 typedef typename Digraph::template NodeMap<int> DistMap;
1.177 - ///Instantiates a \ref DistMap.
1.178 + ///Instantiates a DistMap.
1.179
1.180 - ///This function instantiates a \ref DistMap.
1.181 + ///This function instantiates a DistMap.
1.182 ///\param g is the digraph, to which we would like to define
1.183 - ///the \ref DistMap
1.184 + ///the DistMap
1.185 static DistMap *createDistMap(const Digraph &g)
1.186 {
1.187 return new DistMap(g);
1.188 @@ -902,7 +902,7 @@
1.189 typedef lemon::Path<Digraph> Path;
1.190 };
1.191
1.192 - /// Default traits class used by \ref BfsWizard
1.193 + /// Default traits class used by BfsWizard
1.194
1.195 /// To make it easier to use Bfs algorithm
1.196 /// we have created a wizard class.
1.197 @@ -1068,10 +1068,10 @@
1.198 SetPredMapBase(const TR &b) : TR(b) {}
1.199 };
1.200 ///\brief \ref named-func-param "Named parameter"
1.201 - ///for setting \ref PredMap object.
1.202 + ///for setting PredMap object.
1.203 ///
1.204 ///\ref named-func-param "Named parameter"
1.205 - ///for setting \ref PredMap object.
1.206 + ///for setting PredMap object.
1.207 template<class T>
1.208 BfsWizard<SetPredMapBase<T> > predMap(const T &t)
1.209 {
1.210 @@ -1086,10 +1086,10 @@
1.211 SetReachedMapBase(const TR &b) : TR(b) {}
1.212 };
1.213 ///\brief \ref named-func-param "Named parameter"
1.214 - ///for setting \ref ReachedMap object.
1.215 + ///for setting ReachedMap object.
1.216 ///
1.217 /// \ref named-func-param "Named parameter"
1.218 - ///for setting \ref ReachedMap object.
1.219 + ///for setting ReachedMap object.
1.220 template<class T>
1.221 BfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
1.222 {
1.223 @@ -1104,10 +1104,10 @@
1.224 SetDistMapBase(const TR &b) : TR(b) {}
1.225 };
1.226 ///\brief \ref named-func-param "Named parameter"
1.227 - ///for setting \ref DistMap object.
1.228 + ///for setting DistMap object.
1.229 ///
1.230 /// \ref named-func-param "Named parameter"
1.231 - ///for setting \ref DistMap object.
1.232 + ///for setting DistMap object.
1.233 template<class T>
1.234 BfsWizard<SetDistMapBase<T> > distMap(const T &t)
1.235 {
1.236 @@ -1122,10 +1122,10 @@
1.237 SetProcessedMapBase(const TR &b) : TR(b) {}
1.238 };
1.239 ///\brief \ref named-func-param "Named parameter"
1.240 - ///for setting \ref ProcessedMap object.
1.241 + ///for setting ProcessedMap object.
1.242 ///
1.243 /// \ref named-func-param "Named parameter"
1.244 - ///for setting \ref ProcessedMap object.
1.245 + ///for setting ProcessedMap object.
1.246 template<class T>
1.247 BfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
1.248 {
1.249 @@ -1267,11 +1267,11 @@
1.250 /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
1.251 typedef typename Digraph::template NodeMap<bool> ReachedMap;
1.252
1.253 - /// \brief Instantiates a \ref ReachedMap.
1.254 + /// \brief Instantiates a ReachedMap.
1.255 ///
1.256 - /// This function instantiates a \ref ReachedMap.
1.257 + /// This function instantiates a ReachedMap.
1.258 /// \param digraph is the digraph, to which
1.259 - /// we would like to define the \ref ReachedMap.
1.260 + /// we would like to define the ReachedMap.
1.261 static ReachedMap *createReachedMap(const Digraph &digraph) {
1.262 return new ReachedMap(digraph);
1.263 }