support.graph

Interface Graph<V>

Type Parameters:

V -

public interface Graph<V>

This interface defines an abstract kind of Graph, with which the graph support code can interact to produce the correct visualizer.

Method Summary

Modifier and Type	Method and Description
boolean	areAdjacent(CS16Vertex<V> v1, CS16Vertex<V> v2) For a directed graph, returns true if there exists an Edge that starts on v1 and ends on v2. For an undirected graph, returns true if there is an edge between v1 and v2.
void	clear() Clears all the vertices and edges from the graph.
CS16Edge<V>	connectingEdge(CS16Vertex<V> v1, CS16Vertex<V> v2) Returns the edge that connects the two vertices.
java.util.Iterator<CS16Edge<V>>	edges() Returns an iterator holding all the edges of the graph.
java.util.List<CS16Vertex<V>>	endVertices(CS16Edge<V> edge) Returns the two Vertices that the Edge e is connected to.
java.util.Iterator<CS16Edge<V>>	incomingEdges(CS16Vertex<V> vert) Returns an Iterator over all the Edges that end on this Vertex.
CS16Edge<V>	insertEdge(CS16Vertex<V> v1, CS16Vertex<V> v2, java.lang.Integer edgeElement) Inserts a new Edge into your Graph.
CS16Vertex<V>	insertVertex(V vertElement) Inserts a Vertex into the graph.
CS16Vertex<V>	opposite(CS16Vertex<V> vert, CS16Edge<V> edge) Returns the Vertex that is on the other side of Edge e opposite of Vertex v.
java.lang.Integer	removeEdge(CS16Edge<V> edge) Removes an Edge from your Graph.
V	removeVertex(CS16Vertex<V> vert) Removes a Vertex from your graph.
java.util.Iterator<CS16Vertex<V>>	vertices() Returns an iterator holding all the Vertices of the graph.
java.util.Iterator<CS16Edge<V>>	outgoingEdges(CS16Vertex<V> vert) Returns an Iterator over all the Edges that start on this Vertex.

Method Detail

areAdjacent

boolean areAdjacent(CS16Vertex<V> v1,
                    CS16Vertex<V> v2)
             throws InvalidVertexException

For a directed graph, returns true if there exists an Edge that starts on v1 and ends on v2. For an undirected graph, returns true if there is an edge between v1 and v2.

Parameters:

v1 - The first Vertex to test adjacency.

v2 - The second Vertex to test adjacency.

Returns:

whether the vertices are adjacent.

Throws:

InvalidVertexException - Thrown if either vertex is invalid.

clear

void clear()

Clears all the vertices and edges from the graph.

connectingEdge

CS16Edge<V> connectingEdge(CS16Vertex<V> v1,
                           CS16Vertex<V> v2)
                    throws InvalidVertexException,
                           NoSuchEdgeException

Returns the edge that connects the two vertices.

Parameters:

v1 - The first vertex that may be connected.

v2 - The second vertex that may be connected.

Returns:

The edge that connects the first and second vertices.

Throws:

InvalidVertexException - Thrown when either vertex is invalid.

NoSuchEdgeException - Thrown when no edge connects the vertices.

edges

java.util.Iterator<CS16Edge<V>> edges()

Returns an iterator holding all the edges of the graph.

Returns:

an Iterator containing the edges of the Graph.

endVertices

java.util.List<CS16Vertex<V>> endVertices(CS16Edge<V> edge)
                                   throws InvalidEdgeException

Returns the two Vertices that the Edge e is connected to.

Parameters:

edge - The edge to find the connecting Vertex's on.

Returns:

A list of Vertex's holding the two connecting vertices.

Throws:

InvalidEdgeException - Thrown when the Edge e is not valid.

incomingEdges

java.util.Iterator<CS16Edge<V>> incomingEdges(CS16Vertex<V> vert)
                                       throws InvalidVertexException

Returns an Iterator over all the Edges that end on this Vertex.

Parameters:

vert - The vertex to find the incoming edges on.

Returns:

an Iterator holding the incoming edges on vert.

Throws:

InvalidVertexException - Thrown when the Vertex is not valid.

outgoingEdges

java.util.Iterator<CS16Edge<V>> outgoingEdges(CS16Vertex<V> vert)
                                       throws InvalidVertexException

Returns an Iterator over all the Edges that start at this Vertex.

Parameters:

vert - The vertex to find the outgoing edges on.

Returns:

an Iterator holding the outgoing edges on vert.

Throws:

InvalidVertexException - Thrown when the Vertex is not valid.

insertEdge

CS16Edge<V> insertEdge(CS16Vertex<V> v1,
                       CS16Vertex<V> v2,
                       java.lang.Integer edgeElement)

Inserts a new Edge into your Graph.

Parameters:

v1 - The first vertex of the edge connection.

v2 - The second vertex of the edge connection.

edgeElement - The element of the newly inserted edge. For an unweighted edge, use null element.

Returns:

the newly inserted Edge.

Throws:

InvalidVertexException - Thrown when the Vertex is not valid.

insertVertex

CS16Vertex<V> insertVertex(V vertElement)

Inserts a vertex into the graph.

Parameters:

vertElement - The element of the inserted Vertex.

Returns:

the newly inserted Vertex.

opposite

CS16Vertex<V> opposite(CS16Vertex<V> vert,
                       CS16Edge<V> edge)
                throws InvalidVertexException,
                       InvalidEdgeException,
                       NoSuchVertexException

Returns the Vertex that is on the other side of Edge e opposite of Vertex v. If the edge is not incoming or outgoing on v, then throw a NoSuchVertexException.

Parameters:

vert - The first vertex on Edge e.

edge - The edge connecting Vertex v and the unknown opposite Vertex.

Returns:

The opposite Vertex of v across Edge e.

Throws:

InvalidVertexException - Thrown when the Vertex is not valid.

InvalidEdgeException - Thrown when the Edge is not valid.

NoSuchVertexException - Thrown when Edge e is not incident on v.

removeEdge

java.lang.Integer removeEdge(CS16Edge<V> edge)
                      throws InvalidEdgeException

Removes an Edge from your Graph.

Parameters:

edge - The Edge to remove.

Returns:

The element of the removed Edge.

Throws:

InvalidEdgeException - Thrown when the Edge is not valid.

removeVertex

V removeVertex(CS16Vertex<V> vert)
        throws InvalidVertexException

Removes a Vertex from your graph.

Parameters:

vert - The Vertex to remove.

Returns:

The element of the removed Vertex.

Throws:

InvalidVertexException - Thrown when the Vertex is not valid.

vertices

java.util.Iterator<CS16Vertex<V>> vertices()

Returns an iterator holding all the Vertices of the graph.

Returns:

an Iterator containing the vertices of the Graph.