Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.cuspy.pathfinder
Interface Node

public interface Node

The Node interface must be implemented by classes that want a PathFinder to find paths over them.

Method Summary
 java.util.Collection getNeighbors()
          Returns the neighbors of this node in the form of a Collection.
 double getPathCostEstimate(Node goal)
          Returns the estimate of the cost to get from this node to the goal node.
 double getTraverseCost(Node dest)
          Returns the cost to get from this node to the dest node.
 

Method Detail

getPathCostEstimate

public double getPathCostEstimate(Node goal)
Returns the estimate of the cost to get from this node to the goal node. If unable to estimate, it is safe to return 0 or underestimate. Overestimates can result in failures to find a path.

Returns:
the estimate.

getTraverseCost

public double getTraverseCost(Node dest)
Returns the cost to get from this node to the dest node.

Returns:
the cost.

getNeighbors

public java.util.Collection getNeighbors()
Returns the neighbors of this node in the form of a Collection.

Returns:
the neighbors.
Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD