com.asakusafw.utils.graph

Interface Graph<V>

Type Parameters:

V - the vertex value type

All Superinterfaces:

Iterable<Graph.Vertex<V>>

All Known Implementing Classes:

HashGraph

public interface Graph<V>
extends Iterable<Graph.Vertex<V>>

Represents a directed graph. This identifies each vertex value by using its Object.equals(Object).

See Also:

Graphs

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Graph.Vertex<V> Represents a vertex and its successor.

Method Summary

Modifier and Type	Method and Description
void	addEdge(V source, V destination) Adds a directed edge from the source to destination.
void	addEdges(V source, Collection<? extends V> destinations) Adds directed edges from the source to each vertex in destinations.
void	addNode(V node) Adds a vertex.
void	clear() Removes the all vertices and edges in this graph.
boolean	contains(Object node) Returns whether this graph contains the target vertex or not.
Set<V>	getConnected(Object key) Returns the vertices which are direct successors of the specified vertex.
Set<V>	getNodeSet() Returns the all vertices in this graph.
boolean	isConnected(Object source, Object destination) Returns whether this graph contains the edge from source to destination or not.
boolean	isEmpty() Returns whether this graph is empty or not.
void	removeEdge(Object source, Object destination) Removes the edge from source to destination in this graph.
void	removeNode(Object node) Removes the vertex in this graph.
void	removeNodes(Collection<?> nodes) Removes the vertices in this graph.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

addEdge

void addEdge(V source,
             V destination)

Adds a directed edge from the source to destination. This method ignores the edge if it is already in this graph. This method also addNode(Object) source and destination vertices to this graph if they are not in this graph.

Parameters:

source - the source vertex value (predecessor)

destination - the destination vertex value (successor)

addEdges

void addEdges(V source,
              Collection<? extends V> destinations)

Adds directed edges from the source to each vertex in destinations. This method ignores an edge if it is already in this graph. This method also addNode(Object) source and each vertex in destinations to this graph if they are not in this graph. If destinations is an empty collection, this method will only add the source vertex to this graph, and not add any edges.

Parameters:

source - the tail vertex value (predecessor)

destinations - the head vertex values (successors)

Throws:

IllegalArgumentException - if to is null

addNode

void addNode(V node)

Adds a vertex. This method ignores the vertex if it is already in this graph.

Parameters:

node - the vertex value

clear

void clear()

Removes the all vertices and edges in this graph.

contains

boolean contains(Object node)

Returns whether this graph contains the target vertex or not.

Parameters:

node - the target vertex value

Returns:

true if this graph contains the target vertex, otherwise false

getConnected

Set<V> getConnected(Object key)

Returns the vertices which are direct successors of the specified vertex. If the vertex is not in this graph, this method will return an empty set. Clients should not modify the resulting set.

Parameters:

key - the target vertex value

Returns:

the successors of the specified vertex

getNodeSet

Set<V> getNodeSet()

Returns the all vertices in this graph. Clients should not modify the resulting set.

Returns:

the all vertices in this graph

isConnected

boolean isConnected(Object source,
                    Object destination)

Returns whether this graph contains the edge from source to destination or not.

Parameters:

source - the source vertex value (predecessor)

destination - the destination vertex value (successor)

Returns:

true if this graph contains the edge from source to destination, otherwise false

isEmpty

boolean isEmpty()

Returns whether this graph is empty or not.

Returns:

true if this graph does not contains any vertices, otherwise false

removeEdge

void removeEdge(Object source,
                Object destination)

Removes the edge from source to destination in this graph. If this graph does not contain such the edge, this method will do nothing.

Parameters:

source - the source vertex value (predecessor)

destination - the destination vertex value (successor)

removeNode

void removeNode(Object node)

Removes the vertex in this graph. This method also removes edges which are connected to the target vertex. If this graph does not contain such the vertex, this method will do nothing.

Parameters:

node - the target vertex value

removeNodes

void removeNodes(Collection<?> nodes)

Removes the vertices in this graph. If this method also removes edges which are connected to vertex in the specified collection. This method ignores vertices which are not in this graph.

Parameters:

nodes - the target vertices

Throws:

IllegalArgumentException - if the parameter is null