org.opentripplanner.transit.raptor.api.view.Heuristics Maven / Gradle / Ivy

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

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.5.0

package org.opentripplanner.transit.raptor.api.view;


/**
 * The heuristics is used in the multi-criteria search and can be generated using the standard
 * search. This interface decople these two implementations and make it possible to implement
 * more than one heuristics data provider.
 */
public interface Heuristics {
    /**
     * Is the stop reached by the heuristic search?
     */
    boolean reached(int stop);

    /**
     * The best overall travel duration from origin to the given stop.
     */
    int bestTravelDuration(int stop);

    /**
     * To plot or debug the travel duration.
     * @param unreached set all unreached values to this value
     */
    int[] bestTravelDurationToIntArray(int unreached);

    /**
     * The best number of transfers to reach the given stop.
     */
    int bestNumOfTransfers(int stop);

    /**
     * To plot or debug the number of transfers.
     * @param unreached set all unreached values to this value
     */
    int[] bestNumOfTransfersToIntArray(int unreached);

    /**
     * The number of stops in the heuristics. This include all stops also stops not reached.
     */
    int size();

    /**
     * Return the best/minimum required time to travel from origin to destination.
     */
    int bestOverallJourneyTravelDuration();

    /**
     * Return the best/minimum required number of transfers from origin to destination.
     */
    int bestOverallJourneyNumOfTransfers();

    /**
     * Return true if the destination is reached.
     */
    boolean destinationReached();
}