org.opentripplanner.transit.raptor.service.HeuristicSearchTask 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.service;

import org.opentripplanner.transit.raptor.api.request.RaptorRequest;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripSchedule;
import org.opentripplanner.transit.raptor.api.request.SearchDirection;
import org.opentripplanner.transit.raptor.api.transit.RaptorTransitDataProvider;
import org.opentripplanner.transit.raptor.api.view.Heuristics;
import org.opentripplanner.transit.raptor.rangeraptor.configure.RaptorConfig;
import org.opentripplanner.transit.raptor.rangeraptor.standard.heuristics.HeuristicSearch;
import org.opentripplanner.transit.raptor.util.TimeUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.opentripplanner.transit.raptor.api.request.RaptorProfile.NO_WAIT_BEST_TIME;

/**
 * Thin wrapper around a {@link HeuristicSearch} to allow for some small additional features.
 * This is mostly to extracted some "glue" out of the {@link RangRaptorDynamicSearch} to make that
 * simpler and let it focus on the main bossiness logic.
 *
 * This class is not meant for reuse, create one task for each potential heuristic search.
 * The task must be {@link #enable()}d before it is {@link #run()}.
 */
public class HeuristicSearchTask {
    private static final Logger LOG = LoggerFactory.getLogger(HeuristicSearchTask.class);

    private final SearchDirection direction;
    private final String name;
    private final RaptorConfig config;
    private final RaptorTransitDataProvider transitData;

    private boolean run = false;
    private HeuristicSearch search = null;
    private RaptorRequest request;

    public HeuristicSearchTask(
            RaptorRequest request,
            RaptorConfig config,
            RaptorTransitDataProvider transitData
    ) {
        this(
                request.searchDirection(),
                RequestAlias.alias(request, config.isMultiThreaded()),
                config,
                transitData
        );
        this.request = request;
    }

    public HeuristicSearchTask(
            SearchDirection direction,
            String name,
            RaptorConfig config,
            RaptorTransitDataProvider transitData
    ) {
        this.direction = direction;
        this.name = name;
        this.config = config;
        this.transitData = transitData;
    }

    public String name() {
        return name;
    }

    public void enable() {
        this.run = true;
    }

    public boolean isEnabled() {
        return run;
    }

    public SearchDirection getDirection() {
        return direction;
    }

    public HeuristicSearch search() {
        return search;
    }

    public Heuristics result() {
        return search == null ? null : search.heuristics();
    }

    public HeuristicSearchTask withRequest(RaptorRequest request) {
        this.request = request.mutate()
                .searchParams()
                .build();
        return this;
    }

    public void forceRun() {
        enable();
        run();
    }

    public void debugCompareResult(HeuristicSearchTask other) {
        if(!isEnabled() || !other.isEnabled()) { return; }
        DebugHeuristics.debug(
                name(), result(),
                other.name(), other.result(),
                request
        );
    }

    /**
     * @throws DestinationNotReachedException if destination is not reached
     */
    void run() {
        if (!run) { return; }

        long start = System.currentTimeMillis();

        createHeuristicSearchIfNotExist(request);

        search.route();

        if(!search.destinationReached()) {
            throw new DestinationNotReachedException();
        }
        if(LOG.isDebugEnabled()) {
            String time = TimeUtils.msToSecondsStr(System.currentTimeMillis() - start);
            LOG.debug("RangeRaptor - {} heuristic search performed in {}.", name, time);
        }
    }

    private void createHeuristicSearchIfNotExist(RaptorRequest request) {
        if(search == null) {
            RaptorRequest heuristicReq = request
                    .mutate()
                    // Disable any optimization that is not valid for a heuristic search
                    .clearOptimizations()
                    .profile(NO_WAIT_BEST_TIME)
                    .searchDirection(direction)
                    .searchParams()
                    .searchOneIterationOnly()
                    .build();
            search = config.createHeuristicSearch(transitData, heuristicReq);
        }
    }
}