com.salesforce.jgrapht.alg.interfaces.AStarAdmissibleHeuristic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of AptSpringProcessor Show documentation

This project contains the apt processor that implements all the checks enumerated in @Verify. It is a self contained, and shaded jar.

There is a newer version: 2.0.7

Show newest version

/*
 * (C) Copyright 2015-2017, by Joris Kinable, Jon Robison, Thomas Breitbart and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * This program and the accompanying materials are dual-licensed under
 * either
 *
 * (a) the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation, or (at your option) any
 * later version.
 *
 * or (per the licensee's choosing)
 *
 * (b) the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation.
 */
package com.salesforce.jgrapht.alg.interfaces;

/**
 * Interface for an admissible heuristic used in A* search.
 *
 * @param  vertex type
 *
 * @author Joris Kinable
 * @author Jon Robison
 * @author Thomas Breitbart
 */
public interface AStarAdmissibleHeuristic
{
    /**
     * An admissible "heuristic estimate" of the distance from x, the sourceVertex, to the goal
     * (usually denoted h(x)). This is the good guess function which must never overestimate the
     * distance.
     * 
     * @param sourceVertex the source vertex
     * @param targetVertex the target vertex
     * 
     * @return an estimate of the distance from the source to the target vertex
     */
    double getCostEstimate(V sourceVertex, V targetVertex);

}

// End AStarAdmissibleHeuristic.java