soot.toolkits.graph.Orderer Maven / Gradle / Ivy

package soot.toolkits.graph;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 2006 Eric Bodden
 * %%
 * This program 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 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.List;

/**
 * An orderer builds an order on a directed, not necessarily acyclic, graph.
 *
 * @author Eric Bodden
 */
public interface Orderer {

  /**
   * Builds an order for a directed graph. The order is represented by the returned list, i.e. is a node was assigned number
   * i in the order, it will be in the ith position of the returned list.
   *
   * @param g
   *          a DirectedGraph instance whose nodes we wish to order
   * @param reverse
   *          true to compute the reverse order
   * @return a somehow ordered list of the graph's nodes
   */
  public abstract List newList(DirectedGraph g, boolean reverse);

}