edu.uci.ics.jung.algorithms.shortestpath

Class DijkstraDistance<V,E>

java.lang.Object

edu.uci.ics.jung.algorithms.shortestpath.DijkstraDistance<V,E>

All Implemented Interfaces:

Distance<V>

Direct Known Subclasses:

DijkstraShortestPath

public class DijkstraDistance<V,E>
extends java.lang.Object
implements Distance<V>

Calculates distances in a specified graph, using Dijkstra's single-source-shortest-path algorithm. All edge weights in the graph must be nonnegative; if any edge with negative weight is found in the course of calculating distances, an IllegalArgumentException will be thrown. (Note: this exception will only be thrown when such an edge would be used to update a given tentative distance; the algorithm does not check for negative-weight edges "up front".)

Distances and partial results are optionally cached (by this instance) for later reference. Thus, if the 10 closest vertices to a specified source vertex are known, calculating the 20 closest vertices does not require starting Dijkstra's algorithm over from scratch.

Distances are stored as double-precision values. If a vertex is not reachable from the specified source vertex, no distance is stored. This is new behavior with version 1.4; the previous behavior was to store a value of Double.POSITIVE_INFINITY. This change gives the algorithm an approximate complexity of O(kD log k), where k is either the number of requested targets or the number of reachable vertices (whichever is smaller), and D is the average degree of a vertex.

The elements in the maps returned by getDistanceMap are ordered (that is, returned by the iterator) by nondecreasing distance from source.

Users are cautioned that distances calculated should be assumed to be invalidated by changes to the graph, and should invoke reset() when appropriate so that the distances can be recalculated.

Constructor Summary

Constructors

Constructor and Description
DijkstraDistance(Graph<V,E> g) Creates an instance of DijkstraShortestPath for the specified unweighted graph (that is, all weights 1) which caches results locally.
DijkstraDistance(Graph<V,E> g, boolean cached) Creates an instance of DijkstraShortestPath for the specified unweighted graph (that is, all weights 1) which caches results locally.
DijkstraDistance(Hypergraph<V,E> g, com.google.common.base.Function<? super E,? extends java.lang.Number> nev) Creates an instance of DijkstraShortestPath for the specified graph and the specified method of extracting weights from edges, which caches results locally.
DijkstraDistance(Hypergraph<V,E> g, com.google.common.base.Function<? super E,? extends java.lang.Number> nev, boolean cached) Creates an instance of DijkstraShortestPath for the specified graph and the specified method of extracting weights from edges, which caches results locally if and only if cached is true.

Method Summary

Modifier and Type	Method and Description
void	enableCaching(boolean enable) Specifies whether or not this instance of DijkstraShortestPath should cache its results (final and partial) for future reference.
java.lang.Number	getDistance(V source, V target) Returns the length of a shortest path from the source to the target vertex, or null if the target is not reachable from the source.
java.util.Map<V,java.lang.Number>	getDistanceMap(V source) Returns a LinkedHashMap which maps each vertex in the graph (including the source vertex) to its distance from the source vertex.
java.util.Map<V,java.lang.Number>	getDistanceMap(V source, java.util.Collection<V> targets) Returns a Map from each element t of targets to the shortest-path distance from source to t.
java.util.LinkedHashMap<V,java.lang.Number>	getDistanceMap(V source, int numDests) Returns a LinkedHashMap which maps each of the closest numDist vertices to the source vertex in the graph (including the source vertex) to its distance from the source vertex.
void	reset() Clears all stored distances for this instance.
void	reset(V source) Clears all stored distances for the specified source vertex source.
void	setMaxDistance(double max_dist) Allows the user to specify the maximum distance that this instance will calculate.
void	setMaxTargets(int max_targets) Allows the user to specify the maximum number of target vertices per source vertex for which this instance will calculate distances.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DijkstraDistance

public DijkstraDistance(Hypergraph<V,E> g,
                        com.google.common.base.Function<? super E,? extends java.lang.Number> nev,
                        boolean cached)

Creates an instance of DijkstraShortestPath for the specified graph and the specified method of extracting weights from edges, which caches results locally if and only if cached is true.

Parameters:

g - the graph on which distances will be calculated

nev - the class responsible for returning weights for edges

cached - specifies whether the results are to be cached

DijkstraDistance

public DijkstraDistance(Hypergraph<V,E> g,
                        com.google.common.base.Function<? super E,? extends java.lang.Number> nev)

Creates an instance of DijkstraShortestPath for the specified graph and the specified method of extracting weights from edges, which caches results locally.

Parameters:

g - the graph on which distances will be calculated

nev - the class responsible for returning weights for edges

DijkstraDistance

public DijkstraDistance(Graph<V,E> g)

Creates an instance of DijkstraShortestPath for the specified unweighted graph (that is, all weights 1) which caches results locally.

Parameters:

g - the graph on which distances will be calculated

DijkstraDistance

public DijkstraDistance(Graph<V,E> g,
                        boolean cached)

Creates an instance of DijkstraShortestPath for the specified unweighted graph (that is, all weights 1) which caches results locally.

Parameters:

g - the graph on which distances will be calculated

cached - specifies whether the results are to be cached

Method Detail

getDistance

public java.lang.Number getDistance(V source,
                                    V target)

Returns the length of a shortest path from the source to the target vertex, or null if the target is not reachable from the source. If either vertex is not in the graph for which this instance was created, throws IllegalArgumentException.

Specified by:

getDistance in interface Distance<V>

Parameters:

source - the vertex from which the distance to target is to be measured

target - the vertex to which the distance from source is to be measured

Returns:

the distance between source and target

See Also:

getDistanceMap(Object), getDistanceMap(Object,int)

getDistanceMap

public java.util.Map<V,java.lang.Number> getDistanceMap(V source,
                                                        java.util.Collection<V> targets)

Returns a Map from each element t of targets to the shortest-path distance from source to t.

Parameters:

source - the vertex from which the distance to each target is to be measured

targets - the vertices to which the distance from the source is to be measured

Returns:

Map from each element of targets to its distance from source

getDistanceMap

public java.util.Map<V,java.lang.Number> getDistanceMap(V source)

Returns a LinkedHashMap which maps each vertex in the graph (including the source vertex) to its distance from the source vertex. The map's iterator will return the elements in order of increasing distance from source.

The size of the map returned will be the number of vertices reachable from source.

Specified by:

getDistanceMap in interface Distance<V>

Parameters:

source - the vertex from which distances are measured

Returns:

a mapping from each vertex in the graph to its distance from source

See Also:

getDistanceMap(Object,int), getDistance(Object,Object)

getDistanceMap

public java.util.LinkedHashMap<V,java.lang.Number> getDistanceMap(V source,
                                                                  int numDests)

Returns a LinkedHashMap which maps each of the closest numDist vertices to the source vertex in the graph (including the source vertex) to its distance from the source vertex. Throws an IllegalArgumentException if source is not in this instance's graph, or if numDests is either less than 1 or greater than the number of vertices in the graph.

The size of the map returned will be the smaller of numDests and the number of vertices reachable from source.

Parameters:

source - the vertex from which distances are measured

numDests - the number of vertices for which to measure distances

Returns:

a mapping from the numDests vertices in the graph closest to source, to their distance from source

See Also:

getDistanceMap(Object), getDistance(Object,Object)

setMaxDistance

public void setMaxDistance(double max_dist)

Allows the user to specify the maximum distance that this instance will calculate. Any vertices past this distance will effectively be unreachable from the source, in the sense that the algorithm will not calculate the distance to any vertices which are farther away than this distance. A negative value for max_dist will ensure that no further distances are calculated.

This can be useful for limiting the amount of time and space used by this algorithm if the graph is very large.

Note: if this instance has already calculated distances greater than max_dist, and the results are cached, those results will still be valid and available; this limit applies only to subsequent distance calculations.

Parameters:

max_dist - the maximum distance that this instance will calculate

See Also:

setMaxTargets(int)

setMaxTargets

public void setMaxTargets(int max_targets)

Allows the user to specify the maximum number of target vertices per source vertex for which this instance will calculate distances. Once this threshold is reached, any further vertices will effectively be unreachable from the source, in the sense that the algorithm will not calculate the distance to any more vertices. A negative value for max_targets will ensure that no further distances are calculated.

This can be useful for limiting the amount of time and space used by this algorithm if the graph is very large.

Note: if this instance has already calculated distances to a greater number of targets than max_targets, and the results are cached, those results will still be valid and available; this limit applies only to subsequent distance calculations.

Parameters:

max_targets - the maximum number of targets for which this instance will calculate distances

See Also:

setMaxDistance(double)

reset

public void reset()

Clears all stored distances for this instance. Should be called whenever the graph is modified (edge weights changed or edges added/removed). If the user knows that some currently calculated distances are unaffected by a change, reset(V) may be appropriate instead.

See Also:

reset(Object)

enableCaching

public void enableCaching(boolean enable)

Specifies whether or not this instance of DijkstraShortestPath should cache its results (final and partial) for future reference.

Parameters:

enable - true if the results are to be cached, and false otherwise

reset

public void reset(V source)

Clears all stored distances for the specified source vertex source. Should be called whenever the stored distances from this vertex are invalidated by changes to the graph.

Parameters:

source - the vertex for which stored distances should be cleared

See Also:

reset()