COIN-OR::LEMON - Graph Library

Changeset 229:ae5f9ca94be7 in lemon-0.x


Ignore:
Timestamp:
03/22/04 11:21:30 (16 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@326
Message:

DocFix?

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/work/alpar/dijkstra/dijkstra.h

    r228 r229  
    3535  //Alpar: Changed the order of the parameters
    3636 
    37   ///Dijkstra algorithm class.
    38 
    39   ///This class provides an efficient implementation of Dijkstra algorithm.
     37  ///%Dijkstra algorithm class.
     38
     39  ///This class provides an efficient implementation of %Dijkstra algorithm.
    4040  ///The edge lengths are passed to the algorithm using a
    4141  ///\ref ReadMapSkeleton "readable map",
     
    5151  ///may involve in relatively time consuming process to compute the edge
    5252  ///length if it is necessary.
    53   ///\param Heap The heap type used by the Dijkstra
     53  ///\param Heap The heap type used by the %Dijkstra
    5454  ///algorithm. The default
    5555  ///is using \ref BinHeap "binary heap".
     
    9898    ///Returns the distance of a node from the source.
    9999    ///\pre \ref run() must be called before using this function.
    100     ///\warning If node \c v in unreachable from \c s the return value
     100    ///\warning If node \c v in unreachable from the source the return value
    101101    ///of this funcion is undefined.
    102102    ValueType dist(Node v) const { return distance[v]; }
     
    104104
    105105    ///For a node \c v it returns the last edge of the shortest path
    106     ///from \c s to \c v or INVALID if \c v is unreachable from \c s.
     106    ///from the source to \c v or INVALID if \c v is unreachable
     107    ///from the source.
    107108    ///\pre \ref run() must be called before using this function.
    108109    Edge pred(Node v) const { return predecessor[v]; }
     
    110111
    111112    ///For a node \c v it returns the last but one node of the shortest path
    112     ///from \c s to \c v or INVALID if \c v is unreachable from \c s.
     113    ///from the source to \c v or INVALID if \c v is unreachable
     114    ///from the source.
    113115    ///\pre \ref run() must be called before using this function.
    114116    Node predNode(Node v) const { return pred_node[v]; }
     
    134136    //    bool reached(Node v) { return reach[v]; }
    135137
    136     ///Chech if a node is reachable from \c s.
    137 
    138     ///Returns \c true if \c v is reachable from \c s.
    139     ///\warning \c s is reported to be unreached!
     138    ///Chechs if a node is reachable from the source.
     139
     140    ///Returns \c true if \c v is reachable from the source.
     141    ///\warning the source node is reported to be unreached!
    140142    ///\todo Is this what we want?
    141143    ///\pre \ref run() must be called before using this function.
     
    150152  // **********************************************************************
    151153
    152   ///Runs Dijkstra algorithm from node \c s.
    153 
    154   ///This method runs the Dijkstra algorithm from node \c s in order to
     154  ///Runs %Dijkstra algorithm from node the source.
     155
     156  ///This method runs the %Dijkstra algorithm from a source node \c s
     157  ///in order to
    155158  ///compute the
    156159  ///shortest path to each node. The algorithm computes
    157160  ///- The shortest path tree.
    158   ///- The distance of each node.
     161  ///- The distance of each node from the source.
    159162  template <typename Graph, typename LengthMap, typename Heap >
    160163  void Dijkstra<Graph,LengthMap,Heap>::run(Node s) {
Note: See TracChangeset for help on using the changeset viewer.