org.opentripplanner.routing.algorithm.filterchain.deletionflagger.NonTransitGeneralizedCostFilter 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.filterchain.deletionflagger;

import java.util.stream.Collectors;
import org.opentripplanner.model.plan.Itinerary;

import java.util.List;
import java.util.OptionalDouble;
import java.util.function.DoubleFunction;

/**
 * This filter is similar to {@link TransitGeneralizedCostFilter}. There are some important
 * differences, however. It will only remove non-transit results, but ALL results can be used as
 * a basis for computing the cost limit.
 *
 * This is needed so that we do not for example get walk legs that last several hours, when transit
 * can take you to the destination much quicker.
 * 
 * @see org.opentripplanner.routing.api.request.ItineraryFilterParameters#nonTransitGeneralizedCostLimit
 */
public class NonTransitGeneralizedCostFilter implements ItineraryDeletionFlagger {
  private final DoubleFunction costLimitFunction;

  public NonTransitGeneralizedCostFilter(DoubleFunction costLimitFunction) {
    this.costLimitFunction = costLimitFunction;
  }

  @Override
  public String name() {
    return "non-transit-cost-filter";
  }

  @Override
  public List getFlaggedItineraries(List itineraries) {
    // ALL itineraries are considered here. Both transit and non-transit
    OptionalDouble minGeneralizedCost = itineraries
        .stream()
        .mapToDouble(it -> it.generalizedCost)
        .min();

    if(minGeneralizedCost.isEmpty()) { return List.of(); }

    final double maxLimit = costLimitFunction.apply(minGeneralizedCost.getAsDouble());

    return itineraries.stream()
        .filter(it -> !it.hasTransit() && it.generalizedCost > maxLimit)
        .collect(Collectors.toList());
  }
}