org.jgrapht.alg.cycle

Class TarjanSimpleCycles<V,E>

java.lang.Object

org.jgrapht.alg.cycle.TarjanSimpleCycles<V,E>

Type Parameters:

V - the vertex type.

E - the edge type.

All Implemented Interfaces:

DirectedSimpleCycles<V,E>

public class TarjanSimpleCycles<V,E>
extends Object
implements DirectedSimpleCycles<V,E>

Find all simple cycles of a directed graph using the Tarjan's algorithm.

See:
R. Tarjan, Enumeration of the elementary circuits of a directed graph, SIAM J. Comput., 2 (1973), pp. 211-216.

Author:

Nikolay Ognyanov

Constructor Summary

Constructors

Constructor and Description
TarjanSimpleCycles() Create a simple cycle finder with an unspecified graph.
TarjanSimpleCycles(Graph<V,E> graph) Create a simple cycle finder for the specified graph.

Method Summary

Modifier and Type	Method and Description
List<List<V>>	findSimpleCycles() Finds the simple cycles of the graph. Note that the full algorithm is executed on every call since the graph may have changed between calls.
Graph<V,E>	getGraph() Returns the graph on which the simple cycle search algorithm is executed by this object.
void	setGraph(Graph<V,E> graph) Sets the graph on which the simple cycle search algorithm is executed by this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TarjanSimpleCycles

public TarjanSimpleCycles()

Create a simple cycle finder with an unspecified graph.

TarjanSimpleCycles

public TarjanSimpleCycles(Graph<V,E> graph)

Create a simple cycle finder for the specified graph.

Parameters:

graph - - the DirectedGraph in which to find cycles.

Throws:

IllegalArgumentException - if the graph argument is null.

Method Detail

getGraph

public Graph<V,E> getGraph()

Returns the graph on which the simple cycle search algorithm is executed by this object.

Specified by:

getGraph in interface DirectedSimpleCycles<V,E>

Returns:

The graph.

setGraph

public void setGraph(Graph<V,E> graph)

Sets the graph on which the simple cycle search algorithm is executed by this object.

Specified by:

setGraph in interface DirectedSimpleCycles<V,E>

Parameters:

graph - the graph.

findSimpleCycles

public List<List<V>> findSimpleCycles()

Finds the simple cycles of the graph.
Note that the full algorithm is executed on every call since the graph may have changed between calls.

Specified by:

findSimpleCycles in interface DirectedSimpleCycles<V,E>

Returns:

The list of all simple cycles. Possibly empty but never null.