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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Number
getDistance(V source, V target)
Returns the distance from thesource
vertex to thetarget
vertex.java.util.Map<V,java.lang.Number>
getDistanceMap(V source)
Returns aMap
which maps each vertex in the graph (including thesource
vertex) to its distance (represented as a Number) fromsource
.
-
-
-
Method Detail
-
getDistance
java.lang.Number getDistance(V source, V target)
Returns the distance from thesource
vertex to thetarget
vertex. Iftarget
is not reachable fromsource
, returns null.- Parameters:
source
- the vertex from which distance is to be measuredtarget
- the vertex to which distance is to be measured- Returns:
- the distance from
source
totarget
-
getDistanceMap
java.util.Map<V,java.lang.Number> getDistanceMap(V source)
Returns aMap
which maps each vertex in the graph (including thesource
vertex) to its distance (represented as a Number) fromsource
. If any vertex is not reachable fromsource
, no distance is stored for that vertex.- Parameters:
source
- the vertex from which distances are to be measured- Returns:
- a
Map
of the distances fromsource
to other vertices in the graph
-
-