Class LexBreadthFirstIterator<V,E>

java.lang.Object
org.jgrapht.traverse.AbstractGraphIterator<V,E>
org.jgrapht.traverse.LexBreadthFirstIterator<V,E>
Type Parameters:
V - the graph vertex type.
E - the graph edge type.
All Implemented Interfaces:
Iterator<V>, GraphIterator<V,E>
public class LexBreadthFirstIterator<V,E> extends AbstractGraphIterator<V,E>
A lexicographical breadth-first iterator for an undirected graph.

Every vertex has an implicit label (they aren't used explicitly in order to reduce time and memory complexity). When some vertex is returned by this iterator, its index is the number of vertices in this graph minus number of already returned vertices. For a given vertex v its label is a concatenation of indices of already returned vertices, that were also its neighbours, with some separator between them. For example, 7#4#3 is a valid vertex label.

Iterator chooses vertex with lexicographically largest label and returns it. It breaks ties arbitrarily. For more information on lexicographical BFS see the following article: Corneil D.G. (2004) Lexicographic Breadth First Search – A Survey. In: Hromkovič J., Nagl M., Westfechtel B. (eds) Graph-Theoretic Concepts in Computer Science. WG 2004. Lecture Notes in Computer Science, vol 3353. Springer, Berlin, Heidelberg; and the following paper:CS 762: Graph-theoretic algorithms. Lecture notes of a graduate course. University of Waterloo.

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.

Note: only vertex events are fired by this iterator.

  • Field Details

    • bucketList

      private LexBreadthFirstIterator<V,E>.BucketList bucketList
      Reference to the BucketList that contains unvisited vertices.

    • current

      private V current
      Contains current vertex of the graph.

  • Constructor Details

    • LexBreadthFirstIterator

      public LexBreadthFirstIterator(Graph<V,E> graph)
      Creates new lexicographical breadth-first iterator for graph.
      Parameters:
      graph - the graph to be iterated.

  • Method Details

    • hasNext

      public boolean hasNext()
      Checks whether there exist unvisited vertices.
      Returns:
      true if there exist unvisited vertices.

    • next

      public V next()
      Returns the next vertex in the ordering.
      Returns:
      the next vertex in the ordering.

    • isCrossComponentTraversal

      public boolean isCrossComponentTraversal()
      Test whether this iterator is set to traverse the graph across connected components.

      Always returns true since this iterator doesn't care about connected components.

      Specified by:
      isCrossComponentTraversal in interface GraphIterator<V,E>
      Overrides:
      isCrossComponentTraversal in class AbstractGraphIterator<V,E>
      Returns:
      true if traverses across connected components, otherwise false.

    • setCrossComponentTraversal

      public void setCrossComponentTraversal(boolean crossComponentTraversal)
      Sets the cross component traversal flag - indicates whether to traverse the graph across connected components.

      Trying to disable the cross components nature of this iterator will result into throwing a IllegalArgumentException.

      Overrides:
      setCrossComponentTraversal in class AbstractGraphIterator<V,E>
      Parameters:
      crossComponentTraversal - if true traverses across connected components.

    • advance

      private V advance()
      Retrieves vertex from the bucketList and returns it.
      Returns:
      the vertex retrieved from the bucketList.

    • getUnvisitedNeighbours

      private Set<V> getUnvisitedNeighbours(V vertex)
      Computes and returns neighbours of vertex which haven't been visited by this iterator.
      Parameters:
      vertex - the vertex, whose neighbours are being explored.
      Returns:
      neighbours of vertex which have yet to be visited by this iterator.