Class RandomWalkIterator<V,E>
- java.lang.Object
-
- org.jgrapht.traverse.AbstractGraphIterator<V,E>
-
- org.jgrapht.traverse.RandomWalkIterator<V,E>
-
- Type Parameters:
V
- vertex typeE
- edge type
- All Implemented Interfaces:
java.util.Iterator<V>
,GraphIterator<V,E>
public class RandomWalkIterator<V,E> extends AbstractGraphIterator<V,E>
A random walk iterator for a directed or undirected graph.At each step the iterator selects a random (uniformly distributed) edge out of the current vertex and follows it to the next vertex. In case of directed graphs the outgoing edge set is used. See wikipedia for more details.
In case a weighted walk is desired, edges are selected with probability respective to its weight (out of the total weight of the edges). The walk can be bounded by number of steps (default
Long#MAX_VALUE
. When the bound is reached the iterator is considered exhausted. Callingnext()
on exhausted iterator will throwNoSuchElementException
. In case a sink (i.e. no edges) vertex is reached, any consecutive calls tonext()
will throwNoSuchElementException
.For this iterator to work correctly the graph must not be modified during iteration. Currently there are no means to ensure that, nor to fail-fast. The results of such modifications are undefined.
- Author:
- Assaf Mizrachi
-
-
Field Summary
-
Fields inherited from class org.jgrapht.traverse.AbstractGraphIterator
crossComponentTraversal, graph, nListeners, reusableEdgeEvent, reusableVertexEvent, reuseEvents
-
-
Constructor Summary
Constructors Constructor Description RandomWalkIterator(Graph<V,E> graph)
Creates a new iterator for the specified graph.RandomWalkIterator(Graph<V,E> graph, V startVertex)
Creates a new iterator for the specified graph.RandomWalkIterator(Graph<V,E> graph, V startVertex, boolean isWeighted)
Creates a new iterator for the specified graph.RandomWalkIterator(Graph<V,E> graph, V startVertex, boolean isWeighted, long maxSteps)
Creates a new iterator for the specified graph.RandomWalkIterator(Graph<V,E> graph, V startVertex, boolean isWeighted, long maxSteps, java.util.Random rng)
Creates a new iterator for the specified graph.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
encounterVertex(V vertex, E edge)
Update data structures every time we see a vertex.boolean
hasNext()
protected boolean
isExhausted()
Check if this walk is exhausted.V
next()
-
Methods inherited from class org.jgrapht.traverse.AbstractGraphIterator
addTraversalListener, createEdgeTraversalEvent, createVertexTraversalEvent, fireConnectedComponentFinished, fireConnectedComponentStarted, fireEdgeTraversed, fireVertexFinished, fireVertexTraversed, getGraph, isCrossComponentTraversal, isReuseEvents, remove, removeTraversalListener, setCrossComponentTraversal, setReuseEvents
-
-
-
-
Constructor Detail
-
RandomWalkIterator
public RandomWalkIterator(Graph<V,E> graph)
Creates a new iterator for the specified graph. Iteration will start at arbitrary vertex. Walk is un-weighted and bounded byLong#MAX_VALUE
steps.- Parameters:
graph
- the graph to be iterated.- Throws:
java.lang.IllegalArgumentException
- ifgraph==null
or does not containstartVertex
-
RandomWalkIterator
public RandomWalkIterator(Graph<V,E> graph, V startVertex)
Creates a new iterator for the specified graph. Iteration will start at the specified start vertex. If the specified start vertex isnull
, Iteration will start at an arbitrary graph vertex. Walk is un-weighted and bounded byLong#MAX_VALUE
steps.- Parameters:
graph
- the graph to be iterated.startVertex
- the vertex iteration to be started.- Throws:
java.lang.IllegalArgumentException
- ifgraph==null
or does not containstartVertex
-
RandomWalkIterator
public RandomWalkIterator(Graph<V,E> graph, V startVertex, boolean isWeighted)
Creates a new iterator for the specified graph. Iteration will start at the specified start vertex. If the specified start vertex isnull
, Iteration will start at an arbitrary graph vertex. Walk is bounded byLong#MAX_VALUE
steps.- Parameters:
graph
- the graph to be iterated.startVertex
- the vertex iteration to be started.isWeighted
- set totrue
if a weighted walk is desired.- Throws:
java.lang.IllegalArgumentException
- ifgraph==null
or does not containstartVertex
-
RandomWalkIterator
public RandomWalkIterator(Graph<V,E> graph, V startVertex, boolean isWeighted, long maxSteps)
Creates a new iterator for the specified graph. Iteration will start at the specified start vertex. If the specified start vertex isnull
, Iteration will start at an arbitrary graph vertex. Walk is bounded by the provided number steps.- Parameters:
graph
- the graph to be iterated.startVertex
- the vertex iteration to be started.isWeighted
- set totrue
if a weighted walk is desired.maxSteps
- number of steps before walk is exhausted.- Throws:
java.lang.IllegalArgumentException
- ifgraph==null
or does not containstartVertex
-
RandomWalkIterator
public RandomWalkIterator(Graph<V,E> graph, V startVertex, boolean isWeighted, long maxSteps, java.util.Random rng)
Creates a new iterator for the specified graph. Iteration will start at the specified start vertex. If the specified start vertex isnull
, Iteration will start at an arbitrary graph vertex. Walk is bounded by the provided number steps.- Parameters:
graph
- the graph to be iterated.startVertex
- the vertex iteration to be started.isWeighted
- set totrue
if a weighted walk is desired.maxSteps
- number of steps before walk is exhausted.rng
- the random number generator to use- Throws:
java.lang.IllegalArgumentException
- ifgraph==null
or does not containstartVertex
-
-
Method Detail
-
isExhausted
protected boolean isExhausted()
Check if this walk is exhausted. Callingnext()
on exhausted iterator will throwNoSuchElementException
.- Returns:
true
if this iterator is exhausted,false
otherwise.
-
encounterVertex
protected void encounterVertex(V vertex, E edge)
Update data structures every time we see a vertex.- Parameters:
vertex
- the vertex encounterededge
- the edge via which the vertex was encountered, or null if the vertex is a starting point
-
hasNext
public boolean hasNext()
-
next
public V next()
-
-