edu.uci.ics.jung.algorithms.shortestpath

Interface Distance<V>

All Known Implementing Classes:

DijkstraDistance, DijkstraShortestPath, UnweightedShortestPath

public interface Distance<V>

An interface for classes which calculate the distance between one vertex and another.

Author:

Joshua O'Madadhain

Method Summary

Modifier and Type	Method and Description
Number	getDistance(V source, V target) Returns the distance from the source vertex to the target vertex.
Map<V,Number>	getDistanceMap(V source) Returns a Map which maps each vertex in the graph (including the source vertex) to its distance (represented as a Number) from source.

Method Detail

getDistance

Number getDistance(V source,
                   V target)

Returns the distance from the source vertex to the target vertex. If target is not reachable from source, returns null.

Parameters:

source - the vertex from which distance is to be measured

target - the vertex to which distance is to be measured

Returns:

the distance from source to target

getDistanceMap

Map<V,Number> getDistanceMap(V source)

Returns a Map which maps each vertex in the graph (including the source vertex) to its distance (represented as a Number) from source. If any vertex is not reachable from source, no distance is stored for that vertex.

Parameters:

source - the vertex from which distances are to be measured

Returns:

a Map of the distances from source to other vertices in the graph