1 package cz.cuni.amis.utils.astar;
2
3 /**
4 * This is an interface containing a method for computing the {@link AStar} heuristic. That means the estimation
5 * how far the goal is from some node that is currently being visited by {@link AStar}.
6 *
7 * @author Jimmy
8 *
9 * <p><p>
10 * Use amis-path-finding library instead, see svn://artemis.ms.mff.cuni.cz/pogamut/trunk/project/Utils/AmisPathFinding
11 */
12 @Deprecated
13 public interface AStarHeuristic<NODE> {
14
15 /**
16 * This is heuristic function.
17 * <p><p>
18 * <b>WARNING:</b>
19 * <p><p>
20 * This heuristic must be correct for A* to work correctly, that means
21 * the returned distance must be smaller or equal to the real distance
22 * and must be monotonic. (In 2D, 3D an euclidean metric will do the job).
23 *
24 * @return how far is to the goal from the node
25 */
26 public int getEstimatedDistanceToGoal(NODE node);
27
28 }