COIN-OR::LEMON - Graph Library

Changeset 2258:741995f3dbc4 in lemon-0.x for lemon/maps.h


Ignore:
Timestamp:
10/22/06 21:45:57 (13 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3013
Message:

Docfix.
maps.h is still very fuzzy.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/maps.h

    r2248 r2258  
    10191019 
    10201020  ///This bool \ref concept::ReadWriteMap "read-write map" returns the
    1021   ///logical negation of value returned by the given map. It is setted
    1022   ///then the negation of the value be setted to the original map.
     1021  ///logical negation of value returned by the given map. When it is set,
     1022  ///the opposite value is set to the original map.
    10231023  ///Its \c Key and will be inherited from \c M,
    10241024  ///its Value is <tt>bool</tt>.
     
    10651065  /// \brief Writable bool map for store each true assigned elements.
    10661066  ///
    1067   /// Writable bool map for store each true assigned elements. It will
    1068   /// copies all the true setted keys to the given iterator.
     1067  /// Writable bool map to store each true assigned elements. It will
     1068  /// copies all the keys set to true to the given iterator.
    10691069  ///
    10701070  /// \note The container of the iterator should contain space
     
    11011101      : _begin(it), _end(it), _functor(functor) {}
    11021102
    1103     /// Gives back the given first setted iterator.
     1103    /// Gives back the given iterator set for the first time.
    11041104    Iterator begin() const {
    11051105      return _begin;
    11061106    }
    11071107 
    1108     /// Gives back the iterator after the last setted.
     1108    /// Gives back the iterator after the last set operation.
    11091109    Iterator end() const {
    11101110      return _end;
     
    11271127  ///
    11281128  /// Writable bool map for store each true assigned elements in a back
    1129   /// insertable container. It will push back all the true setted keys into
     1129  /// insertable container. It will push back all the keys set to true into
    11301130  /// the container. It can be used to retrieve the items into a standard
    11311131  /// container. The next example shows how can you store the undirected
     
    11661166  ///
    11671167  /// Writable bool map for store each true assigned elements in a front
    1168   /// insertable container. It will push front all the true setted keys into
     1168  /// insertable container. It will push front all the keys set to \c true into
    11691169  /// the container. For example see the BackInserterBoolMap.
    11701170  template <typename Container,
     
    11971197  ///
    11981198  /// Writable bool map for store each true assigned elements in an
    1199   /// insertable container. It will insert all the true setted keys into
     1199  /// insertable container. It will insert all the keys set to \c true into
    12001200  /// the container. If you want to store the cut edges of the strongly
    12011201  /// connected components in a set you can use the next code:
     
    12371237  };
    12381238
    1239   /// \brief Fill the true setted elements with a given value.
    1240   ///
    1241   /// Writable bool map for fill the true setted elements with a given value.
    1242   /// The value can be setted
     1239  /// \brief Fill the true set elements with a given value.
     1240  ///
     1241  /// Writable bool map to fill the elements set to \c true with a given value.
     1242  /// The value can set
    12431243  /// the container.
    12441244  ///
     
    13631363      : map(_map), counter(0) {}
    13641364
    1365     /// Number of setted keys.
     1365    /// Number of set operations.
    13661366    int num() const {
    13671367      return counter;
Note: See TracChangeset for help on using the changeset viewer.