lemon/maps.h
changeset 2260 4274224f8a7d
parent 2258 741995f3dbc4
child 2391 14a343be7a5a
     1.1 --- a/lemon/maps.h	Tue Oct 24 16:49:41 2006 +0000
     1.2 +++ b/lemon/maps.h	Tue Oct 24 17:19:16 2006 +0000
     1.3 @@ -29,7 +29,7 @@
     1.4  ///\ingroup maps
     1.5  ///\brief Miscellaneous property maps
     1.6  ///
     1.7 -///\todo This file has the same name as the concept file in concept/,
     1.8 +///\todo This file has the same name as the concept file in concepts/,
     1.9  /// and this is not easily detectable in docs...
    1.10  
    1.11  #include <map>
    1.12 @@ -252,7 +252,7 @@
    1.13  
    1.14    ///Convert the \c Value of a map to another type.
    1.15  
    1.16 -  ///This \ref concept::ReadMap "read only map"
    1.17 +  ///This \ref concepts::ReadMap "read only map"
    1.18    ///converts the \c Value of a maps to type \c T.
    1.19    ///Its \c Key is inherited from \c M.
    1.20    template <typename M, typename T> 
    1.21 @@ -289,7 +289,7 @@
    1.22  
    1.23    ///Simple wrapping of the map
    1.24  
    1.25 -  ///This \ref concept::ReadMap "read only map" returns the simple
    1.26 +  ///This \ref concepts::ReadMap "read only map" returns the simple
    1.27    ///wrapping of the given map. Sometimes the reference maps cannot be
    1.28    ///combined with simple read maps. This map adaptor wraps the given
    1.29    ///map to simple read map.
    1.30 @@ -309,7 +309,7 @@
    1.31  
    1.32    ///Simple writeable wrapping of the map
    1.33  
    1.34 -  ///This \ref concept::ReadMap "read only map" returns the simple
    1.35 +  ///This \ref concepts::ReadMap "read only map" returns the simple
    1.36    ///wrapping of the given map. Sometimes the reference maps cannot be
    1.37    ///combined with simple read-write maps. This map adaptor wraps the
    1.38    ///given map to simple read-write map.
    1.39 @@ -330,7 +330,7 @@
    1.40  
    1.41    ///Sum of two maps
    1.42  
    1.43 -  ///This \ref concept::ReadMap "read only map" returns the sum of the two
    1.44 +  ///This \ref concepts::ReadMap "read only map" returns the sum of the two
    1.45    ///given maps. Its \c Key and \c Value will be inherited from \c M1.
    1.46    ///The \c Key and \c Value of M2 must be convertible to those of \c M1.
    1.47  
    1.48 @@ -363,7 +363,7 @@
    1.49  
    1.50    ///Shift a map with a constant.
    1.51  
    1.52 -  ///This \ref concept::ReadMap "read only map" returns the sum of the
    1.53 +  ///This \ref concepts::ReadMap "read only map" returns the sum of the
    1.54    ///given map and a constant value.
    1.55    ///Its \c Key and \c Value is inherited from \c M.
    1.56    ///
    1.57 @@ -396,7 +396,7 @@
    1.58  
    1.59    ///Shift a map with a constant.
    1.60  
    1.61 -  ///This \ref concept::ReadWriteMap "read-write map" returns the sum of the
    1.62 +  ///This \ref concepts::ReadWriteMap "read-write map" returns the sum of the
    1.63    ///given map and a constant value. It makes also possible to write the map.
    1.64    ///Its \c Key and \c Value is inherited from \c M.
    1.65    ///
    1.66 @@ -445,7 +445,7 @@
    1.67  
    1.68    ///Difference of two maps
    1.69  
    1.70 -  ///This \ref concept::ReadMap "read only map" returns the difference
    1.71 +  ///This \ref concepts::ReadMap "read only map" returns the difference
    1.72    ///of the values of the two
    1.73    ///given maps. Its \c Key and \c Value will be inherited from \c M1.
    1.74    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
    1.75 @@ -476,7 +476,7 @@
    1.76  
    1.77    ///Product of two maps
    1.78  
    1.79 -  ///This \ref concept::ReadMap "read only map" returns the product of the
    1.80 +  ///This \ref concepts::ReadMap "read only map" returns the product of the
    1.81    ///values of the two
    1.82    ///given
    1.83    ///maps. Its \c Key and \c Value will be inherited from \c M1.
    1.84 @@ -507,7 +507,7 @@
    1.85   
    1.86    ///Scales a maps with a constant.
    1.87  
    1.88 -  ///This \ref concept::ReadMap "read only map" returns the value of the
    1.89 +  ///This \ref concepts::ReadMap "read only map" returns the value of the
    1.90    ///given map multiplied from the left side with a constant value.
    1.91    ///Its \c Key and \c Value is inherited from \c M.
    1.92    ///
    1.93 @@ -540,7 +540,7 @@
    1.94  
    1.95    ///Scales a maps with a constant.
    1.96  
    1.97 -  ///This \ref concept::ReadWriteMap "read-write map" returns the value of the
    1.98 +  ///This \ref concepts::ReadWriteMap "read-write map" returns the value of the
    1.99    ///given map multiplied from the left side with a constant value. It can
   1.100    ///be used as write map also if the given multiplier is not zero.
   1.101    ///Its \c Key and \c Value is inherited from \c M.
   1.102 @@ -580,7 +580,7 @@
   1.103  
   1.104    ///Quotient of two maps
   1.105  
   1.106 -  ///This \ref concept::ReadMap "read only map" returns the quotient of the
   1.107 +  ///This \ref concepts::ReadMap "read only map" returns the quotient of the
   1.108    ///values of the two
   1.109    ///given maps. Its \c Key and \c Value will be inherited from \c M1.
   1.110    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
   1.111 @@ -610,7 +610,7 @@
   1.112    
   1.113    ///Composition of two maps
   1.114  
   1.115 -  ///This \ref concept::ReadMap "read only map" returns the composition of
   1.116 +  ///This \ref concepts::ReadMap "read only map" returns the composition of
   1.117    ///two
   1.118    ///given maps. That is to say, if \c m1 is of type \c M1 and \c m2 is
   1.119    ///of \c M2,
   1.120 @@ -655,7 +655,7 @@
   1.121    ///Combines of two maps using an STL (binary) functor.
   1.122    ///
   1.123    ///
   1.124 -  ///This \ref concept::ReadMap "read only map" takes two maps and a
   1.125 +  ///This \ref concepts::ReadMap "read only map" takes two maps and a
   1.126    ///binary functor and returns the composition of
   1.127    ///the two
   1.128    ///given maps unsing the functor. 
   1.129 @@ -727,7 +727,7 @@
   1.130  
   1.131    ///Negative value of a map
   1.132  
   1.133 -  ///This \ref concept::ReadMap "read only map" returns the negative
   1.134 +  ///This \ref concepts::ReadMap "read only map" returns the negative
   1.135    ///value of the
   1.136    ///value returned by the
   1.137    ///given map. Its \c Key and \c Value will be inherited from \c M.
   1.138 @@ -748,7 +748,7 @@
   1.139    
   1.140    ///Negative value of a map
   1.141  
   1.142 -  ///This \ref concept::ReadWriteMap "read-write map" returns the negative
   1.143 +  ///This \ref concepts::ReadWriteMap "read-write map" returns the negative
   1.144    ///value of the value returned by the
   1.145    ///given map. Its \c Key and \c Value will be inherited from \c M.
   1.146    ///The unary \c - operator must be defined for \c Value, of course.
   1.147 @@ -783,7 +783,7 @@
   1.148  
   1.149    ///Absolute value of a map
   1.150  
   1.151 -  ///This \ref concept::ReadMap "read only map" returns the absolute value
   1.152 +  ///This \ref concepts::ReadMap "read only map" returns the absolute value
   1.153    ///of the
   1.154    ///value returned by the
   1.155    ///given map. Its \c Key and \c Value will be inherited
   1.156 @@ -832,7 +832,7 @@
   1.157  
   1.158    ///Converts an STL style functor to a map
   1.159  
   1.160 -  ///This \ref concept::ReadMap "read only map" returns the value
   1.161 +  ///This \ref concepts::ReadMap "read only map" returns the value
   1.162    ///of a
   1.163    ///given map.
   1.164    ///
   1.165 @@ -890,7 +890,7 @@
   1.166    ///that is it provides an <tt>operator()</tt> to read its values.
   1.167    ///
   1.168    ///For the sake of convenience it also works as
   1.169 -  ///a ususal \ref concept::ReadMap "readable map",
   1.170 +  ///a ususal \ref concepts::ReadMap "readable map",
   1.171    ///i.e. <tt>operator[]</tt> and the \c Key and \c Value typedefs also exist.
   1.172  
   1.173    template <typename M> 
   1.174 @@ -925,7 +925,7 @@
   1.175  
   1.176    ///Applies all map setting operations to two maps
   1.177  
   1.178 -  ///This map has two \ref concept::ReadMap "readable map"
   1.179 +  ///This map has two \ref concepts::ReadMap "readable map"
   1.180    ///parameters and each read request will be passed just to the
   1.181    ///first map. This class is the just readable map type of the ForkWriteMap.
   1.182    ///
   1.183 @@ -949,9 +949,9 @@
   1.184  
   1.185    ///Applies all map setting operations to two maps
   1.186  
   1.187 -  ///This map has two \ref concept::WriteMap "writable map"
   1.188 +  ///This map has two \ref concepts::WriteMap "writable map"
   1.189    ///parameters and each write request will be passed to both of them.
   1.190 -  ///If \c M1 is also \ref concept::ReadMap "readable",
   1.191 +  ///If \c M1 is also \ref concepts::ReadMap "readable",
   1.192    ///then the read operations will return the
   1.193    ///corresponding values of \c M1.
   1.194    ///
   1.195 @@ -996,7 +996,7 @@
   1.196    
   1.197    ///Logical 'not' of a map
   1.198    
   1.199 -  ///This bool \ref concept::ReadMap "read only map" returns the 
   1.200 +  ///This bool \ref concepts::ReadMap "read only map" returns the 
   1.201    ///logical negation of
   1.202    ///value returned by the
   1.203    ///given map. Its \c Key and will be inherited from \c M,
   1.204 @@ -1017,7 +1017,7 @@
   1.205  
   1.206    ///Logical 'not' of a map with writing possibility
   1.207    
   1.208 -  ///This bool \ref concept::ReadWriteMap "read-write map" returns the 
   1.209 +  ///This bool \ref concepts::ReadWriteMap "read-write map" returns the 
   1.210    ///logical negation of value returned by the given map. When it is set,
   1.211    ///the opposite value is set to the original map.
   1.212    ///Its \c Key and will be inherited from \c M,