org.opentripplanner.routing.algorithm.raptoradapter.transit.request.TripPatternForDates 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.routing.algorithm.raptoradapter.transit.request;

import java.util.Arrays;
import java.util.List;
import java.util.function.IntUnaryOperator;
import org.opentripplanner.model.base.ToStringBuilder;
import org.opentripplanner.routing.algorithm.raptoradapter.transit.TripPatternForDate;
import org.opentripplanner.routing.algorithm.raptoradapter.transit.TripPatternWithRaptorStopIndexes;
import org.opentripplanner.routing.algorithm.raptoradapter.transit.TripSchedule;
import org.opentripplanner.routing.algorithm.raptoradapter.transit.frequency.TripFrequencyAlightSearch;
import org.opentripplanner.routing.algorithm.raptoradapter.transit.frequency.TripFrequencyBoardSearch;
import org.opentripplanner.transit.raptor.api.request.SearchDirection;
import org.opentripplanner.transit.raptor.api.transit.IntIterator;
import org.opentripplanner.transit.raptor.api.transit.RaptorConstrainedTripScheduleBoardingSearch;
import org.opentripplanner.transit.raptor.api.transit.RaptorRoute;
import org.opentripplanner.transit.raptor.api.transit.RaptorTimeTable;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripPattern;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripScheduleSearch;
import org.opentripplanner.transit.raptor.util.IntIterators;

/**
 * A collection of all the TripSchedules active on a range of consecutive days. The outer list of tripSchedulesByDay
 * refers to days in order.
 */
public class TripPatternForDates
        implements
                RaptorRoute,
                RaptorTimeTable,
                RaptorTripPattern
{

    private final TripPatternWithRaptorStopIndexes tripPattern;

    private final TripPatternForDate[] tripPatternForDates;

    private final int[] offsets;

    private final int numberOfTripSchedules;

    private final boolean isFrequencyBased;

    /**
     * The arrival times in a nStops * numberOfTripSchedules sized array. The trips are stored first
     * by the stop position and then by trip index, so with stops 1 and 2, and trips A and B, the
     * order is [1A, 1B, 2A, 2B]
     */
    private final int[] arrivalTimes;

    /**
     * The arrival times in a nStops * numberOfTripSchedules sized array. The order is the same as
     * in arrivalTimes.
     */
    private final int[] departureTimes;

    TripPatternForDates(
            TripPatternWithRaptorStopIndexes tripPattern,
            List tripPatternForDates,
            List offsets
    ) {
        this.tripPattern = tripPattern;
        this.tripPatternForDates = tripPatternForDates.toArray(new TripPatternForDate[]{});
        this.offsets = offsets.stream().mapToInt(i -> i).toArray();

        int numberOfTripSchedules = 0;
        boolean hasFrequencies = false;
        for (TripPatternForDate tripPatternForDate : tripPatternForDates) {
            numberOfTripSchedules += tripPatternForDate.numberOfTripSchedules();
            if (tripPatternForDate.hasFrequencies()) {
                hasFrequencies = true;
            }
        }
        this.numberOfTripSchedules = numberOfTripSchedules;
        this.isFrequencyBased = hasFrequencies;

        final int nStops = tripPattern.getStopIndexes().length;
        this.arrivalTimes = new int[nStops * numberOfTripSchedules];
        this.departureTimes = new int[nStops * numberOfTripSchedules];
        int i = 0;
        for (int d = 0; d < tripPatternForDates.size(); d++) {
            int offset = this.offsets[d];
            for (var trip : tripPatternForDates.get(d).tripTimes()) {
                for (int s = 0; s < nStops; s++) {
                    this.arrivalTimes[s * numberOfTripSchedules + i] = trip.getArrivalTime(s) + offset;
                    this.departureTimes[s * numberOfTripSchedules + i] = trip.getDepartureTime(s) + offset;
                }
                i++;
            }
        }
    }

    public TripPatternWithRaptorStopIndexes getTripPattern() {
        return tripPattern;
    }


    /* Support for frequency based routing */

    public IntIterator tripPatternForDatesIndexIterator(boolean ascendingOnDate) {
        return ascendingOnDate
            ? IntIterators.intIncIterator(0, tripPatternForDates.length)
            : IntIterators.intDecIterator(tripPatternForDates.length, 0);
    }

    public TripPatternForDate tripPatternForDate(int index) {
        return tripPatternForDates[index];
    }

    /**
     * @deprecated This is exposed because it is needed in the TripFrequencyNnnSearch classes,
     *             but is realy an implementation detail that should not leak outside the class.
     */
    @Deprecated
    public int tripPatternForDateOffsets(int index) {
        return offsets[index];
    }

    // Implementing RaptorRoute
    @Override
    public RaptorTimeTable timetable() {
        return this;
    }

    @Override
    public RaptorTripPattern pattern() {
        return this;
    }

    @Override
    public RaptorConstrainedTripScheduleBoardingSearch transferConstraintsForwardSearch() {
        return getTripPattern().constrainedTransferForwardSearch();
    }

    @Override
    public RaptorConstrainedTripScheduleBoardingSearch transferConstraintsReverseSearch() {
        return getTripPattern().constrainedTransferReverseSearch();
    }

    // Implementing RaptorTripPattern

    @Override public int stopIndex(int stopPositionInPattern) {
        return tripPattern.stopIndex(stopPositionInPattern);
    }

    @Override
    public boolean boardingPossibleAt(int stopPositionInPattern) {
        return tripPattern.getPattern().canBoard(stopPositionInPattern);
    }

    @Override
    public boolean alightingPossibleAt(int stopPositionInPattern) {
        return tripPattern.getPattern().canAlight(stopPositionInPattern);
    }

    @Override public int numberOfStopsInPattern() {
        return tripPattern.getStopIndexes().length;
    }

    @Override
    public String debugInfo() {
        return tripPattern.getTransitMode().name() + " " + tripPattern.getPattern().getRoute().getShortName();
    }


    // Implementing RaptorTimeTable

    @Override public TripSchedule getTripSchedule(int index) {
        for (int i = 0; i < tripPatternForDates.length; i++) {
            TripPatternForDate tripPatternForDate = tripPatternForDates[i];

            if (index < tripPatternForDate.numberOfTripSchedules()) {
                return new TripScheduleWithOffset(this, tripPatternForDate.getLocalDate(),
                        tripPatternForDate.getTripTimes(index), offsets[i]);
            }
            index -= tripPatternForDate.numberOfTripSchedules();
        }
        throw new IndexOutOfBoundsException("Index out of bound: " + index);
    }

    @Override
    public IntUnaryOperator getArrivalTimes(int stopPositionInPattern) {
        final int base = stopPositionInPattern * numberOfTripSchedules;
        return (int i) -> arrivalTimes[base + i];
    }

    @Override
    public IntUnaryOperator getDepartureTimes(int stopPositionInPattern) {
        final int base = stopPositionInPattern * numberOfTripSchedules;
        return (int i) -> departureTimes[base + i];
    }

    @Override public int numberOfTripSchedules() {
        return numberOfTripSchedules;
    }

    @Override
    public boolean useCustomizedTripSearch() {
        return isFrequencyBased;
    }

    @Override
    public RaptorTripScheduleSearch createCustomizedTripSearch(
            SearchDirection direction
    ) {
        return direction.isForward()
                ? new TripFrequencyBoardSearch<>(this)
                : new TripFrequencyAlightSearch<>(this);
    }

    @Override
    public String toString() {
        return ToStringBuilder.of(TripPatternForDates.class)
                .addObj("pattern", debugInfo())
                .addServiceTimeSchedule("offsets", offsets)
                .addNum("nTrips", numberOfTripSchedules)
                .toString();
    }
}