lemon/maps.h
changeset 1547 dd57a540ff5f
parent 1537 0d9f1a71be27
child 1555 48769ac7ec32
     1.1 --- a/lemon/maps.h	Tue Jul 12 16:15:37 2005 +0000
     1.2 +++ b/lemon/maps.h	Tue Jul 12 16:16:19 2005 +0000
     1.3 @@ -221,13 +221,11 @@
     1.4      }
     1.5    };
     1.6  
     1.7 -  ///Convert the \c Value of a maps to another type.
     1.8 +  ///Convert the \c Value of a map to another type.
     1.9  
    1.10    ///This \ref concept::ReadMap "read only map"
    1.11    ///converts the \c Value of a maps to type \c T.
    1.12 -  ///Its \c Value is inherited from \c M.
    1.13 -  ///
    1.14 -  ///\bug wrong documentation
    1.15 +  ///Its \c Key is inherited from \c M.
    1.16    template<class M, class T> 
    1.17    class ConvertMap {
    1.18      typename SmartConstReference<M>::Type m;
    1.19 @@ -304,7 +302,7 @@
    1.20      return AddMap<M1,M2>(m1,m2);
    1.21    }
    1.22  
    1.23 -  ///Shift a maps with a constant.
    1.24 +  ///Shift a map with a constant.
    1.25  
    1.26    ///This \ref concept::ReadMap "read only map" returns the sum of the
    1.27    ///given map and a constant value.
    1.28 @@ -314,7 +312,7 @@
    1.29    ///\code
    1.30    ///  ShiftMap<X> sh(x,v);
    1.31    ///\endcode
    1.32 -  ///it is equivalent with
    1.33 +  ///is equivalent with
    1.34    ///\code
    1.35    ///  ConstMap<X::Key, X::Value> c_tmp(v);
    1.36    ///  AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);
    1.37 @@ -355,7 +353,7 @@
    1.38    ///Difference of two maps
    1.39  
    1.40    ///This \ref concept::ReadMap "read only map" returns the difference
    1.41 -  ///of the values returned by the two
    1.42 +  ///of the values of the two
    1.43    ///given maps. Its \c Key and \c Value will be inherited from \c M1.
    1.44    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
    1.45  
    1.46 @@ -391,7 +389,7 @@
    1.47    ///Product of two maps
    1.48  
    1.49    ///This \ref concept::ReadMap "read only map" returns the product of the
    1.50 -  ///values returned by the two
    1.51 +  ///values of the two
    1.52    ///given
    1.53    ///maps. Its \c Key and \c Value will be inherited from \c M1.
    1.54    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
    1.55 @@ -424,17 +422,17 @@
    1.56      return MulMap<M1,M2>(m1,m2);
    1.57    }
    1.58   
    1.59 -  ///Scale a maps with a constant.
    1.60 +  ///Scales a maps with a constant.
    1.61  
    1.62    ///This \ref concept::ReadMap "read only map" returns the value of the
    1.63 -  ///given map multipied with a constant value.
    1.64 +  ///given map multiplied with a constant value.
    1.65    ///Its \c Key and \c Value is inherited from \c M.
    1.66    ///
    1.67    ///Actually,
    1.68    ///\code
    1.69    ///  ScaleMap<X> sc(x,v);
    1.70    ///\endcode
    1.71 -  ///it is equivalent with
    1.72 +  ///is equivalent with
    1.73    ///\code
    1.74    ///  ConstMap<X::Key, X::Value> c_tmp(v);
    1.75    ///  MulMap<X, ConstMap<X::Key, X::Value> > sc(x,v);
    1.76 @@ -475,7 +473,7 @@
    1.77    ///Quotient of two maps
    1.78  
    1.79    ///This \ref concept::ReadMap "read only map" returns the quotient of the
    1.80 -  ///values returned by the two
    1.81 +  ///values of the two
    1.82    ///given maps. Its \c Key and \c Value will be inherited from \c M1.
    1.83    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
    1.84  
    1.85 @@ -552,14 +550,14 @@
    1.86      return ComposeMap<M1,M2>(m1,m2);
    1.87    }
    1.88    
    1.89 -  ///Combine of two maps using an STL (binary) functor.
    1.90 +  ///Combines of two maps using an STL (binary) functor.
    1.91  
    1.92 -  ///Combine of two maps using an STL (binary) functor.
    1.93 +  ///Combines of two maps using an STL (binary) functor.
    1.94    ///
    1.95    ///
    1.96 -  ///This \ref concept::ReadMap "read only map" takes to maps and a
    1.97 +  ///This \ref concept::ReadMap "read only map" takes two maps and a
    1.98    ///binary functor and returns the composition of
    1.99 -  ///two
   1.100 +  ///the two
   1.101    ///given maps unsing the functor. 
   1.102    ///That is to say, if \c m1 and \c m2 is of type \c M1 and \c M2
   1.103    ///and \c f is of \c F,
   1.104 @@ -789,7 +787,7 @@
   1.105    }
   1.106  
   1.107  
   1.108 -  ///Apply all map setting operations to two maps
   1.109 +  ///Applies all map setting operations to two maps
   1.110  
   1.111    ///This map has two \ref concept::WriteMap "writable map"
   1.112    ///parameters and each write request will be passed to both of them.