Changeset 2258:741995f3dbc4 in lemon-0.x

Timestamp:

10/22/06 21:45:57 (18 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.

Location:

lemon

Files:

• bin_heap.h (modified) (1 diff)
• maps.h (modified) (8 diffs)

lemon/bin_heap.h

@@ -55 +55 @@
   public:
     typedef Item                             ItemType;
-    // FIXME: stl-ben nem ezt hivjak value_type -nak, hanem a kovetkezot...
     typedef Prio                             PrioType;
     typedef std::pair<ItemType,PrioType>     PairType;

lemon/maps.h

@@ -1019 +1019 @@
   
   ///This bool \ref concept::ReadWriteMap "read-write map" returns the 
-  ///logical negation of value returned by the given map. It is setted
-  ///then the negation of the value be setted to the original map.
+  ///logical negation of value returned by the given map. When it is set,
+  ///the opposite value is set to the original map.
   ///Its \c Key and will be inherited from \c M,
   ///its Value is <tt>bool</tt>.
@@ -1065 +1065 @@
   /// \brief Writable bool map for store each true assigned elements.
   ///
-  /// Writable bool map for store each true assigned elements. It will
-  /// copies all the true setted keys to the given iterator.
+  /// Writable bool map to store each true assigned elements. It will
+  /// copies all the keys set to true to the given iterator.
   ///
   /// \note The container of the iterator should contain space 
@@ -1101 +1101 @@
       : _begin(it), _end(it), _functor(functor) {}
 
-    /// Gives back the given first setted iterator.
+    /// Gives back the given iterator set for the first time.
     Iterator begin() const {
       return _begin;
     }
  
-    /// Gives back the iterator after the last setted.
+    /// Gives back the iterator after the last set operation.
     Iterator end() const {
       return _end;
@@ -1127 +1127 @@
   ///
   /// Writable bool map for store each true assigned elements in a back 
-  /// insertable container. It will push back all the true setted keys into
+  /// insertable container. It will push back all the keys set to true into
   /// the container. It can be used to retrieve the items into a standard
   /// container. The next example shows how can you store the undirected
@@ -1166 +1166 @@
   ///
   /// Writable bool map for store each true assigned elements in a front 
-  /// insertable container. It will push front all the true setted keys into
+  /// insertable container. It will push front all the keys set to \c true into
   /// the container. For example see the BackInserterBoolMap.
   template <typename Container,
@@ -1197 +1197 @@
   ///
   /// Writable bool map for store each true assigned elements in an 
-  /// insertable container. It will insert all the true setted keys into
+  /// insertable container. It will insert all the keys set to \c true into
   /// the container. If you want to store the cut edges of the strongly
   /// connected components in a set you can use the next code:
@@ -1237 +1237 @@
   };
 
-  /// \brief Fill the true setted elements with a given value.
-  ///
-  /// Writable bool map for fill the true setted elements with a given value.
-  /// The value can be setted 
+  /// \brief Fill the true set elements with a given value.
+  ///
+  /// Writable bool map to fill the elements set to \c true with a given value.
+  /// The value can set 
   /// the container.
   ///
@@ -1363 +1363 @@
       : map(_map), counter(0) {}
 
-    /// Number of setted keys.
+    /// Number of set operations.
     int num() const {
       return counter;