COIN-OR::LEMON - Graph Library

Changeset 805:59b8cb2cb2f8 in lemon-0.x


Ignore:
Timestamp:
09/06/04 10:22:48 (15 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1099
Message:

Changes in doc.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/hugo/maps.h

    r720 r805  
    1515  /// Base class of maps.
    1616
     17  /// Base class of maps.
     18  /// It provides the necessary <tt>typedef</tt>s required by the map concept.
    1719  template<typename K, typename T>
    1820  class MapBase
    1921  {
    2022  public:
    21     ///
     23    /// .
    2224    typedef K KeyType;
    23     ///
     25    /// .
    2426    typedef T ValueType;
    2527  };
    2628
    27   /// Null map. (aka DoNothingMap)
     29  /// Null map. (a.k.a. DoNothingMap)
    2830
    2931  /// If you have to provide a map only for its type definitions,
    30   /// or if you have to provide a writable map, but will not use the
    31   /// data written to it...
     32  /// or if you have to provide a writable map, but
     33  /// data written to it will sent to <tt>/dev/null</tt>...
    3234  template<typename K, typename T>
    3335  class NullMap : public MapBase<K,T>
     
    3537  public:
    3638
     39    /// Gives back a default constructed element.
    3740    T operator[](const K&) const { return T(); }
     41    /// Absorbs the value.
    3842    void set(const K&, const T&) {}
    39     ///\bug when update is removed from map concepts by being dynamic
    40     ///stuffs, this line have to be removed.
    41     void update() { }
    4243  };
    4344
     
    4546  /// Constant map.
    4647
    47   /// This is a readable map which assignes a specified value to each key.
    48   /// In other aspects it is equivalent to the \ref NullMap
     48  /// This is a readable map which assigns a specified value to each key.
     49  /// In other aspects it is equivalent to the \ref NullMap.
     50  /// \todo set could be used to set the value.
    4951  template<typename K, typename T>
    5052  class ConstMap : public MapBase<K,T>
     
    5355  public:
    5456
     57    /// Default constructor
     58
     59    /// The value of the map will be uninitialized.
     60    /// (More exactly it will be default constructed.)
    5561    ConstMap() {}
     62    /// .
     63
     64    /// \param _v The initial value of the map.
    5665    ConstMap(const T &_v) : v(_v) {}
    5766
     
    124133    /// \return Returns the previous default value.
    125134    ///
    126     /// \warning The value of some keys (which has alredy been queried, but
     135    /// \warning The value of some keys (which has already been queried, but
    127136    /// the value has been unchanged from the default) may change!
    128137    T setDefault(const T &_v) { T old=v; v=_v; return old; }
Note: See TracChangeset for help on using the changeset viewer.