org.kynosarges.tektosyne.graph

Interface GraphPath<T>

Type Parameters:

T - the type of all nodes in the Graph

All Known Implementing Classes:

AStar

public interface GraphPath<T>

Represents the path of a GraphAgent across a Graph. Also provides the total path cost and the last node reachable with a given maximum cost.

Method Summary

Modifier and Type	Method and Description
T	getLastNode(double maxCost) Gets the last GraphPath node reachable within the specified maximum cost.
java.util.List<T>	nodes() Gets all Graph nodes in the GraphPath.
double	totalCost() Gets the total cost of the GraphPath.

Method Detail

nodes

java.util.List<T> nodes()

Gets all Graph nodes in the GraphPath. Never returns null, but may return an empty List.

Returns:

a List of all Graph nodes in the GraphPath

totalCost

double totalCost()

Gets the total cost of the GraphPath. May return a non-positive value if nodes() is empty.

Returns:

the sum of the GraphAgent.getStepCost(T, T) results for all nodes()

getLastNode

T getLastNode(double maxCost)

Gets the last GraphPath node reachable within the specified maximum cost.

Parameters:

maxCost - the maximum total path cost

Returns:

the last nodes() element whose total path cost does not exceed maxCost

Throws:

java.lang.IllegalArgumentException - if maxCost is equal to or less than zero

java.lang.IllegalStateException - if the GraphPath contains invalid data