org.protempa.graph

Class DirectedGraph

java.lang.Object

org.protempa.graph.DirectedGraph

public final class DirectedGraph
extends Object

A directed graph implementation.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
DirectedGraph() Constructs an empty DirectedGraph with the default initial vertex capacity (10).
DirectedGraph(int initialCapacity) Constructs an empty DirectedGraph with the specified initial vertex capacity.

Method Summary

Modifier and Type	Method and Description
void	add(Object vertex) Adds a vertex.
void	clear() Remove all vertices and edges.
boolean	contains(Object vertex) Check to see if an object is a vertex.
boolean	containsEdge(Object label1, Object label2) Check to see if an edge has been set between two vertices.
Iterator<Edge>	edges() Create an iterator of edges.
Edge[]	edgesAsArray()
Edge	getEdge(Object vertex1, Object vertex2)
int	getEdgeCount() Get the total number of edges.
boolean	isEmpty() Check to see if there are any vertices defined.
Iterator<?>	iterator() Create an iterator of vertices.
Iterator<?>	neighbors(Object label) Create an iterator of all vertices that share an edge with a vertex.
Object	remove(Object vertex) Remove a vertex and all edges between the vertex and other vertices.
void	setEdge(Object vertex1, Object vertex2, Weight weight) Set the edge between two vertices.
int	size() Get the number of vertices.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectedGraph

public DirectedGraph(int initialCapacity)

Constructs an empty DirectedGraph with the specified initial vertex capacity.

Parameters:

initialCapacity - the initial vertex capacity.

DirectedGraph

public DirectedGraph()

Constructs an empty DirectedGraph with the default initial vertex capacity (10).

Method Detail

clear

public void clear()

Remove all vertices and edges.

add

public void add(Object vertex)

Adds a vertex.

Parameters:

vertex - a vertex.

remove

public Object remove(Object vertex)

Remove a vertex and all edges between the vertex and other vertices.

Parameters:

vertex - a vertex.

Returns:

the value of the vertex, if it existed.

contains

public boolean contains(Object vertex)

Check to see if an object is a vertex.

Parameters:

vertex - the object.

Returns:

true if the object is a vertex, false otherwise.

size

public int size()

Get the number of vertices.

Returns:

the number of vertices.

isEmpty

public boolean isEmpty()

Check to see if there are any vertices defined.

Returns:

true if vertices are defined, false otherwise.

getEdge

public Edge getEdge(Object vertex1,
                    Object vertex2)

setEdge

public void setEdge(Object vertex1,
                    Object vertex2,
                    Weight weight)

Set the edge between two vertices. If the two given vertices don't exist, nothing happens. A null weight unsets the edge.

Parameters:

vertex1 - a vertex.

vertex2 - a vertex.

weight - the value of the edge.

containsEdge

public boolean containsEdge(Object label1,
                            Object label2)

Check to see if an edge has been set between two vertices.

Parameters:

label1 - a vertex.

label2 - a vertex.

Returns:

true if an edge has been set, false otherwise or if one or both of the objects are not vertices.

getEdgeCount

public int getEdgeCount()

Get the total number of edges.

Returns:

the total number of edges.

iterator

public Iterator<?> iterator()

Create an iterator of vertices.

Returns:

an iterator of vertices.

neighbors

public Iterator<?> neighbors(Object label)

Create an iterator of all vertices that share an edge with a vertex.

Parameters:

label - a vertex.

Returns:

an iterator of vertices.

edgesAsArray

public Edge[] edgesAsArray()

edges

public Iterator<Edge> edges()

Create an iterator of edges.

Returns:

an iterator of edges.