COIN-OR::LEMON - Graph Library

Ignore:
Timestamp:
03/24/04 14:06:06 (16 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@341
Message:

DocFixes?

File:
1 edited

Legend:

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

    r229 r242  
    11// -*- C++ -*-
     2
    23/*
    34 *template <Graph, T, Heap=FibHeap, LengthMap=Graph::EdgeMap<T> >
     
    2627#ifndef HUGO_DIJKSTRA_H
    2728#define HUGO_DIJKSTRA_H
     29
     30///\file
     31///\brief Dijkstra algorithm.
    2832
    2933#include <fib_heap.h>
     
    4448  ///The type of the length is determined by the \c ValueType of the length map.
    4549  ///
    46   ///It is also posible to change the underlying priority heap.
     50  ///It is also possible to change the underlying priority heap.
    4751  ///
    4852  ///\param Graph The graph type the algorithm runs on.
    49   ///\param LengthMap This read-only EdgeMap determines the
     53  ///\param LengthMap This read-only
     54  ///EdgeMap
     55  ///determines the
    5056  ///lengths of the edges. It is read once for each edge, so the map
    5157  ///may involve in relatively time consuming process to compute the edge
    52   ///length if it is necessary.
     58  ///length if it is necessary. The default map type is
     59  ///\ref GraphSkeleton::EdgeMap "Graph::EdgeMap<int>"
    5360  ///\param Heap The heap type used by the %Dijkstra
    5461  ///algorithm. The default
    5562  ///is using \ref BinHeap "binary heap".
     63 
     64#ifdef DOXYGEN
     65  template <typename Graph,
     66            typename LengthMap,
     67            typename Heap>
     68#else
    5669  template <typename Graph,
    5770            typename LengthMap=typename Graph::EdgeMap<int>,
     
    5972                                   typename LengthMap::ValueType,
    6073                                   typename Graph::NodeMap<int> > >
     74#endif
    6175  class Dijkstra{
    6276  public:
     
    136150    //    bool reached(Node v) { return reach[v]; }
    137151
    138     ///Chechs if a node is reachable from the source.
     152    ///Checks if a node is reachable from the source.
    139153
    140154    ///Returns \c true if \c v is reachable from the source.
Note: See TracChangeset for help on using the changeset viewer.