org.jgrapht.alg.interfaces

Interface KShortestPathAlgorithm<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Known Implementing Classes:

BhandariKDisjointShortestPaths, KShortestPaths, KShortestSimplePaths

public interface KShortestPathAlgorithm<V,E>

An algorithm which computes $k$-shortest paths between vertices.

Author:

Dimitrios Michail

Method Summary

Modifier and Type	Method and Description
default List<GraphPath<V,E>>	getPaths(V source, V sink) Deprecated. In favor of providing k as a parameter.
List<GraphPath<V,E>>	getPaths(V source, V sink, int k) Get a list of k-shortest paths from a source vertex to a sink vertex.

Method Detail

getPaths

@Deprecated
default List<GraphPath<V,E>> getPaths(V source,
                                                  V sink)

Deprecated. In favor of providing k as a parameter.

Get a list of shortest paths from a source vertex to a sink vertex. If no such paths exist this method returns an empty list.

Parameters:

source - the source vertex

sink - the target vertex

Returns:

a list of shortest paths

getPaths

List<GraphPath<V,E>> getPaths(V source,
                              V sink,
                              int k)

Get a list of k-shortest paths from a source vertex to a sink vertex. If no such paths exist this method returns an empty list.

Parameters:

source - the source vertex

sink - the target vertex

k - the number of shortest paths to return

Returns:

a list of the k-shortest paths