COIN-OR::LEMON - Graph Library

Changeset 33:d794ec195ec0 in lemon for lemon/maps.h


Ignore:
Timestamp:
01/04/08 23:13:45 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Doc improvements in maps.h.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/maps.h

    r30 r33  
    4545  class MapBase {
    4646  public:
    47     ///\e
     47    /// The key type of the map.
    4848    typedef K Key;
    49     ///\e
     49    /// The value type of the map. (The type of objects associated with the keys).
    5050    typedef T Value;
    5151  };
     
    250250  };
    251251
    252   /// \brief Map for storing values for the range \c [0..size-1] range keys
    253   ///
    254   /// The current map has the \c [0..size-1] keyset and the values
     252  /// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt>
     253  ///
     254  /// The current map has the <tt>[0..size-1]</tt> keyset and the values
    255255  /// are stored in a \c std::vector<T>  container. It can be used with
    256256  /// some data structures, for example \c UnionFind, \c BinHeap, when
     
    830830  ///For example if \c m1 and \c m2 are both \c double valued maps, then
    831831  ///\code
    832   ///combineMap<double>(m1,m2,std::plus<double>())
     832  ///combineMap(m1,m2,std::plus<double>())
    833833  ///\endcode
    834834  ///is equivalent to
     
    963963  ///
    964964  ///Template parameters \c K and \c V will become its
    965   ///\c Key and \c Value. They must be given explicitly
    966   ///because a functor does not provide such typedefs.
     965  ///\c Key and \c Value.
     966  ///In most cases they have to be given explicitly because a
     967  ///functor typically does not provide such typedefs.
    967968  ///
    968969  ///Parameter \c F is the type of the used functor.
     
    12411242  ///
    12421243  ///\sa BackInserterBoolMap
     1244  ///\sa FrontInserterBoolMap
     1245  ///\sa InserterBoolMap
    12431246  ///
    12441247  ///\todo Revise the name of this class and the related ones.
Note: See TracChangeset for help on using the changeset viewer.