Class BFSPathFinder<T>

java.lang.Object
com.ibm.wala.util.graph.traverse.BFSPathFinder<T>

public class BFSPathFinder<T> extends Object
This class searches breadth-first for node that matches some criteria. If found, it reports a path to the first node found.

This class follows the outNodes of the graph nodes to define the graph, but this behavior can be changed by overriding the getConnected method.

TODO: if finding many paths, use a dynamic programming algorithm instead of calling this repeatedly.

  • Constructor Details

    • BFSPathFinder

      public BFSPathFinder(Graph<T> G, T N, Predicate<T> f)
      Construct a breadth-first enumerator starting with a particular node in a directed graph.
      Parameters:
      G - the graph whose nodes to enumerate
    • BFSPathFinder

      public BFSPathFinder(Graph<T> G, T src, T target) throws IllegalArgumentException
      Construct a breadth-first enumerator starting with a particular node in a directed graph.
      Parameters:
      G - the graph whose nodes to enumerate
      Throws:
      IllegalArgumentException - if G is null
    • BFSPathFinder

      public BFSPathFinder(Graph<T> G, T src, Iterator<T> targets)
      Construct a breadth-first enumerator starting with a particular node in a directed graph.
      Parameters:
      G - the graph whose nodes to enumerate
    • BFSPathFinder

      public BFSPathFinder(Graph<T> G, Iterator<T> sources, T target)
      Construct a breadth-first enumerator starting with any of a set of nodes in a directed graph.
      Parameters:
      G - the graph whose nodes to enumerate
    • BFSPathFinder

      public BFSPathFinder(Graph<T> G, Iterator<T> nodes, Predicate<T> f)
      Construct a breadth-first enumerator across the (possibly improper) subset of nodes reachable from the nodes in the given enumeration.
      Parameters:
      nodes - the set of nodes from which to start searching
  • Method Details

    • find

      @NullUnmarked public @Nullable List<T> find()
      Returns:
      a List of nodes that specifies the first path found from a root to a node accepted by the filter. Returns null if no path found.
    • getConnected

      protected Iterator<? extends T> getConnected(T n)
      get the out edges of a given node
      Parameters:
      n - the node of which to get the out edges
      Returns:
      the out edges