COIN-OR::LEMON - Graph Library

Changeset 380:d916b8995e22 in lemon-1.2 for lemon


Ignore:
Timestamp:
11/17/08 16:41:15 (11 years ago)
Author:
Alpar Juttner <alpar@…>
Branch:
default
Phase:
public
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/elevator.h

    r379 r380  
    381381    }
    382382
    383     ///Mark the node as it did not reach the max level
    384 
    385     ///Mark the node as it did not reach the max level. It sets the
    386     ///level to the under the max level value. The node will be never
    387     ///more activated because the push operation from the maximum
    388     ///level is forbidden in the push-relabel algorithms. The node
    389     ///should be lifted previously to the top level.
    390     void markToBottom(Item i) {
     383    ///Move an inactive item to the top but one level (in a dirty way).
     384
     385    ///This function moves an inactive item to the top but one level.
     386    ///It makes the underlying datastructure corrupt, so use is only if
     387    ///you really know what it is for.
     388    ///\pre The item is on the top level.
     389    void dirtyTopButOne(Item i) {
    391390      _level[i] = _max_level - 1;
    392391    }
    393392
    394     ///Lift all nodes on and above a level to the top (and deactivate them).
    395 
    396     ///This function lifts all nodes on and above level \c l to \c
     393    ///Lift all items on and above a level to the top (and deactivate them).
     394
     395    ///This function lifts all items on and above level \c l to \c
    397396    ///maxLevel(), and also deactivates them.
    398397    void liftToTop(int l)
     
    750749
    751750    ///Lift the item returned by highestActive() to the top level and
    752     ///deactivates the node.
     751    ///deactivates the item.
    753752    ///
    754753    void liftHighestActiveToTop() {
     
    898897    }
    899898
    900     ///Mark the node as it did not reach the max level
    901 
    902     ///Mark the node as it did not reach the max level. It sets the
    903     ///level to the under the max level value. The node will be never
    904     ///more activated because the push operation from the maximum
    905     ///level is forbidden in the push-relabel algorithms. The node
    906     ///should be lifted previously to the top level.
    907     void markToBottom(Item i) {
     899    ///Move an inactive item to the top but one level (in a dirty way).
     900
     901    ///This function moves an inactive item to the top but one level.
     902    ///It makes the underlying datastructure corrupt, so use is only if
     903    ///you really know what it is for.
     904    ///\pre The item is on the top level.
     905    void dirtyTopButOne(Item i) {
    908906      _level.set(i, _max_level - 1);
    909907    }
    910908
    911     ///Lift all nodes on and above a level to the top (and deactivate them).
    912 
    913     ///This function lifts all nodes on and above level \c l to \c
     909    ///Lift all items on and above a level to the top (and deactivate them).
     910
     911    ///This function lifts all items on and above level \c l to \c
    914912    ///maxLevel(), and also deactivates them.
    915913    void liftToTop(int l)  {
Note: See TracChangeset for help on using the changeset viewer.