pascal.taie.util.graph.SCC Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tai-e Show documentation
An easy-to-learn/use static analysis framework for Java
The newest version!
/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan 
 * Copyright (C) 2022 Yue Li 
 *
 * This file is part of Tai-e.
 *
 * Tai-e is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e is distributed in the hope that it will be useful,but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see .
 */

package pascal.taie.util.graph;

import pascal.taie.util.collection.Maps;
import pascal.taie.util.collection.Sets;

import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Deque;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Finds strongly connected components in a directed graph using
 * Tarjan's algorithm.
 *
 * @param  type of nodes
 */
public class SCC {

    private final List> componentList = new ArrayList<>();
    private final List> trueComponentList = new ArrayList<>();

    public SCC(Graph graph) {
        compute(graph);
        validate(graph, componentList);
    }

    /**
     * @return the list of the strongly-connected components
     */
    public List> getComponents() {
        return componentList;
    }

    /**
     * @return the list of the strongly-connected components, but only those
     * that are true components, i.e. components which have more than one element
     * or consists of one node that has itself as a successor
     */
    public List> getTrueComponents() {
        return trueComponentList;
    }

    private void compute(Graph graph) {
        // use iterative (non-recursive) algorithm to avoid stack overflow
        // for large graph
        int index = 0;
        Map indexes = Maps.newMap(graph.getNumberOfNodes());
        Map lows = Maps.newMap(graph.getNumberOfNodes());
        Deque stack = new ArrayDeque<>();
        Set inStack = Sets.newSet();
        for (N curr : graph) {
            if (indexes.containsKey(curr)) {
                continue;
            }
            Deque workStack = new ArrayDeque<>();
            workStack.push(curr);
            while (!workStack.isEmpty()) {
                N node = workStack.peek();
                if (!indexes.containsKey(node)) {
                    indexes.put(node, index);
                    lows.put(node, index);
                    ++index;
                    stack.push(node);
                    inStack.add(node);
                }
                boolean hasUnvisitedSucc = false;
                for (N succ : graph.getSuccsOf(node)) {
                    if (!indexes.containsKey(succ)) {
                        workStack.push(succ);
                        hasUnvisitedSucc = true;
                        break;
                    } else if (indexes.get(node) < indexes.get(succ)) {
                        // node->succ is a forward edge
                        lows.put(node, Math.min(lows.get(node), lows.get(succ)));
                    } else if (inStack.contains(succ)) {
                        lows.put(node, Math.min(lows.get(node), indexes.get(succ)));
                    }
                }
                if (!hasUnvisitedSucc) {
                    if (lows.get(node).equals(indexes.get(node))) {
                        collectSCC(node, stack, inStack, graph);
                    }
                    workStack.pop();
                }
            }
        }
    }

    private void collectSCC(N node, Deque stack, Set inStack, Graph graph) {
        List scc = new ArrayList<>();
        N v2;
        do {
            v2 = stack.pop();
            inStack.remove(v2);
            scc.add(v2);
        } while (node != v2);
        // Reverse SCC so that the nodes connected to predecessors
        // (outside the SCC) will be listed ahead.
        Collections.reverse(scc);
        componentList.add(scc);
        if (scc.size() > 1) {
            trueComponentList.add(scc);
        } else {
            N n = scc.get(0);
            if (graph.hasEdge(n, n)) {
                trueComponentList.add(scc);
            }
        }
    }

    /**
     * Validates whether the number of nodes in all components is
     * equal to the number of nodes in the given graph.
     */
    private void validate(Graph graph, List> components) {
        assert graph.getNumberOfNodes() ==
                components.stream().mapToInt(List::size).sum();
    }
}