Dijkstra

Declared in lemon/dijkstra.h, in the group Shortest Path Algorithms; the same class on the Doxygen site.

template< typename GR , typename LEN , typename TR >
class Dijkstra

Dijkstra algorithm class.

This class provides an efficient implementation of the Dijkstra algorithm.

The Dijkstra algorithm solves the single-source shortest path problem when all arc lengths are non-negative. If there are negative lengths, the BellmanFord algorithm should be used instead.

The arc lengths are passed to the algorithm using a ReadMap, so it is easy to change it to any kind of length. The type of the length is determined by the Value of the length map. It is also possible to change the underlying priority heap.

There is also a function-type interface for the Dijkstra algorithm, which is convenient in the simplier cases and it can be used easier.

Template Parameters:
  • GR – The type of the digraph the algorithm runs on. The default type is ListDigraph.

  • LEN – A readable arc map that specifies the lengths of the arcs. It is read once for each arc, so the map may involve in relatively time consuming process to compute the arc lengths if it is necessary. The default map type is GR::ArcMap< int >.

  • TR – The traits class that defines various types used by the algorithm. By default, it is DijkstraDefaultTraits< GR , LEN >. In most cases, this parameter should not be set directly, consider to use the named template parameters instead.

Execution Control

The simplest way to execute the Dijkstra algorithm is to use one of the member functions called run()

.

If you need better control on the execution, you have to call

inline void init()

Initializes the internal data structures.

init() first, then you can add several source nodes with addSource(). Finally the actual path computation can be performed with one of the start() functions.

Initializes the internal data structures.

inline void addSource( Node s , Value dst = OperationTraits::zero() )

Adds a new source node.

Adds a new source node to the priority heap. The optional second parameter is the initial distance of the node.

The function checks if the node has already been added to the heap: it is pushed to the heap if it has never been there, its distance is decreased to dst if it is in the heap with a larger one, and a node already processed is left as it is.

inline Node processNextNode()

Processes the next node in the priority heap.

Warning

The priority heap must not be empty.

Returns:

The processed node.

inline Node nextNode() const

The next node to be processed.

Returns the next node to be processed or INVALID if the priority heap is empty.

inline bool emptyQueue() const

Returns false if there are nodes to be processed.

Returns false if there are nodes to be processed in the priority heap.

inline int queueSize() const

Returns the number of the nodes to be processed.

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

inline void start()

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).

Note

d.start() is just a shortcut of the following code.

while( ! d.emptyQueue() ) {
 d.processNextNode();
 }

Pre:

init() must be called and at least one root node should be added with addSource() before using this function.

inline void start( Node t )

Executes the algorithm until the given target node is processed.

This method runs the Dijkstra algorithm from the root node(s) in order to compute the shortest path to t.

The algorithm computes

  • the shortest path to t,

  • the distance of t from the root(s).

Pre:

init() must be called and at least one root node should be added with addSource() before using this function.

template< class NodeBoolMap >
inline Node start( const NodeBoolMap & nm )

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 v with nm[v] true, if such a node can be found.

Parameters:

nm – A bool (or convertible) node map. The algorithm will stop when it reaches a node v with nm[v] true.

Returns:

The reached node v with nm[v] true or 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.

inline void run( Node s )

Runs the algorithm from the given source node.

This method runs the Dijkstra algorithm from node 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

d.run(s) is just a shortcut of the following code.

d.init();
d.addSource( s );
d.start();

inline bool run( Node s , Node t )

Finds the shortest path between s and t.

This method runs the Dijkstra algorithm from node s in order to compute the shortest path to node t (it stops searching when t is processed).

Note

Apart from the return value, d.run(s,t) is just a shortcut of the following code.

d.init();
d.addSource( s );
d.start( t );

Returns:

true if t is reachable form s.

Query Functions

The results of the Dijkstra algorithm can be obtained using these functions.

Either

run() or init() should be called before using them.

inline Path path( Node t ) const

The shortest path to the given node.

Returns the shortest path to the given node from the root(s).

Warning

t should be reached from the root(s).

Pre:

Either run() or init() must be called before using this function.

inline Value dist( Node v ) const

The distance of the given node from the root(s).

Returns the distance of the given node from the root(s).

Warning

If node v is not reached from the root(s), then the return value of this function is undefined.

Pre:

Either run() or init() must be called before using this function.

inline Arc predArc( Node v ) const

Returns the ‘previous arc’ of the shortest path tree for the given node.

This function returns the ‘previous arc’ of the shortest path tree for the node v, i.e. it returns the last arc of a shortest path from a root to v. It is INVALID if v is not reached from the root(s) or if v is a root.

The shortest path tree used here is equal to the shortest path tree used in predNode() and predMap().

Pre:

Either run() or init() must be called before using this function.

inline Node predNode( Node v ) const

Returns the ‘previous node’ of the shortest path tree for the given node.

This function returns the ‘previous node’ of the shortest path tree for the node v, i.e. it returns the last but one node of a shortest path from a root to v. It is INVALID if v is not reached from the root(s) or if v is a root.

The shortest path tree used here is equal to the shortest path tree used in predArc() and predMap().

Pre:

Either run() or init() must be called before using this function.

inline const DistMap & distMap() const

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 run() or init() must be called before using this function.

inline const PredMap & predMap() const

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 (forest).

Pre:

Either run() or init() must be called before using this function.

inline bool reached( Node v ) const

Checks if the given node is reached from the root(s).

Returns true if v is reached from the root(s).

Pre:

Either run() or init() must be called before using this function.

inline bool processed( Node v ) const

Checks if a node is processed.

Returns true if v is processed, i.e. the shortest path to v has already found.

Pre:

Either run() or init() must be called before using this function.

inline Value currentDist( Node v ) const

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

Returns the current distance of the given node from the root(s). It may be decreased in the following processes.

Pre:

Either run() or init() must be called before using this function and node v must be reached but not necessarily processed.

Public Types

typedef TR::Digraph Digraph

The type of the digraph the algorithm runs on.

typedef TR::Value Value

The type of the arc lengths.

typedef TR::LengthMap LengthMap

The type of the map that stores the arc lengths.

typedef TR::PredMap PredMap

The type of the map that stores the predecessor arcs of the shortest paths.

typedef TR::DistMap DistMap

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

typedef TR::ProcessedMap ProcessedMap

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

typedef PredMapPath< Digraph , PredMap > Path

The type of the paths.

typedef TR::HeapCrossRef HeapCrossRef

The cross reference type used for the current heap.

typedef TR::Heap Heap

The heap type used by the algorithm.

typedef TR::OperationTraits OperationTraits

The operation traits class of the algorithm.

typedef TR Traits

The traits class of the algorithm.

typedef Dijkstra Create

Public Functions

inline Dijkstra( const Digraph & g , const LengthMap & length )

Constructor.

Parameters:
  • g – The digraph the algorithm runs on.

  • length – The length map used by the algorithm.

inline ~Dijkstra()

Destructor.

inline Dijkstra & lengthMap( const LengthMap & m )

Sets the length map.

Returns:

(*this)

inline Dijkstra & operationTraits( const OperationTraits & ops )

Sets the object of the operation traits class.

The operations on the distances are those of an object of the operation traits class [see SetOperationTraits], default constructed unless one is given here, which lets them depend on the instance, e.g., on a tolerance of its own.

Returns:

(*this)

inline const OperationTraits & operationTraits() const

The object of the operation traits class in use.

inline Dijkstra & predMap( PredMap & m )

Sets the map that stores the predecessor arcs. If you don’t use this function before calling run() or init(), an instance will be allocated automatically. The destructor deallocates this automatically allocated map, of course.

Returns:

(*this)

inline Dijkstra & processedMap( ProcessedMap & m )

Sets the map that indicates which nodes are processed. If you don’t use this function before calling run() or init(), an instance will be allocated automatically. The destructor deallocates this automatically allocated map, of course.

Returns:

(*this)

inline Dijkstra & distMap( DistMap & m )

Sets the map that stores the distances of the nodes.

Sets the map that stores the distances of the nodes calculated by the algorithm. If you don’t use this function before calling run() or init(), an instance will be allocated automatically. The destructor deallocates this automatically allocated map, of course.

Returns:

(*this)

inline Dijkstra & heap( Heap & hp , HeapCrossRef & cr )

Sets the heap and the cross reference used by algorithm. If you don’t use this function before calling run() or init(), heap and cross reference instances will be allocated automatically. The destructor deallocates these automatically allocated objects, of course.

Returns:

(*this)

Protected Functions

inline Dijkstra()
template< class T >
struct SetPredMapTraits : public Traits

Public Types

typedef T PredMap

Public Static Functions

static inline PredMap * createPredMap( const Digraph & )
template< class T >
struct SetPredMap : public Dijkstra< Digraph , LengthMap , SetPredMapTraits< T > >

Named parameter for setting

PredMap type. Named parameter for setting PredMap type. It must conform to the WriteMap concept.

Public Types

typedef Dijkstra< Digraph , LengthMap , SetPredMapTraits< T > > Create
template< class T >
struct SetDistMapTraits : public Traits

Public Types

typedef T DistMap

Public Static Functions

static inline DistMap * createDistMap( const Digraph & )
template< class T >
struct SetDistMap : public Dijkstra< Digraph , LengthMap , SetDistMapTraits< T > >

Named parameter for setting

DistMap type. Named parameter for setting DistMap type. It must conform to the WriteMap concept.

Public Types

typedef Dijkstra< Digraph , LengthMap , SetDistMapTraits< T > > Create
template< class T >
struct SetProcessedMapTraits : public Traits

Public Types

typedef T ProcessedMap

Public Static Functions

static inline ProcessedMap * createProcessedMap( const Digraph & )
template< class T >
struct SetProcessedMap : public Dijkstra< Digraph , LengthMap , SetProcessedMapTraits< T > >

Named parameter for setting

ProcessedMap type. Named parameter for setting ProcessedMap type. It must conform to the WriteMap concept.

Public Types

typedef Dijkstra< Digraph , LengthMap , SetProcessedMapTraits< T > > Create
struct SetStandardProcessedMapTraits : public Traits

Public Types

typedef Digraph::template NodeMap< bool > ProcessedMap

Public Static Functions

static inline ProcessedMap * createProcessedMap( const Digraph & g )
struct SetStandardProcessedMap : public Dijkstra< Digraph , LengthMap , SetStandardProcessedMapTraits >

Named parameter for setting

ProcessedMap type to be Digraph::NodeMap< bool >. Named parameter for setting ProcessedMap type to be Digraph::NodeMap< bool >. If you don’t set it explicitly, it will be automatically allocated.

Public Types

typedef Dijkstra< Digraph , LengthMap , SetStandardProcessedMapTraits > Create
template< class H , class CR >
struct SetHeapTraits : public Traits

Public Types

typedef CR HeapCrossRef
typedef H Heap

Public Static Functions

static inline HeapCrossRef * createHeapCrossRef( const Digraph & )
static inline Heap * createHeap(HeapCrossRef&)
template< class H , class CR = typename Digraph::template NodeMap< int > >
struct SetHeap : public Dijkstra< Digraph , LengthMap , SetHeapTraits< H , typename Digraph::template NodeMap< int > > >

Named parameter for setting heap and cross reference types. If this named parameter is used, then external heap and cross reference objects must be passed to the algorithm using the heap() function before calling run() or init().

See also

SetStandardHeap

Public Types

typedef Dijkstra< Digraph , LengthMap , SetHeapTraits< H , CR > > Create
template< class H , class CR >
struct SetStandardHeapTraits : public Traits

Public Types

typedef CR HeapCrossRef
typedef H Heap

Public Static Functions

static inline HeapCrossRef * createHeapCrossRef( const Digraph & G )
static inline Heap * createHeap( HeapCrossRef & R )
template< class H , class CR = typename Digraph::template NodeMap< int > >
struct SetStandardHeap : public Dijkstra< Digraph , LengthMap , SetStandardHeapTraits< H , typename Digraph::template NodeMap< int > > >

Named parameter for setting heap and cross reference types with automatic allocation. They should have standard constructor interfaces to be able to automatically created by the algorithm (i.e. the digraph should be passed to the constructor of the cross reference and the cross reference should be passed to the constructor of the heap). However, external heap and cross reference objects could also be passed to the algorithm using the heap() function before calling run() or init().

See also

SetHeap

Public Types

typedef Dijkstra< Digraph , LengthMap , SetStandardHeapTraits< H , CR > > Create
template< class T >
struct SetOperationTraitsTraits : public Traits

Public Types

typedef T OperationTraits
template< class T >
struct SetOperationTraits : public Dijkstra< Digraph , LengthMap , SetOperationTraitsTraits< T > >

Named parameter for setting

OperationTraits type Named parameter for setting OperationTraits type. For more information, see DijkstraDefaultOperationTraits.

Public Types

typedef Dijkstra< Digraph , LengthMap , SetOperationTraitsTraits< T > > Create