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 }
2.1 --- a/lemon/dfs.h Tue Oct 07 07:08:45 2008 +0100
2.2 +++ b/lemon/dfs.h Wed Oct 08 13:40:20 2008 +0200
2.3 @@ -50,11 +50,11 @@
2.4 ///arcs of the %DFS paths.
2.5 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
2.6 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
2.7 - ///Instantiates a \ref PredMap.
2.8 + ///Instantiates a PredMap.
2.9
2.10 - ///This function instantiates a \ref PredMap.
2.11 + ///This function instantiates a PredMap.
2.12 ///\param g is the digraph, to which we would like to define the
2.13 - ///\ref PredMap.
2.14 + ///PredMap.
2.15 static PredMap *createPredMap(const Digraph &g)
2.16 {
2.17 return new PredMap(g);
2.18 @@ -65,11 +65,11 @@
2.19 ///The type of the map that indicates which nodes are processed.
2.20 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
2.21 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
2.22 - ///Instantiates a \ref ProcessedMap.
2.23 + ///Instantiates a ProcessedMap.
2.24
2.25 - ///This function instantiates a \ref ProcessedMap.
2.26 + ///This function instantiates a ProcessedMap.
2.27 ///\param g is the digraph, to which
2.28 - ///we would like to define the \ref ProcessedMap
2.29 + ///we would like to define the ProcessedMap
2.30 #ifdef DOXYGEN
2.31 static ProcessedMap *createProcessedMap(const Digraph &g)
2.32 #else
2.33 @@ -84,11 +84,11 @@
2.34 ///The type of the map that indicates which nodes are reached.
2.35 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
2.36 typedef typename Digraph::template NodeMap<bool> ReachedMap;
2.37 - ///Instantiates a \ref ReachedMap.
2.38 + ///Instantiates a ReachedMap.
2.39
2.40 - ///This function instantiates a \ref ReachedMap.
2.41 + ///This function instantiates a ReachedMap.
2.42 ///\param g is the digraph, to which
2.43 - ///we would like to define the \ref ReachedMap.
2.44 + ///we would like to define the ReachedMap.
2.45 static ReachedMap *createReachedMap(const Digraph &g)
2.46 {
2.47 return new ReachedMap(g);
2.48 @@ -99,11 +99,11 @@
2.49 ///The type of the map that stores the distances of the nodes.
2.50 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
2.51 typedef typename Digraph::template NodeMap<int> DistMap;
2.52 - ///Instantiates a \ref DistMap.
2.53 + ///Instantiates a DistMap.
2.54
2.55 - ///This function instantiates a \ref DistMap.
2.56 + ///This function instantiates a DistMap.
2.57 ///\param g is the digraph, to which we would like to define the
2.58 - ///\ref DistMap.
2.59 + ///DistMap.
2.60 static DistMap *createDistMap(const Digraph &g)
2.61 {
2.62 return new DistMap(g);
2.63 @@ -227,10 +227,10 @@
2.64 }
2.65 };
2.66 ///\brief \ref named-templ-param "Named parameter" for setting
2.67 - ///\ref PredMap type.
2.68 + ///PredMap type.
2.69 ///
2.70 ///\ref named-templ-param "Named parameter" for setting
2.71 - ///\ref PredMap type.
2.72 + ///PredMap type.
2.73 template <class T>
2.74 struct SetPredMap : public Dfs<Digraph, SetPredMapTraits<T> > {
2.75 typedef Dfs<Digraph, SetPredMapTraits<T> > Create;
2.76 @@ -246,10 +246,10 @@
2.77 }
2.78 };
2.79 ///\brief \ref named-templ-param "Named parameter" for setting
2.80 - ///\ref DistMap type.
2.81 + ///DistMap type.
2.82 ///
2.83 ///\ref named-templ-param "Named parameter" for setting
2.84 - ///\ref DistMap type.
2.85 + ///DistMap type.
2.86 template <class T>
2.87 struct SetDistMap : public Dfs< Digraph, SetDistMapTraits<T> > {
2.88 typedef Dfs<Digraph, SetDistMapTraits<T> > Create;
2.89 @@ -265,10 +265,10 @@
2.90 }
2.91 };
2.92 ///\brief \ref named-templ-param "Named parameter" for setting
2.93 - ///\ref ReachedMap type.
2.94 + ///ReachedMap type.
2.95 ///
2.96 ///\ref named-templ-param "Named parameter" for setting
2.97 - ///\ref ReachedMap type.
2.98 + ///ReachedMap type.
2.99 template <class T>
2.100 struct SetReachedMap : public Dfs< Digraph, SetReachedMapTraits<T> > {
2.101 typedef Dfs< Digraph, SetReachedMapTraits<T> > Create;
2.102 @@ -284,10 +284,10 @@
2.103 }
2.104 };
2.105 ///\brief \ref named-templ-param "Named parameter" for setting
2.106 - ///\ref ProcessedMap type.
2.107 + ///ProcessedMap type.
2.108 ///
2.109 ///\ref named-templ-param "Named parameter" for setting
2.110 - ///\ref ProcessedMap type.
2.111 + ///ProcessedMap type.
2.112 template <class T>
2.113 struct SetProcessedMap : public Dfs< Digraph, SetProcessedMapTraits<T> > {
2.114 typedef Dfs< Digraph, SetProcessedMapTraits<T> > Create;
2.115 @@ -301,10 +301,10 @@
2.116 }
2.117 };
2.118 ///\brief \ref named-templ-param "Named parameter" for setting
2.119 - ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
2.120 + ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
2.121 ///
2.122 ///\ref named-templ-param "Named parameter" for setting
2.123 - ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
2.124 + ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
2.125 ///If you don't set it explicitly, it will be automatically allocated.
2.126 struct SetStandardProcessedMap :
2.127 public Dfs< Digraph, SetStandardProcessedMapTraits > {
2.128 @@ -768,11 +768,11 @@
2.129 ///arcs of the %DFS paths.
2.130 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
2.131 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
2.132 - ///Instantiates a \ref PredMap.
2.133 + ///Instantiates a PredMap.
2.134
2.135 - ///This function instantiates a \ref PredMap.
2.136 + ///This function instantiates a PredMap.
2.137 ///\param g is the digraph, to which we would like to define the
2.138 - ///\ref PredMap.
2.139 + ///PredMap.
2.140 static PredMap *createPredMap(const Digraph &g)
2.141 {
2.142 return new PredMap(g);
2.143 @@ -784,11 +784,11 @@
2.144 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
2.145 ///By default it is a NullMap.
2.146 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
2.147 - ///Instantiates a \ref ProcessedMap.
2.148 + ///Instantiates a ProcessedMap.
2.149
2.150 - ///This function instantiates a \ref ProcessedMap.
2.151 + ///This function instantiates a ProcessedMap.
2.152 ///\param g is the digraph, to which
2.153 - ///we would like to define the \ref ProcessedMap.
2.154 + ///we would like to define the ProcessedMap.
2.155 #ifdef DOXYGEN
2.156 static ProcessedMap *createProcessedMap(const Digraph &g)
2.157 #else
2.158 @@ -803,11 +803,11 @@
2.159 ///The type of the map that indicates which nodes are reached.
2.160 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
2.161 typedef typename Digraph::template NodeMap<bool> ReachedMap;
2.162 - ///Instantiates a \ref ReachedMap.
2.163 + ///Instantiates a ReachedMap.
2.164
2.165 - ///This function instantiates a \ref ReachedMap.
2.166 + ///This function instantiates a ReachedMap.
2.167 ///\param g is the digraph, to which
2.168 - ///we would like to define the \ref ReachedMap.
2.169 + ///we would like to define the ReachedMap.
2.170 static ReachedMap *createReachedMap(const Digraph &g)
2.171 {
2.172 return new ReachedMap(g);
2.173 @@ -818,11 +818,11 @@
2.174 ///The type of the map that stores the distances of the nodes.
2.175 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
2.176 typedef typename Digraph::template NodeMap<int> DistMap;
2.177 - ///Instantiates a \ref DistMap.
2.178 + ///Instantiates a DistMap.
2.179
2.180 - ///This function instantiates a \ref DistMap.
2.181 + ///This function instantiates a DistMap.
2.182 ///\param g is the digraph, to which we would like to define
2.183 - ///the \ref DistMap
2.184 + ///the DistMap
2.185 static DistMap *createDistMap(const Digraph &g)
2.186 {
2.187 return new DistMap(g);
2.188 @@ -1001,10 +1001,10 @@
2.189 SetPredMapBase(const TR &b) : TR(b) {}
2.190 };
2.191 ///\brief \ref named-func-param "Named parameter"
2.192 - ///for setting \ref PredMap object.
2.193 + ///for setting PredMap object.
2.194 ///
2.195 ///\ref named-func-param "Named parameter"
2.196 - ///for setting \ref PredMap object.
2.197 + ///for setting PredMap object.
2.198 template<class T>
2.199 DfsWizard<SetPredMapBase<T> > predMap(const T &t)
2.200 {
2.201 @@ -1019,10 +1019,10 @@
2.202 SetReachedMapBase(const TR &b) : TR(b) {}
2.203 };
2.204 ///\brief \ref named-func-param "Named parameter"
2.205 - ///for setting \ref ReachedMap object.
2.206 + ///for setting ReachedMap object.
2.207 ///
2.208 /// \ref named-func-param "Named parameter"
2.209 - ///for setting \ref ReachedMap object.
2.210 + ///for setting ReachedMap object.
2.211 template<class T>
2.212 DfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
2.213 {
2.214 @@ -1037,10 +1037,10 @@
2.215 SetDistMapBase(const TR &b) : TR(b) {}
2.216 };
2.217 ///\brief \ref named-func-param "Named parameter"
2.218 - ///for setting \ref DistMap object.
2.219 + ///for setting DistMap object.
2.220 ///
2.221 /// \ref named-func-param "Named parameter"
2.222 - ///for setting \ref DistMap object.
2.223 + ///for setting DistMap object.
2.224 template<class T>
2.225 DfsWizard<SetDistMapBase<T> > distMap(const T &t)
2.226 {
2.227 @@ -1055,10 +1055,10 @@
2.228 SetProcessedMapBase(const TR &b) : TR(b) {}
2.229 };
2.230 ///\brief \ref named-func-param "Named parameter"
2.231 - ///for setting \ref ProcessedMap object.
2.232 + ///for setting ProcessedMap object.
2.233 ///
2.234 /// \ref named-func-param "Named parameter"
2.235 - ///for setting \ref ProcessedMap object.
2.236 + ///for setting ProcessedMap object.
2.237 template<class T>
2.238 DfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
2.239 {
2.240 @@ -1213,11 +1213,11 @@
2.241 /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
2.242 typedef typename Digraph::template NodeMap<bool> ReachedMap;
2.243
2.244 - /// \brief Instantiates a \ref ReachedMap.
2.245 + /// \brief Instantiates a ReachedMap.
2.246 ///
2.247 - /// This function instantiates a \ref ReachedMap.
2.248 + /// This function instantiates a ReachedMap.
2.249 /// \param digraph is the digraph, to which
2.250 - /// we would like to define the \ref ReachedMap.
2.251 + /// we would like to define the ReachedMap.
2.252 static ReachedMap *createReachedMap(const Digraph &digraph) {
2.253 return new ReachedMap(digraph);
2.254 }
3.1 --- a/lemon/dijkstra.h Tue Oct 07 07:08:45 2008 +0100
3.2 +++ b/lemon/dijkstra.h Wed Oct 08 13:40:20 2008 +0200
3.3 @@ -139,11 +139,11 @@
3.4 ///arcs of the shortest paths.
3.5 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
3.6 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
3.7 - ///Instantiates a \ref PredMap.
3.8 + ///Instantiates a PredMap.
3.9
3.10 - ///This function instantiates a \ref PredMap.
3.11 + ///This function instantiates a PredMap.
3.12 ///\param g is the digraph, to which we would like to define the
3.13 - ///\ref PredMap.
3.14 + ///PredMap.
3.15 static PredMap *createPredMap(const Digraph &g)
3.16 {
3.17 return new PredMap(g);
3.18 @@ -155,11 +155,11 @@
3.19 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
3.20 ///By default it is a NullMap.
3.21 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
3.22 - ///Instantiates a \ref ProcessedMap.
3.23 + ///Instantiates a ProcessedMap.
3.24
3.25 - ///This function instantiates a \ref ProcessedMap.
3.26 + ///This function instantiates a ProcessedMap.
3.27 ///\param g is the digraph, to which
3.28 - ///we would like to define the \ref ProcessedMap
3.29 + ///we would like to define the ProcessedMap
3.30 #ifdef DOXYGEN
3.31 static ProcessedMap *createProcessedMap(const Digraph &g)
3.32 #else
3.33 @@ -174,11 +174,11 @@
3.34 ///The type of the map that stores the distances of the nodes.
3.35 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
3.36 typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
3.37 - ///Instantiates a \ref DistMap.
3.38 + ///Instantiates a DistMap.
3.39
3.40 - ///This function instantiates a \ref DistMap.
3.41 + ///This function instantiates a DistMap.
3.42 ///\param g is the digraph, to which we would like to define
3.43 - ///the \ref DistMap
3.44 + ///the DistMap
3.45 static DistMap *createDistMap(const Digraph &g)
3.46 {
3.47 return new DistMap(g);
3.48 @@ -327,10 +327,10 @@
3.49 }
3.50 };
3.51 ///\brief \ref named-templ-param "Named parameter" for setting
3.52 - ///\ref PredMap type.
3.53 + ///PredMap type.
3.54 ///
3.55 ///\ref named-templ-param "Named parameter" for setting
3.56 - ///\ref PredMap type.
3.57 + ///PredMap type.
3.58 template <class T>
3.59 struct SetPredMap
3.60 : public Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > {
3.61 @@ -347,10 +347,10 @@
3.62 }
3.63 };
3.64 ///\brief \ref named-templ-param "Named parameter" for setting
3.65 - ///\ref DistMap type.
3.66 + ///DistMap type.
3.67 ///
3.68 ///\ref named-templ-param "Named parameter" for setting
3.69 - ///\ref DistMap type.
3.70 + ///DistMap type.
3.71 template <class T>
3.72 struct SetDistMap
3.73 : public Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > {
3.74 @@ -367,10 +367,10 @@
3.75 }
3.76 };
3.77 ///\brief \ref named-templ-param "Named parameter" for setting
3.78 - ///\ref ProcessedMap type.
3.79 + ///ProcessedMap type.
3.80 ///
3.81 ///\ref named-templ-param "Named parameter" for setting
3.82 - ///\ref ProcessedMap type.
3.83 + ///ProcessedMap type.
3.84 template <class T>
3.85 struct SetProcessedMap
3.86 : public Dijkstra< Digraph, LengthMap, SetProcessedMapTraits<T> > {
3.87 @@ -385,10 +385,10 @@
3.88 }
3.89 };
3.90 ///\brief \ref named-templ-param "Named parameter" for setting
3.91 - ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
3.92 + ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
3.93 ///
3.94 ///\ref named-templ-param "Named parameter" for setting
3.95 - ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
3.96 + ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
3.97 ///If you don't set it explicitly, it will be automatically allocated.
3.98 struct SetStandardProcessedMap
3.99 : public Dijkstra< Digraph, LengthMap, SetStandardProcessedMapTraits > {
3.100 @@ -986,11 +986,11 @@
3.101 ///arcs of the shortest paths.
3.102 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
3.103 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
3.104 - ///Instantiates a \ref PredMap.
3.105 + ///Instantiates a PredMap.
3.106
3.107 - ///This function instantiates a \ref PredMap.
3.108 + ///This function instantiates a PredMap.
3.109 ///\param g is the digraph, to which we would like to define the
3.110 - ///\ref PredMap.
3.111 + ///PredMap.
3.112 static PredMap *createPredMap(const Digraph &g)
3.113 {
3.114 return new PredMap(g);
3.115 @@ -1002,11 +1002,11 @@
3.116 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
3.117 ///By default it is a NullMap.
3.118 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
3.119 - ///Instantiates a \ref ProcessedMap.
3.120 + ///Instantiates a ProcessedMap.
3.121
3.122 - ///This function instantiates a \ref ProcessedMap.
3.123 + ///This function instantiates a ProcessedMap.
3.124 ///\param g is the digraph, to which
3.125 - ///we would like to define the \ref ProcessedMap.
3.126 + ///we would like to define the ProcessedMap.
3.127 #ifdef DOXYGEN
3.128 static ProcessedMap *createProcessedMap(const Digraph &g)
3.129 #else
3.130 @@ -1021,11 +1021,11 @@
3.131 ///The type of the map that stores the distances of the nodes.
3.132 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
3.133 typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
3.134 - ///Instantiates a \ref DistMap.
3.135 + ///Instantiates a DistMap.
3.136
3.137 - ///This function instantiates a \ref DistMap.
3.138 + ///This function instantiates a DistMap.
3.139 ///\param g is the digraph, to which we would like to define
3.140 - ///the \ref DistMap
3.141 + ///the DistMap
3.142 static DistMap *createDistMap(const Digraph &g)
3.143 {
3.144 return new DistMap(g);
3.145 @@ -1198,10 +1198,10 @@
3.146 SetPredMapBase(const TR &b) : TR(b) {}
3.147 };
3.148 ///\brief \ref named-func-param "Named parameter"
3.149 - ///for setting \ref PredMap object.
3.150 + ///for setting PredMap object.
3.151 ///
3.152 ///\ref named-func-param "Named parameter"
3.153 - ///for setting \ref PredMap object.
3.154 + ///for setting PredMap object.
3.155 template<class T>
3.156 DijkstraWizard<SetPredMapBase<T> > predMap(const T &t)
3.157 {
3.158 @@ -1216,10 +1216,10 @@
3.159 SetDistMapBase(const TR &b) : TR(b) {}
3.160 };
3.161 ///\brief \ref named-func-param "Named parameter"
3.162 - ///for setting \ref DistMap object.
3.163 + ///for setting DistMap object.
3.164 ///
3.165 ///\ref named-func-param "Named parameter"
3.166 - ///for setting \ref DistMap object.
3.167 + ///for setting DistMap object.
3.168 template<class T>
3.169 DijkstraWizard<SetDistMapBase<T> > distMap(const T &t)
3.170 {
3.171 @@ -1234,10 +1234,10 @@
3.172 SetProcessedMapBase(const TR &b) : TR(b) {}
3.173 };
3.174 ///\brief \ref named-func-param "Named parameter"
3.175 - ///for setting \ref ProcessedMap object.
3.176 + ///for setting ProcessedMap object.
3.177 ///
3.178 /// \ref named-func-param "Named parameter"
3.179 - ///for setting \ref ProcessedMap object.
3.180 + ///for setting ProcessedMap object.
3.181 template<class T>
3.182 DijkstraWizard<SetProcessedMapBase<T> > processedMap(const T &t)
3.183 {
4.1 --- a/lemon/maps.h Tue Oct 07 07:08:45 2008 +0100
4.2 +++ b/lemon/maps.h Wed Oct 08 13:40:20 2008 +0200
4.3 @@ -73,9 +73,9 @@
4.4 void set(const Key&, const Value&) {}
4.5 };
4.6
4.7 - /// Returns a \ref NullMap class
4.8 -
4.9 - /// This function just returns a \ref NullMap class.
4.10 + /// Returns a \c NullMap class
4.11 +
4.12 + /// This function just returns a \c NullMap class.
4.13 /// \relates NullMap
4.14 template <typename K, typename V>
4.15 NullMap<K, V> nullMap() {
4.16 @@ -88,7 +88,7 @@
4.17 /// This \ref concepts::ReadMap "readable map" assigns a specified
4.18 /// value to each key.
4.19 ///
4.20 - /// In other aspects it is equivalent to \ref NullMap.
4.21 + /// In other aspects it is equivalent to \c NullMap.
4.22 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
4.23 /// concept, but it absorbs the data written to it.
4.24 ///
4.25 @@ -133,9 +133,9 @@
4.26 ConstMap(const ConstMap<K, V1> &, const Value &v) : _value(v) {}
4.27 };
4.28
4.29 - /// Returns a \ref ConstMap class
4.30 -
4.31 - /// This function just returns a \ref ConstMap class.
4.32 + /// Returns a \c ConstMap class
4.33 +
4.34 + /// This function just returns a \c ConstMap class.
4.35 /// \relates ConstMap
4.36 template<typename K, typename V>
4.37 inline ConstMap<K, V> constMap(const V &v) {
4.38 @@ -156,7 +156,7 @@
4.39 /// This \ref concepts::ReadMap "readable map" assigns a specified
4.40 /// value to each key.
4.41 ///
4.42 - /// In other aspects it is equivalent to \ref NullMap.
4.43 + /// In other aspects it is equivalent to \c NullMap.
4.44 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
4.45 /// concept, but it absorbs the data written to it.
4.46 ///
4.47 @@ -182,9 +182,9 @@
4.48 void set(const Key&, const Value&) {}
4.49 };
4.50
4.51 - /// Returns a \ref ConstMap class with inlined constant value
4.52 -
4.53 - /// This function just returns a \ref ConstMap class with inlined
4.54 + /// Returns a \c ConstMap class with inlined constant value
4.55 +
4.56 + /// This function just returns a \c ConstMap class with inlined
4.57 /// constant value.
4.58 /// \relates ConstMap
4.59 template<typename K, typename V, V v>
4.60 @@ -212,9 +212,9 @@
4.61 }
4.62 };
4.63
4.64 - /// Returns an \ref IdentityMap class
4.65 -
4.66 - /// This function just returns an \ref IdentityMap class.
4.67 + /// Returns an \c IdentityMap class
4.68 +
4.69 + /// This function just returns an \c IdentityMap class.
4.70 /// \relates IdentityMap
4.71 template<typename T>
4.72 inline IdentityMap<T> identityMap() {
4.73 @@ -228,7 +228,7 @@
4.74 /// This map is essentially a wrapper for \c std::vector. It assigns
4.75 /// values to integer keys from the range <tt>[0..size-1]</tt>.
4.76 /// It can be used with some data structures, for example
4.77 - /// \ref UnionFind, \ref BinHeap, when the used items are small
4.78 + /// \c UnionFind, \c BinHeap, when the used items are small
4.79 /// integers. This map conforms the \ref concepts::ReferenceMap
4.80 /// "ReferenceMap" concept.
4.81 ///
4.82 @@ -268,7 +268,7 @@
4.83 RangeMap(const std::vector<V1>& vector)
4.84 : _vector(vector.begin(), vector.end()) {}
4.85
4.86 - /// Constructs the map from another \ref RangeMap.
4.87 + /// Constructs the map from another \c RangeMap.
4.88 template <typename V1>
4.89 RangeMap(const RangeMap<V1> &c)
4.90 : _vector(c._vector.begin(), c._vector.end()) {}
4.91 @@ -311,19 +311,19 @@
4.92 }
4.93 };
4.94
4.95 - /// Returns a \ref RangeMap class
4.96 -
4.97 - /// This function just returns a \ref RangeMap class.
4.98 + /// Returns a \c RangeMap class
4.99 +
4.100 + /// This function just returns a \c RangeMap class.
4.101 /// \relates RangeMap
4.102 template<typename V>
4.103 inline RangeMap<V> rangeMap(int size = 0, const V &value = V()) {
4.104 return RangeMap<V>(size, value);
4.105 }
4.106
4.107 - /// \brief Returns a \ref RangeMap class created from an appropriate
4.108 + /// \brief Returns a \c RangeMap class created from an appropriate
4.109 /// \c std::vector
4.110
4.111 - /// This function just returns a \ref RangeMap class created from an
4.112 + /// This function just returns a \c RangeMap class created from an
4.113 /// appropriate \c std::vector.
4.114 /// \relates RangeMap
4.115 template<typename V>
4.116 @@ -388,7 +388,7 @@
4.117 const Value &value = Value())
4.118 : _map(map.begin(), map.end()), _value(value) {}
4.119
4.120 - /// \brief Constructs the map from another \ref SparseMap.
4.121 + /// \brief Constructs the map from another \c SparseMap.
4.122 template<typename V1, typename Comp1>
4.123 SparseMap(const SparseMap<Key, V1, Comp1> &c)
4.124 : _map(c._map.begin(), c._map.end()), _value(c._value) {}
4.125 @@ -433,9 +433,9 @@
4.126 }
4.127 };
4.128
4.129 - /// Returns a \ref SparseMap class
4.130 -
4.131 - /// This function just returns a \ref SparseMap class with specified
4.132 + /// Returns a \c SparseMap class
4.133 +
4.134 + /// This function just returns a \c SparseMap class with specified
4.135 /// default value.
4.136 /// \relates SparseMap
4.137 template<typename K, typename V, typename Compare>
4.138 @@ -448,10 +448,10 @@
4.139 return SparseMap<K, V, std::less<K> >(value);
4.140 }
4.141
4.142 - /// \brief Returns a \ref SparseMap class created from an appropriate
4.143 + /// \brief Returns a \c SparseMap class created from an appropriate
4.144 /// \c std::map
4.145
4.146 - /// This function just returns a \ref SparseMap class created from an
4.147 + /// This function just returns a \c SparseMap class created from an
4.148 /// appropriate \c std::map.
4.149 /// \relates SparseMap
4.150 template<typename K, typename V, typename Compare>
4.151 @@ -501,9 +501,9 @@
4.152 operator[](const Key &k) const { return _m1[_m2[k]]; }
4.153 };
4.154
4.155 - /// Returns a \ref ComposeMap class
4.156 -
4.157 - /// This function just returns a \ref ComposeMap class.
4.158 + /// Returns a \c ComposeMap class
4.159 +
4.160 + /// This function just returns a \c ComposeMap class.
4.161 ///
4.162 /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is
4.163 /// convertible to the \c Key of \c m1, then <tt>composeMap(m1,m2)[x]</tt>
4.164 @@ -556,9 +556,9 @@
4.165 Value operator[](const Key &k) const { return _f(_m1[k],_m2[k]); }
4.166 };
4.167
4.168 - /// Returns a \ref CombineMap class
4.169 -
4.170 - /// This function just returns a \ref CombineMap class.
4.171 + /// Returns a \c CombineMap class
4.172 +
4.173 + /// This function just returns a \c CombineMap class.
4.174 ///
4.175 /// For example, if \c m1 and \c m2 are both maps with \c double
4.176 /// values, then
4.177 @@ -625,9 +625,9 @@
4.178 Value operator[](const Key &k) const { return _f(k); }
4.179 };
4.180
4.181 - /// Returns a \ref FunctorToMap class
4.182 -
4.183 - /// This function just returns a \ref FunctorToMap class.
4.184 + /// Returns a \c FunctorToMap class
4.185 +
4.186 + /// This function just returns a \c FunctorToMap class.
4.187 ///
4.188 /// This function is specialized for adaptable binary function
4.189 /// classes and C++ functions.
4.190 @@ -684,9 +684,9 @@
4.191 Value operator[](const Key &k) const { return _m[k]; }
4.192 };
4.193
4.194 - /// Returns a \ref MapToFunctor class
4.195 -
4.196 - /// This function just returns a \ref MapToFunctor class.
4.197 + /// Returns a \c MapToFunctor class
4.198 +
4.199 + /// This function just returns a \c MapToFunctor class.
4.200 /// \relates MapToFunctor
4.201 template<typename M>
4.202 inline MapToFunctor<M> mapToFunctor(const M &m) {
4.203 @@ -723,9 +723,9 @@
4.204 Value operator[](const Key &k) const { return _m[k]; }
4.205 };
4.206
4.207 - /// Returns a \ref ConvertMap class
4.208 -
4.209 - /// This function just returns a \ref ConvertMap class.
4.210 + /// Returns a \c ConvertMap class
4.211 +
4.212 + /// This function just returns a \c ConvertMap class.
4.213 /// \relates ConvertMap
4.214 template<typename V, typename M>
4.215 inline ConvertMap<M, V> convertMap(const M &map) {
4.216 @@ -763,9 +763,9 @@
4.217 void set(const Key &k, const Value &v) { _m1.set(k,v); _m2.set(k,v); }
4.218 };
4.219
4.220 - /// Returns a \ref ForkMap class
4.221 -
4.222 - /// This function just returns a \ref ForkMap class.
4.223 + /// Returns a \c ForkMap class
4.224 +
4.225 + /// This function just returns a \c ForkMap class.
4.226 /// \relates ForkMap
4.227 template <typename M1, typename M2>
4.228 inline ForkMap<M1,M2> forkMap(M1 &m1, M2 &m2) {
4.229 @@ -807,9 +807,9 @@
4.230 Value operator[](const Key &k) const { return _m1[k]+_m2[k]; }
4.231 };
4.232
4.233 - /// Returns an \ref AddMap class
4.234 -
4.235 - /// This function just returns an \ref AddMap class.
4.236 + /// Returns an \c AddMap class
4.237 +
4.238 + /// This function just returns an \c AddMap class.
4.239 ///
4.240 /// For example, if \c m1 and \c m2 are both maps with \c double
4.241 /// values, then <tt>addMap(m1,m2)[x]</tt> will be equal to
4.242 @@ -855,9 +855,9 @@
4.243 Value operator[](const Key &k) const { return _m1[k]-_m2[k]; }
4.244 };
4.245
4.246 - /// Returns a \ref SubMap class
4.247 -
4.248 - /// This function just returns a \ref SubMap class.
4.249 + /// Returns a \c SubMap class
4.250 +
4.251 + /// This function just returns a \c SubMap class.
4.252 ///
4.253 /// For example, if \c m1 and \c m2 are both maps with \c double
4.254 /// values, then <tt>subMap(m1,m2)[x]</tt> will be equal to
4.255 @@ -904,9 +904,9 @@
4.256 Value operator[](const Key &k) const { return _m1[k]*_m2[k]; }
4.257 };
4.258
4.259 - /// Returns a \ref MulMap class
4.260 -
4.261 - /// This function just returns a \ref MulMap class.
4.262 + /// Returns a \c MulMap class
4.263 +
4.264 + /// This function just returns a \c MulMap class.
4.265 ///
4.266 /// For example, if \c m1 and \c m2 are both maps with \c double
4.267 /// values, then <tt>mulMap(m1,m2)[x]</tt> will be equal to
4.268 @@ -952,9 +952,9 @@
4.269 Value operator[](const Key &k) const { return _m1[k]/_m2[k]; }
4.270 };
4.271
4.272 - /// Returns a \ref DivMap class
4.273 -
4.274 - /// This function just returns a \ref DivMap class.
4.275 + /// Returns a \c DivMap class
4.276 +
4.277 + /// This function just returns a \c DivMap class.
4.278 ///
4.279 /// For example, if \c m1 and \c m2 are both maps with \c double
4.280 /// values, then <tt>divMap(m1,m2)[x]</tt> will be equal to
4.281 @@ -1038,9 +1038,9 @@
4.282 void set(const Key &k, const Value &v) { _m.set(k, v-_v); }
4.283 };
4.284
4.285 - /// Returns a \ref ShiftMap class
4.286 -
4.287 - /// This function just returns a \ref ShiftMap class.
4.288 + /// Returns a \c ShiftMap class
4.289 +
4.290 + /// This function just returns a \c ShiftMap class.
4.291 ///
4.292 /// For example, if \c m is a map with \c double values and \c v is
4.293 /// \c double, then <tt>shiftMap(m,v)[x]</tt> will be equal to
4.294 @@ -1052,9 +1052,9 @@
4.295 return ShiftMap<M, C>(m,v);
4.296 }
4.297
4.298 - /// Returns a \ref ShiftWriteMap class
4.299 -
4.300 - /// This function just returns a \ref ShiftWriteMap class.
4.301 + /// Returns a \c ShiftWriteMap class
4.302 +
4.303 + /// This function just returns a \c ShiftWriteMap class.
4.304 ///
4.305 /// For example, if \c m is a map with \c double values and \c v is
4.306 /// \c double, then <tt>shiftWriteMap(m,v)[x]</tt> will be equal to
4.307 @@ -1140,9 +1140,9 @@
4.308 void set(const Key &k, const Value &v) { _m.set(k, v/_v); }
4.309 };
4.310
4.311 - /// Returns a \ref ScaleMap class
4.312 -
4.313 - /// This function just returns a \ref ScaleMap class.
4.314 + /// Returns a \c ScaleMap class
4.315 +
4.316 + /// This function just returns a \c ScaleMap class.
4.317 ///
4.318 /// For example, if \c m is a map with \c double values and \c v is
4.319 /// \c double, then <tt>scaleMap(m,v)[x]</tt> will be equal to
4.320 @@ -1154,9 +1154,9 @@
4.321 return ScaleMap<M, C>(m,v);
4.322 }
4.323
4.324 - /// Returns a \ref ScaleWriteMap class
4.325 -
4.326 - /// This function just returns a \ref ScaleWriteMap class.
4.327 + /// Returns a \c ScaleWriteMap class
4.328 +
4.329 + /// This function just returns a \c ScaleWriteMap class.
4.330 ///
4.331 /// For example, if \c m is a map with \c double values and \c v is
4.332 /// \c double, then <tt>scaleWriteMap(m,v)[x]</tt> will be equal to
4.333 @@ -1240,9 +1240,9 @@
4.334 void set(const Key &k, const Value &v) { _m.set(k, -v); }
4.335 };
4.336
4.337 - /// Returns a \ref NegMap class
4.338 -
4.339 - /// This function just returns a \ref NegMap class.
4.340 + /// Returns a \c NegMap class
4.341 +
4.342 + /// This function just returns a \c NegMap class.
4.343 ///
4.344 /// For example, if \c m is a map with \c double values, then
4.345 /// <tt>negMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
4.346 @@ -1253,9 +1253,9 @@
4.347 return NegMap<M>(m);
4.348 }
4.349
4.350 - /// Returns a \ref NegWriteMap class
4.351 -
4.352 - /// This function just returns a \ref NegWriteMap class.
4.353 + /// Returns a \c NegWriteMap class
4.354 +
4.355 + /// This function just returns a \c NegWriteMap class.
4.356 ///
4.357 /// For example, if \c m is a map with \c double values, then
4.358 /// <tt>negWriteMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
4.359 @@ -1296,9 +1296,9 @@
4.360
4.361 };
4.362
4.363 - /// Returns an \ref AbsMap class
4.364 -
4.365 - /// This function just returns an \ref AbsMap class.
4.366 + /// Returns an \c AbsMap class
4.367 +
4.368 + /// This function just returns an \c AbsMap class.
4.369 ///
4.370 /// For example, if \c m is a map with \c double values, then
4.371 /// <tt>absMap(m)[x]</tt> will be equal to <tt>m[x]</tt> if
4.372 @@ -1345,9 +1345,9 @@
4.373 Value operator[](const Key&) const { return true; }
4.374 };
4.375
4.376 - /// Returns a \ref TrueMap class
4.377 -
4.378 - /// This function just returns a \ref TrueMap class.
4.379 + /// Returns a \c TrueMap class
4.380 +
4.381 + /// This function just returns a \c TrueMap class.
4.382 /// \relates TrueMap
4.383 template<typename K>
4.384 inline TrueMap<K> trueMap() {
4.385 @@ -1382,9 +1382,9 @@
4.386 Value operator[](const Key&) const { return false; }
4.387 };
4.388
4.389 - /// Returns a \ref FalseMap class
4.390 -
4.391 - /// This function just returns a \ref FalseMap class.
4.392 + /// Returns a \c FalseMap class
4.393 +
4.394 + /// This function just returns a \c FalseMap class.
4.395 /// \relates FalseMap
4.396 template<typename K>
4.397 inline FalseMap<K> falseMap() {
4.398 @@ -1429,9 +1429,9 @@
4.399 Value operator[](const Key &k) const { return _m1[k]&&_m2[k]; }
4.400 };
4.401
4.402 - /// Returns an \ref AndMap class
4.403 -
4.404 - /// This function just returns an \ref AndMap class.
4.405 + /// Returns an \c AndMap class
4.406 +
4.407 + /// This function just returns an \c AndMap class.
4.408 ///
4.409 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
4.410 /// then <tt>andMap(m1,m2)[x]</tt> will be equal to
4.411 @@ -1477,9 +1477,9 @@
4.412 Value operator[](const Key &k) const { return _m1[k]||_m2[k]; }
4.413 };
4.414
4.415 - /// Returns an \ref OrMap class
4.416 -
4.417 - /// This function just returns an \ref OrMap class.
4.418 + /// Returns an \c OrMap class
4.419 +
4.420 + /// This function just returns an \c OrMap class.
4.421 ///
4.422 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
4.423 /// then <tt>orMap(m1,m2)[x]</tt> will be equal to
4.424 @@ -1544,9 +1544,9 @@
4.425 void set(const Key &k, bool v) { _m.set(k, !v); }
4.426 };
4.427
4.428 - /// Returns a \ref NotMap class
4.429 -
4.430 - /// This function just returns a \ref NotMap class.
4.431 + /// Returns a \c NotMap class
4.432 +
4.433 + /// This function just returns a \c NotMap class.
4.434 ///
4.435 /// For example, if \c m is a map with \c bool values, then
4.436 /// <tt>notMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
4.437 @@ -1557,9 +1557,9 @@
4.438 return NotMap<M>(m);
4.439 }
4.440
4.441 - /// Returns a \ref NotWriteMap class
4.442 -
4.443 - /// This function just returns a \ref NotWriteMap class.
4.444 + /// Returns a \c NotWriteMap class
4.445 +
4.446 + /// This function just returns a \c NotWriteMap class.
4.447 ///
4.448 /// For example, if \c m is a map with \c bool values, then
4.449 /// <tt>notWriteMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
4.450 @@ -1605,9 +1605,9 @@
4.451 Value operator[](const Key &k) const { return _m1[k]==_m2[k]; }
4.452 };
4.453
4.454 - /// Returns an \ref EqualMap class
4.455 -
4.456 - /// This function just returns an \ref EqualMap class.
4.457 + /// Returns an \c EqualMap class
4.458 +
4.459 + /// This function just returns an \c EqualMap class.
4.460 ///
4.461 /// For example, if \c m1 and \c m2 are maps with keys and values of
4.462 /// the same type, then <tt>equalMap(m1,m2)[x]</tt> will be equal to
4.463 @@ -1653,9 +1653,9 @@
4.464 Value operator[](const Key &k) const { return _m1[k]<_m2[k]; }
4.465 };
4.466
4.467 - /// Returns an \ref LessMap class
4.468 -
4.469 - /// This function just returns an \ref LessMap class.
4.470 + /// Returns an \c LessMap class
4.471 +
4.472 + /// This function just returns an \c LessMap class.
4.473 ///
4.474 /// For example, if \c m1 and \c m2 are maps with keys and values of
4.475 /// the same type, then <tt>lessMap(m1,m2)[x]</tt> will be equal to
4.476 @@ -1745,9 +1745,9 @@
4.477 Iterator _end;
4.478 };
4.479
4.480 - /// Returns a \ref LoggerBoolMap class
4.481 -
4.482 - /// This function just returns a \ref LoggerBoolMap class.
4.483 + /// Returns a \c LoggerBoolMap class
4.484 +
4.485 + /// This function just returns a \c LoggerBoolMap class.
4.486 ///
4.487 /// The most important usage of it is storing certain nodes or arcs
4.488 /// that were marked \c true by an algorithm.
4.489 @@ -1767,7 +1767,7 @@
4.490 ///
4.491 /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
4.492 /// it cannot be used when a readable map is needed, for example as
4.493 - /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms.
4.494 + /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
4.495 ///
4.496 /// \relates LoggerBoolMap
4.497 template<typename Iterator>
4.498 @@ -2282,9 +2282,9 @@
4.499 const Digraph& _digraph;
4.500 };
4.501
4.502 - /// \brief Returns a \ref SourceMap class.
4.503 + /// \brief Returns a \c SourceMap class.
4.504 ///
4.505 - /// This function just returns an \ref SourceMap class.
4.506 + /// This function just returns an \c SourceMap class.
4.507 /// \relates SourceMap
4.508 template <typename Digraph>
4.509 inline SourceMap<Digraph> sourceMap(const Digraph& digraph) {
4.510 @@ -2321,9 +2321,9 @@
4.511 const Digraph& _digraph;
4.512 };
4.513
4.514 - /// \brief Returns a \ref TargetMap class.
4.515 + /// \brief Returns a \c TargetMap class.
4.516 ///
4.517 - /// This function just returns a \ref TargetMap class.
4.518 + /// This function just returns a \c TargetMap class.
4.519 /// \relates TargetMap
4.520 template <typename Digraph>
4.521 inline TargetMap<Digraph> targetMap(const Digraph& digraph) {
4.522 @@ -2360,9 +2360,9 @@
4.523 const Graph& _graph;
4.524 };
4.525
4.526 - /// \brief Returns a \ref ForwardMap class.
4.527 + /// \brief Returns a \c ForwardMap class.
4.528 ///
4.529 - /// This function just returns an \ref ForwardMap class.
4.530 + /// This function just returns an \c ForwardMap class.
4.531 /// \relates ForwardMap
4.532 template <typename Graph>
4.533 inline ForwardMap<Graph> forwardMap(const Graph& graph) {
4.534 @@ -2399,9 +2399,9 @@
4.535 const Graph& _graph;
4.536 };
4.537
4.538 - /// \brief Returns a \ref BackwardMap class
4.539 -
4.540 - /// This function just returns a \ref BackwardMap class.
4.541 + /// \brief Returns a \c BackwardMap class
4.542 +
4.543 + /// This function just returns a \c BackwardMap class.
4.544 /// \relates BackwardMap
4.545 template <typename Graph>
4.546 inline BackwardMap<Graph> backwardMap(const Graph& graph) {