Module org.jgrapht.core
Package org.jgrapht.traverse

Class DepthFirstIterator<V,​E>

java.lang.Object
org.jgrapht.traverse.AbstractGraphIterator<V,​E>
org.jgrapht.traverse.CrossComponentIterator<V,​E,​DepthFirstIterator.VisitColor>
org.jgrapht.traverse.DepthFirstIterator<V,​E>
Type Parameters:
V - the graph vertex type
E - the graph edge type
All Implemented Interfaces:
java.util.Iterator<V>, GraphIterator<V,​E>
public class DepthFirstIterator<V,​E>
extends CrossComponentIterator<V,​E,​DepthFirstIterator.VisitColor>
A depth-first iterator for a directed or undirected graph.

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:
Liviu Rau, Barak Naveh

  • Field Details

    • SENTINEL

      public static final java.lang.Object SENTINEL
      Sentinel object. Unfortunately, we can't use null, because ArrayDeque won't accept those. And we don't want to rely on the caller to provide a sentinel object for us. So we have to play typecasting games.

  • Constructor Details

    • DepthFirstIterator

      public DepthFirstIterator​(Graph<V,​E> g)
      Creates a new depth-first iterator for the specified graph.
      Parameters:
      g - the graph to be iterated.

    • DepthFirstIterator

      public DepthFirstIterator​(Graph<V,​E> g, V startVertex)
      Creates a new depth-first iterator for the specified graph. Iteration will start at the specified start vertex and will be limited to the connected component that includes that vertex. If the specified start vertex is null, iteration will start at an arbitrary vertex and will not be limited, that is, will be able to traverse all the graph.
      Parameters:
      g - the graph to be iterated.
      startVertex - the vertex iteration to be started.

    • DepthFirstIterator

      public DepthFirstIterator​(Graph<V,​E> g, java.lang.Iterable<V> startVertices)
      Creates a new depth-first iterator for the specified graph. Iteration will start at the specified start vertices and will be limited to the connected component that includes those vertices. If the specified start vertices is null, iteration will start at an arbitrary vertex and will not be limited, that is, will be able to traverse all the graph.
      Parameters:
      g - the graph to be iterated.
      startVertices - the vertices iteration to be started.

  • Method Details