pathfinder.IGraphSearch Interface Reference

Inheritance diagram for pathfinder.IGraphSearch:

Public Member Functions
LinkedList< GraphNode >	search (int startID, int targetID)
LinkedList< GraphNode >	search (int startID, int targetID, boolean remember)
GraphEdge[]	getExaminedEdges ()
public< T > T[]	getExaminedEdges (T[] array)
GraphNode[]	getRoute ()
public< T > T[]	getRoute (T[] array)

Detailed Description

Any class that can be used to search the graph should implement this class.

Author

Peter Lager

Member Function Documentation

getExaminedEdges() [1/2]

GraphEdge[] pathfinder.IGraphSearch.getExaminedEdges

(

)

Get all the edges examined during the search.

Returns

edges examined or array size 0 if none found

Implemented in pathfinder.GraphSearch_Astar, pathfinder.GraphSearch_BFS, pathfinder.GraphSearch_DFS, and pathfinder.GraphSearch_Dijkstra.

getExaminedEdges() [2/2]

public< T > T[] pathfinder.IGraphSearch.getExaminedEdges

(

T[]

array

)

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

array

the array to populate

Returns

edges examined or array size 0 if none found

getRoute() [1/2]

GraphNode[] pathfinder.IGraphSearch.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

Implemented in pathfinder.GraphSearch_Astar, pathfinder.GraphSearch_BFS, pathfinder.GraphSearch_DFS, and pathfinder.GraphSearch_Dijkstra.

getRoute() [2/2]

public< T > T[] pathfinder.IGraphSearch.getRoute

(

T[]

array

)

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

array

the array to populate

Returns

path found or array size 0 if none found

search() [1/2]

LinkedList< GraphNode > pathfinder.IGraphSearch.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

startID	id of the start node
targetID	id of the target node

Returns

the route as a list of nodes

Implemented in pathfinder.GraphSearch_Astar, pathfinder.GraphSearch_BFS, pathfinder.GraphSearch_DFS, and pathfinder.GraphSearch_Dijkstra.

search() [2/2]

LinkedList< GraphNode > pathfinder.IGraphSearch.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

startID	id of the start node
targetID	id of the target node
remember	whether to remember the examined edges.

Returns

the route as a list of nodes

Implemented in pathfinder.GraphSearch_Astar, pathfinder.GraphSearch_BFS, pathfinder.GraphSearch_DFS, and pathfinder.GraphSearch_Dijkstra.

---

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

• /Users/peter/git/path-finder-repos/Path Finder/src/pathfinder/IGraphSearch.java