COIN-OR::LEMON - Graph Library

Changeset 1547:dd57a540ff5f in lemon-0.x for lemon/maps.h


Ignore:
Timestamp:
07/12/05 18:16:19 (14 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2043
Message:

Improve doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/maps.h

    r1537 r1547  
    222222  };
    223223
    224   ///Convert the \c Value of a maps to another type.
     224  ///Convert the \c Value of a map to another type.
    225225
    226226  ///This \ref concept::ReadMap "read only map"
    227227  ///converts the \c Value of a maps to type \c T.
    228   ///Its \c Value is inherited from \c M.
    229   ///
    230   ///\bug wrong documentation
     228  ///Its \c Key is inherited from \c M.
    231229  template<class M, class T>
    232230  class ConvertMap {
     
    305303  }
    306304
    307   ///Shift a maps with a constant.
     305  ///Shift a map with a constant.
    308306
    309307  ///This \ref concept::ReadMap "read only map" returns the sum of the
     
    315313  ///  ShiftMap<X> sh(x,v);
    316314  ///\endcode
    317   ///it is equivalent with
     315  ///is equivalent with
    318316  ///\code
    319317  ///  ConstMap<X::Key, X::Value> c_tmp(v);
     
    356354
    357355  ///This \ref concept::ReadMap "read only map" returns the difference
    358   ///of the values returned by the two
     356  ///of the values of the two
    359357  ///given maps. Its \c Key and \c Value will be inherited from \c M1.
    360358  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
     
    392390
    393391  ///This \ref concept::ReadMap "read only map" returns the product of the
    394   ///values returned by the two
     392  ///values of the two
    395393  ///given
    396394  ///maps. Its \c Key and \c Value will be inherited from \c M1.
     
    425423  }
    426424 
    427   ///Scale a maps with a constant.
     425  ///Scales a maps with a constant.
    428426
    429427  ///This \ref concept::ReadMap "read only map" returns the value of the
    430   ///given map multipied with a constant value.
     428  ///given map multiplied with a constant value.
    431429  ///Its \c Key and \c Value is inherited from \c M.
    432430  ///
     
    435433  ///  ScaleMap<X> sc(x,v);
    436434  ///\endcode
    437   ///it is equivalent with
     435  ///is equivalent with
    438436  ///\code
    439437  ///  ConstMap<X::Key, X::Value> c_tmp(v);
     
    476474
    477475  ///This \ref concept::ReadMap "read only map" returns the quotient of the
    478   ///values returned by the two
     476  ///values of the two
    479477  ///given maps. Its \c Key and \c Value will be inherited from \c M1.
    480478  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
     
    553551  }
    554552 
    555   ///Combine of two maps using an STL (binary) functor.
    556 
    557   ///Combine of two maps using an STL (binary) functor.
    558   ///
    559   ///
    560   ///This \ref concept::ReadMap "read only map" takes to maps and a
     553  ///Combines of two maps using an STL (binary) functor.
     554
     555  ///Combines of two maps using an STL (binary) functor.
     556  ///
     557  ///
     558  ///This \ref concept::ReadMap "read only map" takes two maps and a
    561559  ///binary functor and returns the composition of
    562   ///two
     560  ///the two
    563561  ///given maps unsing the functor.
    564562  ///That is to say, if \c m1 and \c m2 is of type \c M1 and \c M2
     
    790788
    791789
    792   ///Apply all map setting operations to two maps
     790  ///Applies all map setting operations to two maps
    793791
    794792  ///This map has two \ref concept::WriteMap "writable map"
Note: See TracChangeset for help on using the changeset viewer.