RhodeCode

    ///priority heap is empty.

    Node nextNode() const

    {

      return !_heap->empty()?_heap->top():INVALID;

    }

    ///\brief Returns \c false if there are nodes

    ///to be processed.

    ///

    ///Returns \c false if there are nodes

    ///to be processed in the priority heap.

    bool emptyQueue() const { return _heap->empty(); }

    ///Returns the number of the nodes to be processed in the priority heap

    ///Returns the number of the nodes to be processed in the priority heap.

    ///

    int queueSize() const { return _heap->size(); }

    ///Executes the algorithm.

    ///Executes the algorithm.

    ///

    ///This method runs the %Dijkstra algorithm from the root node(s)

    ///in order to compute the shortest path to each node.

    ///

    ///The algorithm computes

    ///- the shortest path tree (forest),

    ///- the distance of each node from the root(s).

    ///

    ///\pre init() must be called and at least one root node should be

    ///added with addSource() before using this function.

    ///

    ///\note <tt>d.start()</tt> is just a shortcut of the following code.

    ///\code

    ///  while ( !d.emptyQueue() ) {

    ///    d.processNextNode();

    ///  }

    ///\endcode

    void start()

    {

      while ( !emptyQueue() ) processNextNode();

    }

    ///Executes the algorithm until the given target node is reached.

    ///Executes the algorithm until the given target node is reached.

    ///

    ///This method runs the %Dijkstra algorithm from the root node(s)

    ///in order to compute the shortest path to \c dest.

    ///

    ///The algorithm computes

    ///- the shortest path to \c dest,

    ///- the distance of \c dest from the root(s).

    ///

    ///\pre init() must be called and at least one root node should be

    ///added with addSource() before using this function.

    void start(Node dest)

    {

      while ( !_heap->empty() && _heap->top()!=dest ) processNextNode();

      if ( !_heap->empty() ) finalizeNodeData(_heap->top(),_heap->prio());

    }

    ///Executes the algorithm until a condition is met.

    ///Executes the algorithm until a condition is met.

    ///

    ///This method runs the %Dijkstra algorithm from the root node(s) in

    ///order to compute the shortest path to a node \c v with

    /// <tt>nm[v]</tt> true, if such a node can be found.

    ///

    ///\param nm A \c bool (or convertible) node map. The algorithm

    ///will stop when it reaches a node \c v with <tt>nm[v]</tt> true.

    ///

    ///\return The reached node \c v with <tt>nm[v]</tt> true or

    ///\c INVALID if no such node was found.

    ///

    ///\pre init() must be called and at least one root node should be

    ///added with addSource() before using this function.

    template<class NodeBoolMap>

    Node start(const NodeBoolMap &nm)

    {

      while ( !_heap->empty() && !nm[_heap->top()] ) processNextNode();

      if ( _heap->empty() ) return INVALID;

      finalizeNodeData(_heap->top(),_heap->prio());

      return _heap->top();

    }

    ///Runs the algorithm from the given node.

    ///This method runs the %Dijkstra algorithm from node \c s

    ///in order to compute the shortest path to each node.

    ///

    ///The algorithm computes

    ///- the shortest path tree,

    ///- the distance of each node from the root.

    ///

    ///\note <tt>d.run(s)</tt> is just a shortcut of the following code.

    ///\code

    ///  d.init();

    ///  d.addSource(s);

    ///  d.start();

    ///\endcode

    void run(Node s) {

      init();

      addSource(s);

      start();

    }

    ///Finds the shortest path between \c s and \c t.

    ///This method runs the %Dijkstra algorithm from node \c s

    ///in order to compute the shortest path to \c t.

    ///

    ///\return The length of the shortest <tt>s</tt>--<tt>t</tt> path,

    ///if \c t is reachable form \c s, \c 0 otherwise.

    ///

    ///\note Apart from the return value, <tt>d.run(s,t)</tt> is just a

    ///shortcut of the following code.

    ///\code

    ///  d.init();

    ///  d.addSource(s);

    ///  d.start(t);

    ///\endcode

    Value run(Node s,Node t) {

      init();

      addSource(s);

      start(t);

      return (*_pred)[t]==INVALID?OperationTraits::zero():(*_dist)[t];

    }

    ///@}

    ///\name Query Functions

    ///The result of the %Dijkstra algorithm can be obtained using these

    ///functions.\n

    ///Either \ref lemon::Dijkstra::run() "run()" or

    ///\ref lemon::Dijkstra::start() "start()" must be called before

    ///using them.

    ///@{

    ///The shortest path to a node.

    ///Returns the shortest path to a node.

    ///

    ///\warning \c t should be reachable from the root(s).

    ///

    ///\pre Either \ref run() or \ref start() must be called before

    ///using this function.

    Path path(Node t) const { return Path(*G, *_pred, t); }

    ///The distance of a node from the root(s).

    ///Returns the distance of a node from the root(s).

    ///

    ///\warning If node \c v is not reachable from the root(s), then

    ///the return value of this function is undefined.

    ///

    ///\pre Either \ref run() or \ref start() must be called before

    ///using this function.

    Value dist(Node v) const { return (*_dist)[v]; }

    ///Returns the 'previous arc' of the shortest path tree for a node.

    ///This function returns the 'previous arc' of the shortest path

    ///tree for the node \c v, i.e. it returns the last arc of a

    ///shortest path from the root(s) to \c v. It is \c INVALID if \c v

    ///is not reachable from the root(s) or if \c v is a root.

    ///

    ///The shortest path tree used here is equal to the shortest path

    ///tree used in \ref predNode().

    ///

    ///\pre Either \ref run() or \ref start() must be called before

    ///using this function.

    Arc predArc(Node v) const { return (*_pred)[v]; }

    ///Returns the 'previous node' of the shortest path tree for a node.

    ///This function returns the 'previous node' of the shortest path

    ///tree for the node \c v, i.e. it returns the last but one node

    ///from a shortest path from the root(s) to \c v. It is \c INVALID

    ///if \c v is not reachable from the root(s) or if \c v is a root.

    ///

    ///The shortest path tree used here is equal to the shortest path

    ///tree used in \ref predArc().

    ///

    ///\pre Either \ref run() or \ref start() must be called before

    ///using this function.

    Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:

                                  G->source((*_pred)[v]); }

    ///\brief Returns a const reference to the node map that stores the

    ///distances of the nodes.

    ///

    ///Returns a const reference to the node map that stores the distances

    ///of the nodes calculated by the algorithm.

    ///

    ///\pre Either \ref run() or \ref init()

    ///must be called before using this function.

    const DistMap &distMap() const { return *_dist;}

    ///\brief Returns a const reference to the node map that stores the

    ///predecessor arcs.

    ///

    ///Returns a const reference to the node map that stores the predecessor

    ///arcs, which form the shortest path tree.

    ///

    ///\pre Either \ref run() or \ref init()

    ///must be called before using this function.

    const PredMap &predMap() const { return *_pred;}

    ///Checks if a node is reachable from the root(s).

    ///Returns \c true if \c v is reachable from the root(s).

    ///\pre Either \ref run() or \ref start()

    ///must be called before using this function.

    bool reached(Node v) const { return (*_heap_cross_ref)[v] !=

                                        Heap::PRE_HEAP; }

    ///Checks if a node is processed.

    ///Returns \c true if \c v is processed, i.e. the shortest

    ///path to \c v has already found.

    ///\pre Either \ref run() or \ref start()

    ///must be called before using this function.

    bool processed(Node v) const { return (*_heap_cross_ref)[v] ==

                                          Heap::POST_HEAP; }

    ///The current distance of a node from the root(s).

    ///Returns the current distance of a node from the root(s).

    ///It may be decreased in the following processes.

    ///\pre \c v should be reached but not processed.

    Value currentDist(Node v) const { return (*_heap)[v]; }

    ///@}

  };

  ///Default traits class of dijkstra() function.

  ///Default traits class of dijkstra() function.

  ///\tparam GR The type of the digraph.

  ///\tparam LM The type of the length map.

  template<class GR, class LM>

  struct DijkstraWizardDefaultTraits

  {

    ///The type of the digraph the algorithm runs on.

    typedef GR Digraph;

    ///The type of the map that stores the arc lengths.

    ///The type of the map that stores the arc lengths.

    ///It must meet the \ref concepts::ReadMap "ReadMap" concept.

    typedef LM LengthMap;

    ///The type of the length of the arcs.

    typedef typename LM::Value Value;

    /// Operation traits for Dijkstra algorithm.

    /// This class defines the operations that are used in the algorithm.

    /// \see DijkstraDefaultOperationTraits

    typedef DijkstraDefaultOperationTraits<Value> OperationTraits;

    /// The cross reference type used by the heap.

    /// The cross reference type used by the heap.

    /// Usually it is \c Digraph::NodeMap<int>.

    typedef typename Digraph::template NodeMap<int> HeapCrossRef;

    ///Instantiates a \ref HeapCrossRef.

    ///This function instantiates a \ref HeapCrossRef.

    /// \param g is the digraph, to which we would like to define the

    /// HeapCrossRef.

    /// \todo The digraph alone may be insufficient for the initialization

    static HeapCrossRef *createHeapCrossRef(const Digraph &g)

    {

      return new HeapCrossRef(g);

    }

    ///The heap type used by the Dijkstra algorithm.

    ///The heap type used by the Dijkstra algorithm.

    ///

    ///\sa BinHeap

    ///\sa Dijkstra

    typedef BinHeap<Value, typename Digraph::template NodeMap<int>,

                    std::less<Value> > Heap;

    ///Instantiates a \ref Heap.

    ///This function instantiates a \ref Heap.

    /// \param r is the HeapCrossRef which is used.

    static Heap *createHeap(HeapCrossRef& r)

    {

      return new Heap(r);

    }

    ///\brief The type of the map that stores the predecessor

    ///arcs of the shortest paths.

    ///

    ///The type of the map that stores the predecessor

    ///arcs of the shortest paths.

    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.

    typedef NullMap <typename Digraph::Node,typename Digraph::Arc> PredMap;

    ///Instantiates a \ref PredMap.

    ///This function instantiates a \ref PredMap.

    ///\param g is the digraph, to which we would like to define the

    ///\ref PredMap.

    ///\todo The digraph alone may be insufficient to initialize

#ifdef DOXYGEN

    static PredMap *createPredMap(const Digraph &g)

#else

    static PredMap *createPredMap(const Digraph &)

#endif

    {

      return new PredMap();

    }

    ///The type of the map that indicates which nodes are processed.

    ///The type of the map that indicates which nodes are processed.

    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.

    ///By default it is a NullMap.

    ///\todo If it is set to a real map,

    ///Dijkstra::processed() should read this.

    ///\todo named parameter to set this type, function to read and write.

    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;

    ///Instantiates a \ref ProcessedMap.

    ///This function instantiates a \ref ProcessedMap.

    ///\param g is the digraph, to which

    ///we would like to define the \ref ProcessedMap.

#ifdef DOXYGEN

    static ProcessedMap *createProcessedMap(const Digraph &g)

#else

    static ProcessedMap *createProcessedMap(const Digraph &)

#endif

    {

      return new ProcessedMap();

    }

    ///The type of the map that stores the distances of the nodes.

    ///The type of the map that stores the distances of the nodes.

    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.

    typedef NullMap<typename Digraph::Node,Value> DistMap;

    ///Instantiates a \ref DistMap.

    ///This function instantiates a \ref DistMap.

    ///\param g is the digraph, to which we would like to define

    ///the \ref DistMap

#ifdef DOXYGEN

    static DistMap *createDistMap(const Digraph &g)

#else

    static DistMap *createDistMap(const Digraph &)

#endif

    {

      return new DistMap();

    }

  };

  /// Default traits class used by \ref DijkstraWizard

  /// To make it easier to use Dijkstra algorithm

  /// we have created a wizard class.

  /// This \ref DijkstraWizard class needs default traits,

  /// as well as the \ref Dijkstra class.

  /// The \ref DijkstraWizardBase is a class to be the default traits of the

  /// \ref DijkstraWizard class.

  /// \todo More named parameters are required...

  template<class GR,class LM>

  class DijkstraWizardBase : public DijkstraWizardDefaultTraits<GR,LM>

  {

    typedef DijkstraWizardDefaultTraits<GR,LM> Base;

  protected:

    //The type of the nodes in the digraph.

    typedef typename Base::Digraph::Node Node;

    //Pointer to the digraph the algorithm runs on.

    void *_g;

    //Pointer to the length map

    void *_length;

    //Pointer to the map of predecessors arcs.

    void *_pred;

    //Pointer to the map of distances.

    void *_dist;

    //Pointer to the source node.

    Node _source;

  public:

    /// Constructor.

    /// This constructor does not require parameters, therefore it initiates

    /// all of the attributes to default values (0, INVALID).

                           _dist(0), _source(INVALID) {}

    /// Constructor.

    /// This constructor requires some parameters,

    /// listed in the parameters list.

    /// Others are initiated to 0.

    /// \param g The digraph the algorithm runs on.

    /// \param l The length map.

    /// \param s The source node.

    DijkstraWizardBase(const GR &g,const LM &l, Node s=INVALID) :

      _g(reinterpret_cast<void*>(const_cast<GR*>(&g))),

      _length(reinterpret_cast<void*>(const_cast<LM*>(&l))),

  };

  /// Auxiliary class for the function type interface of Dijkstra algorithm.

  /// This auxiliary class is created to implement the function type

  /// interface of \ref Dijkstra algorithm. It uses the functions and features

  /// of the plain \ref Dijkstra, but it is much simpler to use it.

  /// It should only be used through the \ref dijkstra() function, which makes

  /// it easier to use the algorithm.

  ///

  /// Simplicity means that the way to change the types defined

  /// in the traits class is based on functions that returns the new class

  /// and not on templatable built-in classes.

  /// When using the plain \ref Dijkstra

  /// the new class with the modified type comes from

  /// the original class by using the ::

  /// operator. In the case of \ref DijkstraWizard only

  /// a function have to be called, and it will

  /// return the needed class.

  ///

  /// It does not have own \ref run() method. When its \ref run() method

  /// is called, it initiates a plain \ref Dijkstra object, and calls the

  /// \ref Dijkstra::run() method of it.

  template<class TR>

  class DijkstraWizard : public TR

  {

    typedef TR Base;

    ///The type of the digraph the algorithm runs on.

    typedef typename TR::Digraph Digraph;

    typedef typename Digraph::Node Node;

    typedef typename Digraph::NodeIt NodeIt;

    typedef typename Digraph::Arc Arc;

    typedef typename Digraph::OutArcIt OutArcIt;

    ///The type of the map that stores the arc lengths.

    typedef typename TR::LengthMap LengthMap;

    ///The type of the length of the arcs.

    typedef typename LengthMap::Value Value;

    ///\brief The type of the map that stores the predecessor

    ///arcs of the shortest paths.

    typedef typename TR::PredMap PredMap;

    ///The type of the map that stores the distances of the nodes.

    typedef typename TR::DistMap DistMap;

    ///The type of the map that indicates which nodes are processed.

    typedef typename TR::ProcessedMap ProcessedMap;

    ///The heap type used by the dijkstra algorithm.

    typedef typename TR::Heap Heap;

  public:

    /// Constructor.

    DijkstraWizard() : TR() {}

    /// Constructor that requires parameters.

    /// Constructor that requires parameters.

    /// These parameters will be the default values for the traits class.

    DijkstraWizard(const Digraph &g,const LengthMap &l, Node s=INVALID) :

      TR(g,l,s) {}

    ///Copy constructor

    DijkstraWizard(const TR &b) : TR(b) {}

    ~DijkstraWizard() {}

    ///Runs Dijkstra algorithm from a source node.

    ///Runs Dijkstra algorithm from a source node.

    ///The node can be given with the \ref source() function.

    void run()

    {

      if(Base::_source==INVALID) throw UninitializedParameter();

      Dijkstra<Digraph,LengthMap,TR>

        dij(*reinterpret_cast<const Digraph*>(Base::_g),

            *reinterpret_cast<const LengthMap*>(Base::_length));

      dij.run(Base::_source);

    }

    ///Runs Dijkstra algorithm from the given node.

    ///Runs Dijkstra algorithm from the given node.

    ///\param s is the given source.

    void run(Node s)

    {

      Base::_source=s;

      run();

    }

    /// Sets the source node, from which the Dijkstra algorithm runs.

    /// Sets the source node, from which the Dijkstra algorithm runs.

    /// \param s is the source node.

    DijkstraWizard<TR> &source(Node s)

    {

      Base::_source=s;

      return *this;

    }

    template<class T>

    struct DefPredMapBase : public Base {

      typedef T PredMap;

      static PredMap *createPredMap(const Digraph &) { return 0; };

      DefPredMapBase(const TR &b) : TR(b) {}

    };

    ///\brief \ref named-templ-param "Named parameter"

    ///for setting \ref PredMap object.

    ///

    ///\ref named-templ-param "Named parameter"

    ///for setting \ref PredMap object.

    template<class T>

    DijkstraWizard<DefPredMapBase<T> > predMap(const T &t)

    {

      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));

      return DijkstraWizard<DefPredMapBase<T> >(*this);

    }

    template<class T>

    struct DefProcessedMapBase : public Base {

      typedef T ProcessedMap;

      static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };

      DefProcessedMapBase(const TR &b) : TR(b) {}

    };

    ///\brief \ref named-templ-param "Named parameter"

    ///for setting \ref ProcessedMap object.

    ///

    /// \ref named-templ-param "Named parameter"

    ///for setting \ref ProcessedMap object.

    template<class T>

    DijkstraWizard<DefProcessedMapBase<T> > processedMap(const T &t)

    {

      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));

      return DijkstraWizard<DefProcessedMapBase<T> >(*this);

    }

    template<class T>

    struct DefDistMapBase : public Base {

      typedef T DistMap;

      static DistMap *createDistMap(const Digraph &) { return 0; };

      DefDistMapBase(const TR &b) : TR(b) {}

    };

    ///\brief \ref named-templ-param "Named parameter"

    ///for setting \ref DistMap object.

    ///

    ///\ref named-templ-param "Named parameter"

    ///for setting \ref DistMap object.

    template<class T>

    DijkstraWizard<DefDistMapBase<T> > distMap(const T &t)

    {

      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));

      return DijkstraWizard<DefDistMapBase<T> >(*this);

    }

  };

  ///Function type interface for Dijkstra algorithm.

  /// \ingroup shortest_path

  ///Function type interface for Dijkstra algorithm.

  ///

  ///This function also has several

  ///\ref named-templ-func-param "named parameters",

  ///they are declared as the members of class \ref DijkstraWizard.

  ///The following

  ///example shows how to use these parameters.

  ///\code

  ///  dijkstra(g,length,source).predMap(preds).run();

  ///\endcode

  ///\warning Don't forget to put the \ref DijkstraWizard::run() "run()"

  ///to the end of the parameter list.

  ///\sa DijkstraWizard

  ///\sa Dijkstra

  template<class GR, class LM>

  DijkstraWizard<DijkstraWizardBase<GR,LM> >

  dijkstra(const GR &g,const LM &l,typename GR::Node s=INVALID)

  {

    return DijkstraWizard<DijkstraWizardBase<GR,LM> >(g,l,s);

  }

} //END OF NAMESPACE LEMON

#endif