org.eth.cyril.graphdrawing.graph.algorithms.cycles

Class Cycle

java.lang.Object

org.eth.cyril.graphdrawing.graph.algorithms.cycles.Cycle

class Cycle
extends java.lang.Object

Represents a single cycle in a graph. Each cycle must be broken to create an acyclic graph. Removing any edge from a cycle breaks that cycle.

Constructor Summary

Constructors

Constructor and Description
Cycle(java.util.Set<Edge> edges) Create a cycle from the given set of edges.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	addEdge(Edge edge) Adds the edge to the cycle.
(package private) java.util.Set<Edge>	getEdges() Return the set of remaining edges in the cycle.
(package private) boolean	isCycleBroken() Returns whether the cycle is broken.
(package private) boolean	matchesCycle(java.util.Collection<Edge> otherCycle) Returns whether this cycle has the same edges as the given collection of edges, in any order.
(package private) boolean	removeEdge(Edge edge) Removes the given edge from the cycle.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cycle

Cycle(java.util.Set<Edge> edges)

Create a cycle from the given set of edges.

Parameters:

edges - The edges creating a cycle.

Method Detail

getEdges

java.util.Set<Edge> getEdges()

Return the set of remaining edges in the cycle.

removeEdge

boolean removeEdge(Edge edge)

Removes the given edge from the cycle. Does nothing if the edge is not part of the cycle.

Parameters:

edge - The edge to remove.

Returns:

Whether the cycle is now broken.

addEdge

boolean addEdge(Edge edge)

Adds the edge to the cycle. The edge must have previously been removed for this method to do anything.

Parameters:

edge - The edge to add.

Returns:

Whether the cycle is now broken.

isCycleBroken

boolean isCycleBroken()

Returns whether the cycle is broken. To break a cycle, any edge from the cycle must be removed.

matchesCycle

boolean matchesCycle(java.util.Collection<Edge> otherCycle)

Returns whether this cycle has the same edges as the given collection of edges, in any order.

Parameters:

otherCycle - The collection of edges making up the other cycle.

Returns:

Whether these are the same cycles.