com.ibm.wala.util.graph.traverse.DFSAllPathsFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.ibm.wala.util Show documentation

T. J. Watson Libraries for Analysis

The newest version!

/*
 * Copyright (c) 2013 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 */
package com.ibm.wala.util.graph.traverse;

import com.ibm.wala.util.collections.FilterIterator;
import com.ibm.wala.util.collections.Pair;
import com.ibm.wala.util.graph.Graph;
import java.util.Iterator;
import java.util.List;
import java.util.function.Predicate;
import org.jspecify.annotations.Nullable;

/**
 * Extends {@link DFSPathFinder} to discover all paths from a set of root nodes to nodes passing
 * some {@link Predicate}.
 *
 * Note that this code performs work that is potentially exponential in the size of the
 * underlying graph, using exponential space. It most likely won't work even for graphs of moderate
 * size.
 */
public class DFSAllPathsFinder extends DFSPathFinder {

  private static final long serialVersionUID = 5413569289853649240L;

  public DFSAllPathsFinder(Graph G, Iterator nodes, Predicate f) {
    super(G, nodes, f);
  }

  public DFSAllPathsFinder(Graph G, T N, Predicate f) throws IllegalArgumentException {
    super(G, N, f);
  }

  @Override
  protected Iterator getConnected(T n) {
    final List cp = currentPath();
    return new FilterIterator<>(G.getSuccNodes(n), o -> !cp.contains(o));
  }

  @Override
  protected @Nullable Iterator getPendingChildren(T n) {
    Pair, T> key = Pair.make(currentPath(), n);
    return pendingChildren.get(key);
  }

  @Override
  protected void setPendingChildren(T v, Iterator iterator) {
    Pair, T> key = Pair.make(currentPath(), v);
    pendingChildren.put(key, iterator);
  }
}