org.opentripplanner.transit.raptor.rangeraptor.multicriteria.StopArrivals 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.rangeraptor.multicriteria;


import java.util.BitSet;
import java.util.List;
import org.opentripplanner.transit.raptor.api.transit.IntIterator;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripSchedule;
import org.opentripplanner.transit.raptor.rangeraptor.debug.DebugHandlerFactory;
import org.opentripplanner.transit.raptor.rangeraptor.multicriteria.arrivals.AbstractStopArrival;
import org.opentripplanner.transit.raptor.rangeraptor.path.DestinationArrivalPaths;
import org.opentripplanner.transit.raptor.rangeraptor.transit.EgressPaths;
import org.opentripplanner.transit.raptor.util.BitSetIterator;


/**
 * This class serve as a wrapper for all stop arrival pareto set, one set for each stop.
 * It also keep track of stops visited since "last mark".
 * 
 *
 *
 * @param  The TripSchedule type defined by the user of the raptor API.
 */
public final class StopArrivals {
    private final StopArrivalParetoSet[] arrivals;
    private final BitSet touchedStops;
    private final DebugHandlerFactory debugHandlerFactory;
    private final DebugStopArrivalsStatistics debugStats;

    /**
     * Set the time at a transit index iff it is optimal. This sets both the best time and the transfer time
     */
    public StopArrivals(
            int nStops,
            EgressPaths egressPaths,
            DestinationArrivalPaths paths,
            DebugHandlerFactory debugHandlerFactory
    ) {
        //noinspection unchecked
        this.arrivals = (StopArrivalParetoSet[]) new StopArrivalParetoSet[nStops];
        this.touchedStops = new BitSet(nStops);
        this.debugHandlerFactory = debugHandlerFactory;
        this.debugStats = new DebugStopArrivalsStatistics(debugHandlerFactory.debugLogger());

        glueTogetherEgressStopWithDestinationArrivals(egressPaths, paths);
    }

    boolean updateExist() {
        return !touchedStops.isEmpty();
    }

    IntIterator stopsTouchedIterator() {
        return new BitSetIterator(touchedStops);
    }

    void addStopArrival(AbstractStopArrival arrival) {
        boolean added = findOrCreateSet(arrival.stop()).add(arrival);
        if (added) {
            touchedStops.set(arrival.stop());
        }
    }

    void debugStateInfo() {
        debugStats.debugStatInfo(arrivals);
    }

    /** List all transits arrived this round. */
    Iterable> listArrivalsAfterMarker(final int stop) {
        StopArrivalParetoSet it = arrivals[stop];
        if(it==null) {
            return List.of();
        }
        return it.elementsAfterMarker();
    }

    void clearTouchedStopsAndSetStopMarkers() {
        IntIterator it = stopsTouchedIterator();
        while (it.hasNext()) {
            arrivals[it.next()].markAtEndOfSet();
        }
        touchedStops.clear();
    }


    /* private methods */

    private StopArrivalParetoSet findOrCreateSet(final int stop) {
        if(arrivals[stop] == null) {
            arrivals[stop] = StopArrivalParetoSet.createStopArrivalSet(stop, debugHandlerFactory);
        }
        return arrivals[stop];
    }

    /**
     * This method creates a ParetoSet for the given egress stop. When arrivals are added to the
     * stop, the "glue" make sure new destination arrivals is added to the destination arrivals.
     */
    private void glueTogetherEgressStopWithDestinationArrivals(
            EgressPaths egressPaths,
            DestinationArrivalPaths paths
    ) {
        egressPaths.byStop().forEachEntry((stop, list) -> {
            // The factory is creating the actual "glue"
            this.arrivals[stop] = StopArrivalParetoSet.createEgressStopArrivalSet(
                    stop, list, paths, debugHandlerFactory
            );
            return true;
        });
    }
}