edu.uci.ics.jung.algorithms.shortestpath
Interface Distance

All Known Implementing Classes:

DijkstraShortestPath, UnweightedShortestPath

public interface Distance

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

Author:

Joshua O'Madadhain

Method Summary

java.lang.Number	getDistance(Vertex source, Vertex target) Returns the distance from the source vertex to the target vertex.
java.util.Map	getDistanceMap(Vertex 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

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

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

getDistanceMap

public java.util.Map getDistanceMap(Vertex 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.