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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of robovm-soot Show documentation

RoboVM fork of Soot - A Java optimization framework

The newest version!

/* Soot - a J*va Optimization Framework
 * Copyright (C) 2006 Eric Bodden
 *
 * This library 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 library 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 this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

package soot.toolkits.graph;

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);

}