org.opentripplanner.routing.algorithm.strategies

Interface RemainingWeightHeuristic

All Superinterfaces:

Serializable

All Known Implementing Classes:

EuclideanRemainingWeightHeuristic, InterleavedBidirectionalHeuristic, TrivialRemainingWeightHeuristic

public interface RemainingWeightHeuristic
extends Serializable

Interface for classes that provides an admissible estimate of (lower bound on) the weight of a path to the target, starting from a given state.

Method Summary

Modifier and Type	Method and Description
void	doSomeWork() Call to cause the heuristic to perform some predetermined amount of work improving its estimate.
double	estimateRemainingWeight(State s)
void	initialize(RoutingRequest options, long abortTime) Perform any one-time setup and pre-computation that will be needed by later calls to computeForwardWeight/computeReverseWeight.
void	reset() Reset any cached data in the heuristic, before reuse in a search with the same destination.

Method Detail

initialize

void initialize(RoutingRequest options,
                long abortTime)

Perform any one-time setup and pre-computation that will be needed by later calls to computeForwardWeight/computeReverseWeight. We may want to start from multiple origin states, so initialization cannot depend on the origin vertex or state.

Parameters:

abortTime - time since the Epoch in milliseconds at which we should bail out of initialization, or Long.MAX_VALUE for no limit.

estimateRemainingWeight

double estimateRemainingWeight(State s)

reset

void reset()

Reset any cached data in the heuristic, before reuse in a search with the same destination.

doSomeWork

void doSomeWork()

Call to cause the heuristic to perform some predetermined amount of work improving its estimate. Avoids thread synchronization evil by interleaving forward and backward searches.