AI for Games 1.1.1
Loading...
Searching...
No Matches
game2dai.graph.GraphSearch_DFS Class Reference
Inheritance diagram for game2dai.graph.GraphSearch_DFS:

Public Member Functions

 GraphSearch_DFS (Graph graph)
 
LinkedList< GraphNodesearch (int startID, int targetID)
 
LinkedList< GraphNodesearch (int startID, int targetID, boolean remember)
 
GraphEdge[] getExaminedEdges ()
 
GraphNode[] getRoute ()
 
LinkedList< GraphNodesearch (int startID, int targetID)
 
LinkedList< GraphNodesearch (int startID, int targetID, boolean remember)
 
GraphEdge[] getExaminedEdges ()
 
public< T > T[] getExaminedEdges (T[] array)
 
GraphNode[] getRoute ()
 
public< T > T[] getRoute (T[] array)
 

Protected Member Functions

 GraphSearch_DFS ()
 

Protected Attributes

Graph graph
 
HashSet< Integer > visited
 
HashMap< Integer, Integer > settledNodes
 
Stack< GraphEdgestack
 
LinkedList< GraphNoderoute
 
HashSet< GraphEdgeexaminedEdges
 

Package Functions

public< T > T[] getExaminedEdges (T[] array)
 
public< T > T[] getRoute (T[] array)
 

Private Member Functions

void clear ()
 

Constructor & Destructor Documentation

◆ GraphSearch_DFS() [1/2]

game2dai.graph.GraphSearch_DFS.GraphSearch_DFS ( )
protected

Prevent creating an object without a graph

◆ GraphSearch_DFS() [2/2]

game2dai.graph.GraphSearch_DFS.GraphSearch_DFS ( Graph  graph)

Create a search object that uses depth first search algorithm for the given graph.

Parameters
graphthe graph to use

Member Function Documentation

◆ clear()

void game2dai.graph.GraphSearch_DFS.clear ( )
private

Clears all data related to a search so this object can be reused for another search

◆ getExaminedEdges() [1/2]

GraphEdge[] game2dai.graph.GraphSearch_DFS.getExaminedEdges ( )

Get all the edges examined during the search.

Returns
edges examined or array size 0 if none found

Implements game2dai.graph.IGraphSearch.

◆ getExaminedEdges() [2/2]

public< T > T[] game2dai.graph.GraphSearch_DFS.getExaminedEdges ( T[]  array)
package

Get all the edges examined during the search.
The type of each element in the array will be of type Object if the parameter is null otherwise it is T (where T is GraphEdge or any class that extends GraphEdge.

Parameters
arraythe array to populate
Returns
edges examined or array size 0 if none found

Implements game2dai.graph.IGraphSearch.

◆ getRoute() [1/2]

GraphNode[] game2dai.graph.GraphSearch_DFS.getRoute ( )

Get the path found as an array of GraphNode(s) in start->end order

Returns
path found or array size 0 if none found

Implements game2dai.graph.IGraphSearch.

◆ getRoute() [2/2]

public< T > T[] game2dai.graph.GraphSearch_DFS.getRoute ( T[]  array)
package

Get the path found as an array of T(s) in start->end order.
The type of each element in the array will be of type Object if the parameter is null otherwise it is T (where T is GraphNode or any class that extends GraphNode.

Parameters
arraythe array to populate
Returns
path found or array size 0 if none found

Implements game2dai.graph.IGraphSearch.

◆ search() [1/2]

LinkedList< GraphNode > game2dai.graph.GraphSearch_DFS.search ( int  startID,
int  targetID 
)

Search for a route from node startID and ends at targetID.
This will return a linkedlist of the nodes that make up the route from start to end order.
If either the start or target node does not exist or if a route can't be found the returned list is empty.

Parameters
startIDid of the start node
targetIDid of the target node
Returns
the route as a list of nodes

Implements game2dai.graph.IGraphSearch.

◆ search() [2/2]

LinkedList< GraphNode > game2dai.graph.GraphSearch_DFS.search ( int  startID,
int  targetID,
boolean  remember 
)

Search for a route from node startID and ends at targetID.
This will return a linkedlist of the nodes that make up the route from start to end order.
If either the start or target node does not exist or if a route can't be found the returned list is empty.

Parameters
startIDid of the start node
targetIDid of the target node
rememberwhether to remember the examined edges.
Returns
the route as a list of nodes

Implements game2dai.graph.IGraphSearch.

Member Data Documentation

◆ examinedEdges

HashSet<GraphEdge> game2dai.graph.GraphSearch_DFS.examinedEdges
protected

Used to remember examined edges

◆ route

LinkedList<GraphNode> game2dai.graph.GraphSearch_DFS.route
protected

List for routes nodes in order of travel

◆ settledNodes

HashMap<Integer, Integer> game2dai.graph.GraphSearch_DFS.settledNodes
protected

Remember the route found to from

◆ stack

Stack<GraphEdge> game2dai.graph.GraphSearch_DFS.stack
protected

Stack of graph edges to consider

◆ visited

HashSet<Integer> game2dai.graph.GraphSearch_DFS.visited
protected

Used to remember which nodes had been visited


The documentation for this class was generated from the following file: