Changeset 380:d916b8995e22 in lemon-1.2

Timestamp:

11/17/08 16:41:15 (16 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Rename markToBottom() to dirtyTopButOne() + better doc (#174)

File:

• lemon/elevator.h (modified) (3 diffs)

lemon/elevator.h

@@ -381 +381 @@
     }
 
-    ///Mark the node as it did not reach the max level
-
-    ///Mark the node as it did not reach the max level. It sets the
-    ///level to the under the max level value. The node will be never
-    ///more activated because the push operation from the maximum
-    ///level is forbidden in the push-relabel algorithms. The node
-    ///should be lifted previously to the top level.
-    void markToBottom(Item i) {
+    ///Move an inactive item to the top but one level (in a dirty way).
+
+    ///This function moves an inactive item to the top but one level.
+    ///It makes the underlying datastructure corrupt, so use is only if
+    ///you really know what it is for.
+    ///\pre The item is on the top level.
+    void dirtyTopButOne(Item i) {
       _level[i] = _max_level - 1;
     }
 
-    ///Lift all nodes on and above a level to the top (and deactivate them).
-
-    ///This function lifts all nodes on and above level \c l to \c
+    ///Lift all items on and above a level to the top (and deactivate them).
+
+    ///This function lifts all items on and above level \c l to \c
     ///maxLevel(), and also deactivates them.
     void liftToTop(int l)
@@ -750 +749 @@
 
     ///Lift the item returned by highestActive() to the top level and
-    ///deactivates the node.
+    ///deactivates the item.
     ///
     void liftHighestActiveToTop() {
@@ -898 +897 @@
     }
 
-    ///Mark the node as it did not reach the max level
-
-    ///Mark the node as it did not reach the max level. It sets the
-    ///level to the under the max level value. The node will be never
-    ///more activated because the push operation from the maximum
-    ///level is forbidden in the push-relabel algorithms. The node
-    ///should be lifted previously to the top level.
-    void markToBottom(Item i) {
+    ///Move an inactive item to the top but one level (in a dirty way).
+
+    ///This function moves an inactive item to the top but one level.
+    ///It makes the underlying datastructure corrupt, so use is only if
+    ///you really know what it is for.
+    ///\pre The item is on the top level.
+    void dirtyTopButOne(Item i) {
       _level.set(i, _max_level - 1);
     }
 
-    ///Lift all nodes on and above a level to the top (and deactivate them).
-
-    ///This function lifts all nodes on and above level \c l to \c
+    ///Lift all items on and above a level to the top (and deactivate them).
+
+    ///This function lifts all items on and above level \c l to \c
     ///maxLevel(), and also deactivates them.
     void liftToTop(int l)  {