Class YenShortestPathIterator<V,E>
 java.lang.Object

 org.jgrapht.alg.shortestpath.YenShortestPathIterator<V,E>

 Type Parameters:
V
 the graph vertex typeE
 the graph edge type
public class YenShortestPathIterator<V,E> extends Object implements Iterator<GraphPath<V,E>>
Iterator over the shortest loopless paths between two vertices in a graph sorted by weight.For this iterator to work correctly the graph must not be modified during iteration. Currently there are no means to ensure that, nor to failfast. The results of such modifications are undefined.
The main idea of this algorithm is to divide each path between the
source
and thesink
into the root part  the part that coincides within some of the paths computed so far, and the spur part, the part that deviates from all other paths computed so far. Therefore, for each path the algorithm maintains a vertex, at which the path deviates from its "parent" path (the candidate path using which it was computed).First the algorithm finds the shortest path between the
source
and thesink
, which is put into the candidates heap. Thesource
is assigned to be its deviation vertex. Then on each iteration the algorithm takes a candidate from the heap with minimum weight, puts it into the result list and builds all possible deviations from it wrt. other paths, that are in the result list. By generating spur paths starting only from the vertices that are after the deviation vertex of current path (including the deviation vertex) it is possible to avoid building duplicated candidates. Author:
 Semen Chudakov


Constructor Summary
Constructors Constructor Description YenShortestPathIterator(Graph<V,E> graph, V source, V sink)
Constructs an instance of the algorithm for givengraph
,source
andsink
.YenShortestPathIterator(Graph<V,E> graph, V source, V sink, Supplier<org.jheaps.AddressableHeap<Double,GraphPath<V,E>>> heapSupplier)
Constructs an instance of the algorithm for givengraph
,source
,sink
andheapSupplier
.

Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
hasNext()
GraphPath<V,E>
next()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining, remove




Constructor Detail

YenShortestPathIterator
public YenShortestPathIterator(Graph<V,E> graph, V source, V sink)
Constructs an instance of the algorithm for givengraph
,source
andsink
. Parameters:
graph
 graphsource
 source vertexsink
 sink vertex

YenShortestPathIterator
public YenShortestPathIterator(Graph<V,E> graph, V source, V sink, Supplier<org.jheaps.AddressableHeap<Double,GraphPath<V,E>>> heapSupplier)
Constructs an instance of the algorithm for givengraph
,source
,sink
andheapSupplier
. Parameters:
graph
 graphsource
 source vertexsink
 sink vertexheapSupplier
 supplier of the preferable heap implementation

