Class SpyGraph

java.lang.Object

SpyGraph

All Implemented Interfaces:

java.lang.Iterable<GraphNode>

public class SpyGraph
extends java.lang.Object
implements java.lang.Iterable<GraphNode>

Stores all vertexes as a list of GraphNodes. Provides necessary graph operations as need by the SpyGame class.

Constructor Summary

Constructors

Constructor and Description
SpyGraph() Initializes an empty list of GraphNode objects

Method Summary

Modifier and Type	Method and Description
void	addEdge(java.lang.String v1name, java.lang.String v2name, int cost) Adds v2 as a neighbor of v1 and adds v1 as a neighbor of v2.
void	addGraphNode(java.lang.String name) Add a vertex with this label to the list of vertexes.
java.util.List<Neighbor>	BFS(java.lang.String start, java.lang.String end) Return Breadth First Search list of nodes on path from one Node to another.
java.util.List<Neighbor>	DFS(java.lang.String start, java.lang.String end) Return Depth First Search list of nodes on path from one Node to another.
java.util.List<Neighbor>	Dijkstra(java.lang.String start, java.lang.String end) OPTIONAL: Students are not required to implement Dijkstra's ALGORITHM Return Dijkstra's shortest path list of nodes on path from one Node to another.
GraphNode	getNodeFromName(java.lang.String name)
GraphNode	getRandomNode() DO NOT EDIT THIS METHOD
java.util.Iterator<GraphNode>	iterator() Return an iterator through all nodes in the SpyGraph

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SpyGraph

public SpyGraph()

Initializes an empty list of GraphNode objects

Method Detail

addGraphNode

public void addGraphNode(java.lang.String name)

Add a vertex with this label to the list of vertexes. No duplicate vertex names are allowed.

Parameters:

name - The name of the new GraphNode to create and add to the list.

addEdge

public void addEdge(java.lang.String v1name,
                    java.lang.String v2name,
                    int cost)
             throws java.lang.IllegalArgumentException

Adds v2 as a neighbor of v1 and adds v1 as a neighbor of v2. Also sets the cost for each neighbor pair.

Parameters:

v1name - The name of the first vertex of this edge

v2name - The name of second vertex of this edge

cost - The cost of traveling to this edge

Throws:

java.lang.IllegalArgumentException - if the names are the same

iterator

public java.util.Iterator<GraphNode> iterator()

Return an iterator through all nodes in the SpyGraph

Specified by:

iterator in interface java.lang.Iterable<GraphNode>

Returns:

iterator through all nodes in alphabetical order.

BFS

public java.util.List<Neighbor> BFS(java.lang.String start,
                                    java.lang.String end)

Return Breadth First Search list of nodes on path from one Node to another.

Parameters:

start - First node in BFS traversal

end - Last node (match node) in BFS traversal

Returns:

The BFS traversal from start to end node.

getNodeFromName

public GraphNode getNodeFromName(java.lang.String name)

Parameters:

name - Name corresponding to node to be returned

Returns:

GraphNode associated with name, null if no such node exists

DFS

public java.util.List<Neighbor> DFS(java.lang.String start,
                                    java.lang.String end)

Return Depth First Search list of nodes on path from one Node to another.

Parameters:

start - First node in DFS traversal

end - Last node (match node) in DFS traversal

Returns:

The DFS traversal from start to end node.

Dijkstra

public java.util.List<Neighbor> Dijkstra(java.lang.String start,
                                         java.lang.String end)

OPTIONAL: Students are not required to implement Dijkstra's ALGORITHM Return Dijkstra's shortest path list of nodes on path from one Node to another.

Parameters:

start - First node in path

end - Last node (match node) in path

Returns:

The shortest cost path from start to end node.

getRandomNode

public GraphNode getRandomNode()

DO NOT EDIT THIS METHOD

Returns:

a random node from this graph