Changes in / [303:a3a69f5bba62:304:1e81878b0e54] in lemon-main
- Location:
- lemon
- Files:
-
- 5 edited
Legend:
- Unmodified
- Added
- Removed
-
lemon/bfs.h
r292 r301 50 50 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 51 51 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap; 52 ///Instantiates a \refPredMap.53 54 ///This function instantiates a \refPredMap.52 ///Instantiates a PredMap. 53 54 ///This function instantiates a PredMap. 55 55 ///\param g is the digraph, to which we would like to define the 56 /// \refPredMap.56 ///PredMap. 57 57 static PredMap *createPredMap(const Digraph &g) 58 58 { … … 65 65 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 66 66 typedef NullMap<typename Digraph::Node,bool> ProcessedMap; 67 ///Instantiates a \refProcessedMap.68 69 ///This function instantiates a \refProcessedMap.67 ///Instantiates a ProcessedMap. 68 69 ///This function instantiates a ProcessedMap. 70 70 ///\param g is the digraph, to which 71 ///we would like to define the \refProcessedMap71 ///we would like to define the ProcessedMap 72 72 #ifdef DOXYGEN 73 73 static ProcessedMap *createProcessedMap(const Digraph &g) … … 84 84 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. 85 85 typedef typename Digraph::template NodeMap<bool> ReachedMap; 86 ///Instantiates a \refReachedMap.87 88 ///This function instantiates a \refReachedMap.86 ///Instantiates a ReachedMap. 87 88 ///This function instantiates a ReachedMap. 89 89 ///\param g is the digraph, to which 90 ///we would like to define the \refReachedMap.90 ///we would like to define the ReachedMap. 91 91 static ReachedMap *createReachedMap(const Digraph &g) 92 92 { … … 99 99 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 100 100 typedef typename Digraph::template NodeMap<int> DistMap; 101 ///Instantiates a \refDistMap.102 103 ///This function instantiates a \refDistMap.101 ///Instantiates a DistMap. 102 103 ///This function instantiates a DistMap. 104 104 ///\param g is the digraph, to which we would like to define the 105 /// \refDistMap.105 ///DistMap. 106 106 static DistMap *createDistMap(const Digraph &g) 107 107 { … … 228 228 }; 229 229 ///\brief \ref named-templ-param "Named parameter" for setting 230 /// \refPredMap type.230 ///PredMap type. 231 231 /// 232 232 ///\ref named-templ-param "Named parameter" for setting 233 /// \refPredMap type.233 ///PredMap type. 234 234 template <class T> 235 235 struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > { … … 247 247 }; 248 248 ///\brief \ref named-templ-param "Named parameter" for setting 249 /// \refDistMap type.249 ///DistMap type. 250 250 /// 251 251 ///\ref named-templ-param "Named parameter" for setting 252 /// \refDistMap type.252 ///DistMap type. 253 253 template <class T> 254 254 struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > { … … 266 266 }; 267 267 ///\brief \ref named-templ-param "Named parameter" for setting 268 /// \refReachedMap type.268 ///ReachedMap type. 269 269 /// 270 270 ///\ref named-templ-param "Named parameter" for setting 271 /// \refReachedMap type.271 ///ReachedMap type. 272 272 template <class T> 273 273 struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > { … … 285 285 }; 286 286 ///\brief \ref named-templ-param "Named parameter" for setting 287 /// \refProcessedMap type.287 ///ProcessedMap type. 288 288 /// 289 289 ///\ref named-templ-param "Named parameter" for setting 290 /// \refProcessedMap type.290 ///ProcessedMap type. 291 291 template <class T> 292 292 struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > { … … 303 303 }; 304 304 ///\brief \ref named-templ-param "Named parameter" for setting 305 /// \refProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.305 ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>. 306 306 /// 307 307 ///\ref named-templ-param "Named parameter" for setting 308 /// \refProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.308 ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>. 309 309 ///If you don't set it explicitly, it will be automatically allocated. 310 310 struct SetStandardProcessedMap : … … 836 836 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 837 837 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap; 838 ///Instantiates a \refPredMap.839 840 ///This function instantiates a \refPredMap.838 ///Instantiates a PredMap. 839 840 ///This function instantiates a PredMap. 841 841 ///\param g is the digraph, to which we would like to define the 842 /// \refPredMap.842 ///PredMap. 843 843 static PredMap *createPredMap(const Digraph &g) 844 844 { … … 852 852 ///By default it is a NullMap. 853 853 typedef NullMap<typename Digraph::Node,bool> ProcessedMap; 854 ///Instantiates a \refProcessedMap.855 856 ///This function instantiates a \refProcessedMap.854 ///Instantiates a ProcessedMap. 855 856 ///This function instantiates a ProcessedMap. 857 857 ///\param g is the digraph, to which 858 ///we would like to define the \refProcessedMap.858 ///we would like to define the ProcessedMap. 859 859 #ifdef DOXYGEN 860 860 static ProcessedMap *createProcessedMap(const Digraph &g) … … 871 871 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. 872 872 typedef typename Digraph::template NodeMap<bool> ReachedMap; 873 ///Instantiates a \refReachedMap.874 875 ///This function instantiates a \refReachedMap.873 ///Instantiates a ReachedMap. 874 875 ///This function instantiates a ReachedMap. 876 876 ///\param g is the digraph, to which 877 ///we would like to define the \refReachedMap.877 ///we would like to define the ReachedMap. 878 878 static ReachedMap *createReachedMap(const Digraph &g) 879 879 { … … 886 886 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 887 887 typedef typename Digraph::template NodeMap<int> DistMap; 888 ///Instantiates a \refDistMap.889 890 ///This function instantiates a \refDistMap.888 ///Instantiates a DistMap. 889 890 ///This function instantiates a DistMap. 891 891 ///\param g is the digraph, to which we would like to define 892 ///the \refDistMap892 ///the DistMap 893 893 static DistMap *createDistMap(const Digraph &g) 894 894 { … … 903 903 }; 904 904 905 /// Default traits class used by \refBfsWizard905 /// Default traits class used by BfsWizard 906 906 907 907 /// To make it easier to use Bfs algorithm … … 1069 1069 }; 1070 1070 ///\brief \ref named-func-param "Named parameter" 1071 ///for setting \refPredMap object.1071 ///for setting PredMap object. 1072 1072 /// 1073 1073 ///\ref named-func-param "Named parameter" 1074 ///for setting \refPredMap object.1074 ///for setting PredMap object. 1075 1075 template<class T> 1076 1076 BfsWizard<SetPredMapBase<T> > predMap(const T &t) … … 1087 1087 }; 1088 1088 ///\brief \ref named-func-param "Named parameter" 1089 ///for setting \refReachedMap object.1089 ///for setting ReachedMap object. 1090 1090 /// 1091 1091 /// \ref named-func-param "Named parameter" 1092 ///for setting \refReachedMap object.1092 ///for setting ReachedMap object. 1093 1093 template<class T> 1094 1094 BfsWizard<SetReachedMapBase<T> > reachedMap(const T &t) … … 1105 1105 }; 1106 1106 ///\brief \ref named-func-param "Named parameter" 1107 ///for setting \refDistMap object.1107 ///for setting DistMap object. 1108 1108 /// 1109 1109 /// \ref named-func-param "Named parameter" 1110 ///for setting \refDistMap object.1110 ///for setting DistMap object. 1111 1111 template<class T> 1112 1112 BfsWizard<SetDistMapBase<T> > distMap(const T &t) … … 1123 1123 }; 1124 1124 ///\brief \ref named-func-param "Named parameter" 1125 ///for setting \refProcessedMap object.1125 ///for setting ProcessedMap object. 1126 1126 /// 1127 1127 /// \ref named-func-param "Named parameter" 1128 ///for setting \refProcessedMap object.1128 ///for setting ProcessedMap object. 1129 1129 template<class T> 1130 1130 BfsWizard<SetProcessedMapBase<T> > processedMap(const T &t) … … 1268 1268 typedef typename Digraph::template NodeMap<bool> ReachedMap; 1269 1269 1270 /// \brief Instantiates a \refReachedMap.1271 /// 1272 /// This function instantiates a \refReachedMap.1270 /// \brief Instantiates a ReachedMap. 1271 /// 1272 /// This function instantiates a ReachedMap. 1273 1273 /// \param digraph is the digraph, to which 1274 /// we would like to define the \refReachedMap.1274 /// we would like to define the ReachedMap. 1275 1275 static ReachedMap *createReachedMap(const Digraph &digraph) { 1276 1276 return new ReachedMap(digraph); -
lemon/core.h
r282 r300 59 59 /// @{ 60 60 61 ///Create convenien ttypedefs for the digraph types and iterators61 ///Create convenience typedefs for the digraph types and iterators 62 62 63 63 ///This \c \#define creates convenient type definitions for the following … … 81 81 typedef Digraph::ArcMap<bool> BoolArcMap; \ 82 82 typedef Digraph::ArcMap<int> IntArcMap; \ 83 typedef Digraph::ArcMap<double> DoubleArcMap ;84 85 ///Create convenien ttypedefs for the digraph types and iterators83 typedef Digraph::ArcMap<double> DoubleArcMap 84 85 ///Create convenience typedefs for the digraph types and iterators 86 86 87 87 ///\see DIGRAPH_TYPEDEFS … … 101 101 typedef typename Digraph::template ArcMap<bool> BoolArcMap; \ 102 102 typedef typename Digraph::template ArcMap<int> IntArcMap; \ 103 typedef typename Digraph::template ArcMap<double> DoubleArcMap ;104 105 ///Create convenien ttypedefs for the graph types and iterators103 typedef typename Digraph::template ArcMap<double> DoubleArcMap 104 105 ///Create convenience typedefs for the graph types and iterators 106 106 107 107 ///This \c \#define creates the same convenient type definitions as defined … … 120 120 typedef Graph::EdgeMap<bool> BoolEdgeMap; \ 121 121 typedef Graph::EdgeMap<int> IntEdgeMap; \ 122 typedef Graph::EdgeMap<double> DoubleEdgeMap ;123 124 ///Create convenien ttypedefs for the graph types and iterators122 typedef Graph::EdgeMap<double> DoubleEdgeMap 123 124 ///Create convenience typedefs for the graph types and iterators 125 125 126 126 ///\see GRAPH_TYPEDEFS … … 135 135 typedef typename Graph::template EdgeMap<bool> BoolEdgeMap; \ 136 136 typedef typename Graph::template EdgeMap<int> IntEdgeMap; \ 137 typedef typename Graph::template EdgeMap<double> DoubleEdgeMap ;137 typedef typename Graph::template EdgeMap<double> DoubleEdgeMap 138 138 139 139 /// \brief Function to count the items in a graph. -
lemon/dfs.h
r292 r301 51 51 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 52 52 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap; 53 ///Instantiates a \refPredMap.54 55 ///This function instantiates a \refPredMap.53 ///Instantiates a PredMap. 54 55 ///This function instantiates a PredMap. 56 56 ///\param g is the digraph, to which we would like to define the 57 /// \refPredMap.57 ///PredMap. 58 58 static PredMap *createPredMap(const Digraph &g) 59 59 { … … 66 66 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 67 67 typedef NullMap<typename Digraph::Node,bool> ProcessedMap; 68 ///Instantiates a \refProcessedMap.69 70 ///This function instantiates a \refProcessedMap.68 ///Instantiates a ProcessedMap. 69 70 ///This function instantiates a ProcessedMap. 71 71 ///\param g is the digraph, to which 72 ///we would like to define the \refProcessedMap72 ///we would like to define the ProcessedMap 73 73 #ifdef DOXYGEN 74 74 static ProcessedMap *createProcessedMap(const Digraph &g) … … 85 85 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. 86 86 typedef typename Digraph::template NodeMap<bool> ReachedMap; 87 ///Instantiates a \refReachedMap.88 89 ///This function instantiates a \refReachedMap.87 ///Instantiates a ReachedMap. 88 89 ///This function instantiates a ReachedMap. 90 90 ///\param g is the digraph, to which 91 ///we would like to define the \refReachedMap.91 ///we would like to define the ReachedMap. 92 92 static ReachedMap *createReachedMap(const Digraph &g) 93 93 { … … 100 100 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 101 101 typedef typename Digraph::template NodeMap<int> DistMap; 102 ///Instantiates a \refDistMap.103 104 ///This function instantiates a \refDistMap.102 ///Instantiates a DistMap. 103 104 ///This function instantiates a DistMap. 105 105 ///\param g is the digraph, to which we would like to define the 106 /// \refDistMap.106 ///DistMap. 107 107 static DistMap *createDistMap(const Digraph &g) 108 108 { … … 228 228 }; 229 229 ///\brief \ref named-templ-param "Named parameter" for setting 230 /// \refPredMap type.230 ///PredMap type. 231 231 /// 232 232 ///\ref named-templ-param "Named parameter" for setting 233 /// \refPredMap type.233 ///PredMap type. 234 234 template <class T> 235 235 struct SetPredMap : public Dfs<Digraph, SetPredMapTraits<T> > { … … 247 247 }; 248 248 ///\brief \ref named-templ-param "Named parameter" for setting 249 /// \refDistMap type.249 ///DistMap type. 250 250 /// 251 251 ///\ref named-templ-param "Named parameter" for setting 252 /// \refDistMap type.252 ///DistMap type. 253 253 template <class T> 254 254 struct SetDistMap : public Dfs< Digraph, SetDistMapTraits<T> > { … … 266 266 }; 267 267 ///\brief \ref named-templ-param "Named parameter" for setting 268 /// \refReachedMap type.268 ///ReachedMap type. 269 269 /// 270 270 ///\ref named-templ-param "Named parameter" for setting 271 /// \refReachedMap type.271 ///ReachedMap type. 272 272 template <class T> 273 273 struct SetReachedMap : public Dfs< Digraph, SetReachedMapTraits<T> > { … … 285 285 }; 286 286 ///\brief \ref named-templ-param "Named parameter" for setting 287 /// \refProcessedMap type.287 ///ProcessedMap type. 288 288 /// 289 289 ///\ref named-templ-param "Named parameter" for setting 290 /// \refProcessedMap type.290 ///ProcessedMap type. 291 291 template <class T> 292 292 struct SetProcessedMap : public Dfs< Digraph, SetProcessedMapTraits<T> > { … … 302 302 }; 303 303 ///\brief \ref named-templ-param "Named parameter" for setting 304 /// \refProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.304 ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>. 305 305 /// 306 306 ///\ref named-templ-param "Named parameter" for setting 307 /// \refProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.307 ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>. 308 308 ///If you don't set it explicitly, it will be automatically allocated. 309 309 struct SetStandardProcessedMap : … … 769 769 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 770 770 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap; 771 ///Instantiates a \refPredMap.772 773 ///This function instantiates a \refPredMap.771 ///Instantiates a PredMap. 772 773 ///This function instantiates a PredMap. 774 774 ///\param g is the digraph, to which we would like to define the 775 /// \refPredMap.775 ///PredMap. 776 776 static PredMap *createPredMap(const Digraph &g) 777 777 { … … 785 785 ///By default it is a NullMap. 786 786 typedef NullMap<typename Digraph::Node,bool> ProcessedMap; 787 ///Instantiates a \refProcessedMap.788 789 ///This function instantiates a \refProcessedMap.787 ///Instantiates a ProcessedMap. 788 789 ///This function instantiates a ProcessedMap. 790 790 ///\param g is the digraph, to which 791 ///we would like to define the \refProcessedMap.791 ///we would like to define the ProcessedMap. 792 792 #ifdef DOXYGEN 793 793 static ProcessedMap *createProcessedMap(const Digraph &g) … … 804 804 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. 805 805 typedef typename Digraph::template NodeMap<bool> ReachedMap; 806 ///Instantiates a \refReachedMap.807 808 ///This function instantiates a \refReachedMap.806 ///Instantiates a ReachedMap. 807 808 ///This function instantiates a ReachedMap. 809 809 ///\param g is the digraph, to which 810 ///we would like to define the \refReachedMap.810 ///we would like to define the ReachedMap. 811 811 static ReachedMap *createReachedMap(const Digraph &g) 812 812 { … … 819 819 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 820 820 typedef typename Digraph::template NodeMap<int> DistMap; 821 ///Instantiates a \refDistMap.822 823 ///This function instantiates a \refDistMap.821 ///Instantiates a DistMap. 822 823 ///This function instantiates a DistMap. 824 824 ///\param g is the digraph, to which we would like to define 825 ///the \refDistMap825 ///the DistMap 826 826 static DistMap *createDistMap(const Digraph &g) 827 827 { … … 1002 1002 }; 1003 1003 ///\brief \ref named-func-param "Named parameter" 1004 ///for setting \refPredMap object.1004 ///for setting PredMap object. 1005 1005 /// 1006 1006 ///\ref named-func-param "Named parameter" 1007 ///for setting \refPredMap object.1007 ///for setting PredMap object. 1008 1008 template<class T> 1009 1009 DfsWizard<SetPredMapBase<T> > predMap(const T &t) … … 1020 1020 }; 1021 1021 ///\brief \ref named-func-param "Named parameter" 1022 ///for setting \refReachedMap object.1022 ///for setting ReachedMap object. 1023 1023 /// 1024 1024 /// \ref named-func-param "Named parameter" 1025 ///for setting \refReachedMap object.1025 ///for setting ReachedMap object. 1026 1026 template<class T> 1027 1027 DfsWizard<SetReachedMapBase<T> > reachedMap(const T &t) … … 1038 1038 }; 1039 1039 ///\brief \ref named-func-param "Named parameter" 1040 ///for setting \refDistMap object.1040 ///for setting DistMap object. 1041 1041 /// 1042 1042 /// \ref named-func-param "Named parameter" 1043 ///for setting \refDistMap object.1043 ///for setting DistMap object. 1044 1044 template<class T> 1045 1045 DfsWizard<SetDistMapBase<T> > distMap(const T &t) … … 1056 1056 }; 1057 1057 ///\brief \ref named-func-param "Named parameter" 1058 ///for setting \refProcessedMap object.1058 ///for setting ProcessedMap object. 1059 1059 /// 1060 1060 /// \ref named-func-param "Named parameter" 1061 ///for setting \refProcessedMap object.1061 ///for setting ProcessedMap object. 1062 1062 template<class T> 1063 1063 DfsWizard<SetProcessedMapBase<T> > processedMap(const T &t) … … 1214 1214 typedef typename Digraph::template NodeMap<bool> ReachedMap; 1215 1215 1216 /// \brief Instantiates a \refReachedMap.1217 /// 1218 /// This function instantiates a \refReachedMap.1216 /// \brief Instantiates a ReachedMap. 1217 /// 1218 /// This function instantiates a ReachedMap. 1219 1219 /// \param digraph is the digraph, to which 1220 /// we would like to define the \refReachedMap.1220 /// we would like to define the ReachedMap. 1221 1221 static ReachedMap *createReachedMap(const Digraph &digraph) { 1222 1222 return new ReachedMap(digraph); -
lemon/dijkstra.h
r290 r301 140 140 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 141 141 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap; 142 ///Instantiates a \refPredMap.143 144 ///This function instantiates a \refPredMap.142 ///Instantiates a PredMap. 143 144 ///This function instantiates a PredMap. 145 145 ///\param g is the digraph, to which we would like to define the 146 /// \refPredMap.146 ///PredMap. 147 147 static PredMap *createPredMap(const Digraph &g) 148 148 { … … 156 156 ///By default it is a NullMap. 157 157 typedef NullMap<typename Digraph::Node,bool> ProcessedMap; 158 ///Instantiates a \refProcessedMap.159 160 ///This function instantiates a \refProcessedMap.158 ///Instantiates a ProcessedMap. 159 160 ///This function instantiates a ProcessedMap. 161 161 ///\param g is the digraph, to which 162 ///we would like to define the \refProcessedMap162 ///we would like to define the ProcessedMap 163 163 #ifdef DOXYGEN 164 164 static ProcessedMap *createProcessedMap(const Digraph &g) … … 175 175 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 176 176 typedef typename Digraph::template NodeMap<typename LM::Value> DistMap; 177 ///Instantiates a \refDistMap.178 179 ///This function instantiates a \refDistMap.177 ///Instantiates a DistMap. 178 179 ///This function instantiates a DistMap. 180 180 ///\param g is the digraph, to which we would like to define 181 ///the \refDistMap181 ///the DistMap 182 182 static DistMap *createDistMap(const Digraph &g) 183 183 { … … 328 328 }; 329 329 ///\brief \ref named-templ-param "Named parameter" for setting 330 /// \refPredMap type.330 ///PredMap type. 331 331 /// 332 332 ///\ref named-templ-param "Named parameter" for setting 333 /// \refPredMap type.333 ///PredMap type. 334 334 template <class T> 335 335 struct SetPredMap … … 348 348 }; 349 349 ///\brief \ref named-templ-param "Named parameter" for setting 350 /// \refDistMap type.350 ///DistMap type. 351 351 /// 352 352 ///\ref named-templ-param "Named parameter" for setting 353 /// \refDistMap type.353 ///DistMap type. 354 354 template <class T> 355 355 struct SetDistMap … … 368 368 }; 369 369 ///\brief \ref named-templ-param "Named parameter" for setting 370 /// \refProcessedMap type.370 ///ProcessedMap type. 371 371 /// 372 372 ///\ref named-templ-param "Named parameter" for setting 373 /// \refProcessedMap type.373 ///ProcessedMap type. 374 374 template <class T> 375 375 struct SetProcessedMap … … 386 386 }; 387 387 ///\brief \ref named-templ-param "Named parameter" for setting 388 /// \refProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.388 ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>. 389 389 /// 390 390 ///\ref named-templ-param "Named parameter" for setting 391 /// \refProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.391 ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>. 392 392 ///If you don't set it explicitly, it will be automatically allocated. 393 393 struct SetStandardProcessedMap … … 987 987 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 988 988 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap; 989 ///Instantiates a \refPredMap.990 991 ///This function instantiates a \refPredMap.989 ///Instantiates a PredMap. 990 991 ///This function instantiates a PredMap. 992 992 ///\param g is the digraph, to which we would like to define the 993 /// \refPredMap.993 ///PredMap. 994 994 static PredMap *createPredMap(const Digraph &g) 995 995 { … … 1003 1003 ///By default it is a NullMap. 1004 1004 typedef NullMap<typename Digraph::Node,bool> ProcessedMap; 1005 ///Instantiates a \refProcessedMap.1006 1007 ///This function instantiates a \refProcessedMap.1005 ///Instantiates a ProcessedMap. 1006 1007 ///This function instantiates a ProcessedMap. 1008 1008 ///\param g is the digraph, to which 1009 ///we would like to define the \refProcessedMap.1009 ///we would like to define the ProcessedMap. 1010 1010 #ifdef DOXYGEN 1011 1011 static ProcessedMap *createProcessedMap(const Digraph &g) … … 1022 1022 ///It must meet the \ref concepts::WriteMap "WriteMap" concept. 1023 1023 typedef typename Digraph::template NodeMap<typename LM::Value> DistMap; 1024 ///Instantiates a \refDistMap.1025 1026 ///This function instantiates a \refDistMap.1024 ///Instantiates a DistMap. 1025 1026 ///This function instantiates a DistMap. 1027 1027 ///\param g is the digraph, to which we would like to define 1028 ///the \refDistMap1028 ///the DistMap 1029 1029 static DistMap *createDistMap(const Digraph &g) 1030 1030 { … … 1199 1199 }; 1200 1200 ///\brief \ref named-func-param "Named parameter" 1201 ///for setting \refPredMap object.1201 ///for setting PredMap object. 1202 1202 /// 1203 1203 ///\ref named-func-param "Named parameter" 1204 ///for setting \refPredMap object.1204 ///for setting PredMap object. 1205 1205 template<class T> 1206 1206 DijkstraWizard<SetPredMapBase<T> > predMap(const T &t) … … 1217 1217 }; 1218 1218 ///\brief \ref named-func-param "Named parameter" 1219 ///for setting \refDistMap object.1219 ///for setting DistMap object. 1220 1220 /// 1221 1221 ///\ref named-func-param "Named parameter" 1222 ///for setting \refDistMap object.1222 ///for setting DistMap object. 1223 1223 template<class T> 1224 1224 DijkstraWizard<SetDistMapBase<T> > distMap(const T &t) … … 1235 1235 }; 1236 1236 ///\brief \ref named-func-param "Named parameter" 1237 ///for setting \refProcessedMap object.1237 ///for setting ProcessedMap object. 1238 1238 /// 1239 1239 /// \ref named-func-param "Named parameter" 1240 ///for setting \refProcessedMap object.1240 ///for setting ProcessedMap object. 1241 1241 template<class T> 1242 1242 DijkstraWizard<SetProcessedMapBase<T> > processedMap(const T &t) -
lemon/maps.h
r280 r301 74 74 }; 75 75 76 /// Returns a \ refNullMap class77 78 /// This function just returns a \ refNullMap class.76 /// Returns a \c NullMap class 77 78 /// This function just returns a \c NullMap class. 79 79 /// \relates NullMap 80 80 template <typename K, typename V> … … 89 89 /// value to each key. 90 90 /// 91 /// In other aspects it is equivalent to \ refNullMap.91 /// In other aspects it is equivalent to \c NullMap. 92 92 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap" 93 93 /// concept, but it absorbs the data written to it. … … 134 134 }; 135 135 136 /// Returns a \ refConstMap class137 138 /// This function just returns a \ refConstMap class.136 /// Returns a \c ConstMap class 137 138 /// This function just returns a \c ConstMap class. 139 139 /// \relates ConstMap 140 140 template<typename K, typename V> … … 157 157 /// value to each key. 158 158 /// 159 /// In other aspects it is equivalent to \ refNullMap.159 /// In other aspects it is equivalent to \c NullMap. 160 160 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap" 161 161 /// concept, but it absorbs the data written to it. … … 183 183 }; 184 184 185 /// Returns a \ refConstMap class with inlined constant value186 187 /// This function just returns a \ refConstMap class with inlined185 /// Returns a \c ConstMap class with inlined constant value 186 187 /// This function just returns a \c ConstMap class with inlined 188 188 /// constant value. 189 189 /// \relates ConstMap … … 213 213 }; 214 214 215 /// Returns an \ refIdentityMap class216 217 /// This function just returns an \ refIdentityMap class.215 /// Returns an \c IdentityMap class 216 217 /// This function just returns an \c IdentityMap class. 218 218 /// \relates IdentityMap 219 219 template<typename T> … … 229 229 /// values to integer keys from the range <tt>[0..size-1]</tt>. 230 230 /// It can be used with some data structures, for example 231 /// \ ref UnionFind, \refBinHeap, when the used items are small231 /// \c UnionFind, \c BinHeap, when the used items are small 232 232 /// integers. This map conforms the \ref concepts::ReferenceMap 233 233 /// "ReferenceMap" concept. … … 269 269 : _vector(vector.begin(), vector.end()) {} 270 270 271 /// Constructs the map from another \ refRangeMap.271 /// Constructs the map from another \c RangeMap. 272 272 template <typename V1> 273 273 RangeMap(const RangeMap<V1> &c) … … 312 312 }; 313 313 314 /// Returns a \ refRangeMap class315 316 /// This function just returns a \ refRangeMap class.314 /// Returns a \c RangeMap class 315 316 /// This function just returns a \c RangeMap class. 317 317 /// \relates RangeMap 318 318 template<typename V> … … 321 321 } 322 322 323 /// \brief Returns a \ refRangeMap class created from an appropriate323 /// \brief Returns a \c RangeMap class created from an appropriate 324 324 /// \c std::vector 325 325 326 /// This function just returns a \ refRangeMap class created from an326 /// This function just returns a \c RangeMap class created from an 327 327 /// appropriate \c std::vector. 328 328 /// \relates RangeMap … … 389 389 : _map(map.begin(), map.end()), _value(value) {} 390 390 391 /// \brief Constructs the map from another \ refSparseMap.391 /// \brief Constructs the map from another \c SparseMap. 392 392 template<typename V1, typename Comp1> 393 393 SparseMap(const SparseMap<Key, V1, Comp1> &c) … … 434 434 }; 435 435 436 /// Returns a \ refSparseMap class437 438 /// This function just returns a \ refSparseMap class with specified436 /// Returns a \c SparseMap class 437 438 /// This function just returns a \c SparseMap class with specified 439 439 /// default value. 440 440 /// \relates SparseMap … … 449 449 } 450 450 451 /// \brief Returns a \ refSparseMap class created from an appropriate451 /// \brief Returns a \c SparseMap class created from an appropriate 452 452 /// \c std::map 453 453 454 /// This function just returns a \ refSparseMap class created from an454 /// This function just returns a \c SparseMap class created from an 455 455 /// appropriate \c std::map. 456 456 /// \relates SparseMap … … 502 502 }; 503 503 504 /// Returns a \ refComposeMap class505 506 /// This function just returns a \ refComposeMap class.504 /// Returns a \c ComposeMap class 505 506 /// This function just returns a \c ComposeMap class. 507 507 /// 508 508 /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is … … 557 557 }; 558 558 559 /// Returns a \ refCombineMap class560 561 /// This function just returns a \ refCombineMap class.559 /// Returns a \c CombineMap class 560 561 /// This function just returns a \c CombineMap class. 562 562 /// 563 563 /// For example, if \c m1 and \c m2 are both maps with \c double … … 626 626 }; 627 627 628 /// Returns a \ refFunctorToMap class629 630 /// This function just returns a \ refFunctorToMap class.628 /// Returns a \c FunctorToMap class 629 630 /// This function just returns a \c FunctorToMap class. 631 631 /// 632 632 /// This function is specialized for adaptable binary function … … 685 685 }; 686 686 687 /// Returns a \ refMapToFunctor class688 689 /// This function just returns a \ refMapToFunctor class.687 /// Returns a \c MapToFunctor class 688 689 /// This function just returns a \c MapToFunctor class. 690 690 /// \relates MapToFunctor 691 691 template<typename M> … … 724 724 }; 725 725 726 /// Returns a \ refConvertMap class727 728 /// This function just returns a \ refConvertMap class.726 /// Returns a \c ConvertMap class 727 728 /// This function just returns a \c ConvertMap class. 729 729 /// \relates ConvertMap 730 730 template<typename V, typename M> … … 764 764 }; 765 765 766 /// Returns a \ refForkMap class767 768 /// This function just returns a \ refForkMap class.766 /// Returns a \c ForkMap class 767 768 /// This function just returns a \c ForkMap class. 769 769 /// \relates ForkMap 770 770 template <typename M1, typename M2> … … 808 808 }; 809 809 810 /// Returns an \ refAddMap class811 812 /// This function just returns an \ refAddMap class.810 /// Returns an \c AddMap class 811 812 /// This function just returns an \c AddMap class. 813 813 /// 814 814 /// For example, if \c m1 and \c m2 are both maps with \c double … … 856 856 }; 857 857 858 /// Returns a \ refSubMap class859 860 /// This function just returns a \ refSubMap class.858 /// Returns a \c SubMap class 859 860 /// This function just returns a \c SubMap class. 861 861 /// 862 862 /// For example, if \c m1 and \c m2 are both maps with \c double … … 905 905 }; 906 906 907 /// Returns a \ refMulMap class908 909 /// This function just returns a \ refMulMap class.907 /// Returns a \c MulMap class 908 909 /// This function just returns a \c MulMap class. 910 910 /// 911 911 /// For example, if \c m1 and \c m2 are both maps with \c double … … 953 953 }; 954 954 955 /// Returns a \ refDivMap class956 957 /// This function just returns a \ refDivMap class.955 /// Returns a \c DivMap class 956 957 /// This function just returns a \c DivMap class. 958 958 /// 959 959 /// For example, if \c m1 and \c m2 are both maps with \c double … … 1039 1039 }; 1040 1040 1041 /// Returns a \ refShiftMap class1042 1043 /// This function just returns a \ refShiftMap class.1041 /// Returns a \c ShiftMap class 1042 1043 /// This function just returns a \c ShiftMap class. 1044 1044 /// 1045 1045 /// For example, if \c m is a map with \c double values and \c v is … … 1053 1053 } 1054 1054 1055 /// Returns a \ refShiftWriteMap class1056 1057 /// This function just returns a \ refShiftWriteMap class.1055 /// Returns a \c ShiftWriteMap class 1056 1057 /// This function just returns a \c ShiftWriteMap class. 1058 1058 /// 1059 1059 /// For example, if \c m is a map with \c double values and \c v is … … 1141 1141 }; 1142 1142 1143 /// Returns a \ refScaleMap class1144 1145 /// This function just returns a \ refScaleMap class.1143 /// Returns a \c ScaleMap class 1144 1145 /// This function just returns a \c ScaleMap class. 1146 1146 /// 1147 1147 /// For example, if \c m is a map with \c double values and \c v is … … 1155 1155 } 1156 1156 1157 /// Returns a \ refScaleWriteMap class1158 1159 /// This function just returns a \ refScaleWriteMap class.1157 /// Returns a \c ScaleWriteMap class 1158 1159 /// This function just returns a \c ScaleWriteMap class. 1160 1160 /// 1161 1161 /// For example, if \c m is a map with \c double values and \c v is … … 1241 1241 }; 1242 1242 1243 /// Returns a \ refNegMap class1244 1245 /// This function just returns a \ refNegMap class.1243 /// Returns a \c NegMap class 1244 1245 /// This function just returns a \c NegMap class. 1246 1246 /// 1247 1247 /// For example, if \c m is a map with \c double values, then … … 1254 1254 } 1255 1255 1256 /// Returns a \ refNegWriteMap class1257 1258 /// This function just returns a \ refNegWriteMap class.1256 /// Returns a \c NegWriteMap class 1257 1258 /// This function just returns a \c NegWriteMap class. 1259 1259 /// 1260 1260 /// For example, if \c m is a map with \c double values, then … … 1297 1297 }; 1298 1298 1299 /// Returns an \ refAbsMap class1300 1301 /// This function just returns an \ refAbsMap class.1299 /// Returns an \c AbsMap class 1300 1301 /// This function just returns an \c AbsMap class. 1302 1302 /// 1303 1303 /// For example, if \c m is a map with \c double values, then … … 1346 1346 }; 1347 1347 1348 /// Returns a \ refTrueMap class1349 1350 /// This function just returns a \ refTrueMap class.1348 /// Returns a \c TrueMap class 1349 1350 /// This function just returns a \c TrueMap class. 1351 1351 /// \relates TrueMap 1352 1352 template<typename K> … … 1383 1383 }; 1384 1384 1385 /// Returns a \ refFalseMap class1386 1387 /// This function just returns a \ refFalseMap class.1385 /// Returns a \c FalseMap class 1386 1387 /// This function just returns a \c FalseMap class. 1388 1388 /// \relates FalseMap 1389 1389 template<typename K> … … 1430 1430 }; 1431 1431 1432 /// Returns an \ refAndMap class1433 1434 /// This function just returns an \ refAndMap class.1432 /// Returns an \c AndMap class 1433 1434 /// This function just returns an \c AndMap class. 1435 1435 /// 1436 1436 /// For example, if \c m1 and \c m2 are both maps with \c bool values, … … 1478 1478 }; 1479 1479 1480 /// Returns an \ refOrMap class1481 1482 /// This function just returns an \ refOrMap class.1480 /// Returns an \c OrMap class 1481 1482 /// This function just returns an \c OrMap class. 1483 1483 /// 1484 1484 /// For example, if \c m1 and \c m2 are both maps with \c bool values, … … 1545 1545 }; 1546 1546 1547 /// Returns a \ refNotMap class1548 1549 /// This function just returns a \ refNotMap class.1547 /// Returns a \c NotMap class 1548 1549 /// This function just returns a \c NotMap class. 1550 1550 /// 1551 1551 /// For example, if \c m is a map with \c bool values, then … … 1558 1558 } 1559 1559 1560 /// Returns a \ refNotWriteMap class1561 1562 /// This function just returns a \ refNotWriteMap class.1560 /// Returns a \c NotWriteMap class 1561 1562 /// This function just returns a \c NotWriteMap class. 1563 1563 /// 1564 1564 /// For example, if \c m is a map with \c bool values, then … … 1606 1606 }; 1607 1607 1608 /// Returns an \ refEqualMap class1609 1610 /// This function just returns an \ refEqualMap class.1608 /// Returns an \c EqualMap class 1609 1610 /// This function just returns an \c EqualMap class. 1611 1611 /// 1612 1612 /// For example, if \c m1 and \c m2 are maps with keys and values of … … 1654 1654 }; 1655 1655 1656 /// Returns an \ refLessMap class1657 1658 /// This function just returns an \ refLessMap class.1656 /// Returns an \c LessMap class 1657 1658 /// This function just returns an \c LessMap class. 1659 1659 /// 1660 1660 /// For example, if \c m1 and \c m2 are maps with keys and values of … … 1746 1746 }; 1747 1747 1748 /// Returns a \ refLoggerBoolMap class1749 1750 /// This function just returns a \ refLoggerBoolMap class.1748 /// Returns a \c LoggerBoolMap class 1749 1750 /// This function just returns a \c LoggerBoolMap class. 1751 1751 /// 1752 1752 /// The most important usage of it is storing certain nodes or arcs … … 1768 1768 /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so 1769 1769 /// it cannot be used when a readable map is needed, for example as 1770 /// \c ReachedMap for \ ref Bfs, \ref Dfs and \refDijkstra algorithms.1770 /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms. 1771 1771 /// 1772 1772 /// \relates LoggerBoolMap … … 2283 2283 }; 2284 2284 2285 /// \brief Returns a \ refSourceMap class.2286 /// 2287 /// This function just returns an \ refSourceMap class.2285 /// \brief Returns a \c SourceMap class. 2286 /// 2287 /// This function just returns an \c SourceMap class. 2288 2288 /// \relates SourceMap 2289 2289 template <typename Digraph> … … 2322 2322 }; 2323 2323 2324 /// \brief Returns a \ refTargetMap class.2325 /// 2326 /// This function just returns a \ refTargetMap class.2324 /// \brief Returns a \c TargetMap class. 2325 /// 2326 /// This function just returns a \c TargetMap class. 2327 2327 /// \relates TargetMap 2328 2328 template <typename Digraph> … … 2361 2361 }; 2362 2362 2363 /// \brief Returns a \ refForwardMap class.2364 /// 2365 /// This function just returns an \ refForwardMap class.2363 /// \brief Returns a \c ForwardMap class. 2364 /// 2365 /// This function just returns an \c ForwardMap class. 2366 2366 /// \relates ForwardMap 2367 2367 template <typename Graph> … … 2400 2400 }; 2401 2401 2402 /// \brief Returns a \ refBackwardMap class2403 2404 /// This function just returns a \ refBackwardMap class.2402 /// \brief Returns a \c BackwardMap class 2403 2404 /// This function just returns a \c BackwardMap class. 2405 2405 /// \relates BackwardMap 2406 2406 template <typename Graph>
Note: See TracChangeset
for help on using the changeset viewer.
