refactor: Merge ParetoSet and ParetoSetWithMarker

Author: t2gran

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/multicriteria/MultiCriteriaRoutingStrategy.java

@@ -69,7 +69,8 @@ public void prepareForTransitWith(RaptorRoute<T> route) {
   public void prepareForNextStop(int stopIndex, int stopPos) {
     // If no pass-through service exist, this block will be removed by the JIT compiler
     if (passThroughPointsService.isPassThroughPoint(stopIndex)) {
-      for (R ride : patternRides) {
+      for (int i = 0; i < patternRides.size(); ++i) {
+        R ride = patternRides.get(i);
         // Replace existing ride with same ride with the C2 value updated. This only happens if
         // the stop is a pass-through point and the path has visited the pass-through points in the
         // correct order.
@@ -83,7 +84,8 @@ public void prepareForNextStop(int stopIndex, int stopPos) {
 
   @Override
   public void alightOnlyRegularTransferExist(int stopIndex, int stopPos, int alightSlack) {
-    for (R ride : patternRides) {
+    for (int i = 0; i < patternRides.size(); ++i) {
+      R ride = patternRides.get(i);
       state.transitToStop(ride, stopIndex, ride.trip().arrival(stopPos), alightSlack);
     }
   }

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/multicriteria/arrivals/DebugStopArrivalsStatistics.java

@@ -4,7 +4,7 @@
 
 import org.opentripplanner.raptor.api.debug.DebugLogger;
 import org.opentripplanner.raptor.api.debug.DebugTopic;
-import org.opentripplanner.raptor.util.paretoset.ParetoSetWithMarker;
+import org.opentripplanner.raptor.util.paretoset.ParetoSet;
 
 /**
  * Utility class to print some statistics about stop arrivals.
@@ -17,7 +17,7 @@ class DebugStopArrivalsStatistics {
     this.debugLogger = debugLogger;
   }
 
-  void debugStatInfo(ParetoSetWithMarker<?>[] stops) {
+  void debugStatInfo(ParetoSet<?>[] stops) {
     if (!debugLogger.isEnabled()) {
       return;
     }
@@ -27,7 +27,7 @@ void debugStatInfo(ParetoSetWithMarker<?>[] stops) {
     long numOfStops = 0;
     int max = 0;
 
-    for (ParetoSetWithMarker<?> stop : stops) {
+    for (ParetoSet<?> stop : stops) {
       if (stop != null) {
         ++numOfStops;
         total += stop.size();

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/multicriteria/arrivals/McStopArrivals.java

@@ -13,8 +13,8 @@
 import org.opentripplanner.raptor.spi.IntIterator;
 import org.opentripplanner.raptor.util.BitSetIterator;
 import org.opentripplanner.raptor.util.paretoset.ParetoComparator;
+import org.opentripplanner.raptor.util.paretoset.ParetoSet;
 import org.opentripplanner.raptor.util.paretoset.ParetoSetEventListener;
-import org.opentripplanner.raptor.util.paretoset.ParetoSetWithMarker;
 
 /**
  * This class serve as a wrapper for all stop arrival pareto set, one set for each stop. It also
@@ -25,7 +25,7 @@
  */
 public final class McStopArrivals<T extends RaptorTripSchedule> {
 
-  private final ParetoSetWithMarker<McStopArrival<T>>[] arrivals;
+  private final ParetoSet<McStopArrival<T>>[] arrivals;
   private final BitSet touchedStops;
 
   private final DebugHandlerFactory<T> debugHandlerFactory;
@@ -46,14 +46,14 @@ public McStopArrivals(
     DebugHandlerFactory<T> debugHandlerFactory
   ) {
     //noinspection unchecked
-    this.arrivals = (ParetoSetWithMarker<McStopArrival<T>>[]) new ParetoSetWithMarker[nStops];
+    this.arrivals = (ParetoSet<McStopArrival<T>>[]) new ParetoSet[nStops];
     this.touchedStops = new BitSet(nStops);
     this.comparator = comparatorFactory.compareArrivalTimeRoundCostAndOnBoardArrival();
     this.debugHandlerFactory = debugHandlerFactory;
     this.debugStats = new DebugStopArrivalsStatistics(debugHandlerFactory.debugLogger());
 
     for (int stop : arrivalListeners.keys()) {
-      this.arrivals[stop] = new ParetoSetWithMarker<>(comparator, arrivalListeners.get(stop));
+      this.arrivals[stop] = ParetoSet.of(comparator, arrivalListeners.get(stop));
     }
   }
 
@@ -126,9 +126,9 @@ public void clearTouchedStopsAndSetStopMarkers() {
 
   /* private methods */
 
-  private ParetoSetWithMarker<McStopArrival<T>> findOrCreateSet(final int stop) {
+  private ParetoSet<McStopArrival<T>> findOrCreateSet(final int stop) {
     if (arrivals[stop] == null) {
-      arrivals[stop] = new ParetoSetWithMarker<>(
+      arrivals[stop] = ParetoSet.of(
         comparator,
         debugHandlerFactory.paretoSetStopArrivalListener(stop)
       );

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/multicriteria/configure/McRangeRaptorConfig.java

@@ -222,7 +222,7 @@ private HeuristicsProvider<T> createHeuristicsProvider(Heuristics heuristics) {
   private <R extends PatternRide<T>> ParetoSet<R> createPatternRideParetoSet(
     ParetoComparator<R> comparator
   ) {
-    return new ParetoSet<>(comparator, context().debugFactory().paretoSetPatternRideListener());
+    return ParetoSet.of(comparator, context().debugFactory().paretoSetPatternRideListener());
   }
 
   private DestinationArrivalPaths<T> createDestinationArrivalPaths() {

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/path/DestinationArrivalPaths.java

@@ -71,10 +71,7 @@ public DestinationArrivalPaths(
     RaptorStopNameResolver stopNameResolver,
     WorkerLifeCycle lifeCycle
   ) {
-    this.paths = new ParetoSet<>(
-      paretoComparator,
-      debugHandlerFactory.paretoSetDebugPathListener()
-    );
+    this.paths = ParetoSet.of(paretoComparator, debugHandlerFactory.paretoSetDebugPathListener());
     this.transitCalculator = transitCalculator;
     this.costCalculator = costCalculator;
     this.slackProvider = slackProvider;
@@ -138,7 +135,7 @@ public boolean qualify(int departureTime, int arrivalTime, int numberOfTransfers
   }
 
   public Collection<RaptorPath<T>> listPaths() {
-    return paths;
+    return paths.stream().toList();
   }
 
   public void debugReject(ArrivalView<T> stopArrival, RaptorAccessEgress egress, String reason) {

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/standard/besttimes/UnknownPathFactory.java

@@ -58,7 +58,7 @@ private void setIterationDepartureTime(int value) {
   }
 
   public Collection<RaptorPath<T>> extractPaths() {
-    ParetoSet<RaptorPath<T>> paths = new ParetoSet<>(comparator);
+    ParetoSet<RaptorPath<T>> paths = ParetoSet.of(comparator);
     for (RaptorAccessEgress egress : egressPaths) {
       createNewPath(egress).ifPresent(paths::add);
     }

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/support/RouterResultPathAggregator.java

@@ -18,7 +18,7 @@ public RouterResultPathAggregator(
     Collection<RaptorRouterResult<T>> results,
     ParetoComparator<RaptorPath<T>> comparator
   ) {
-    this.paths = new ParetoSet<>(comparator);
+    this.paths = ParetoSet.of(comparator);
     RaptorRouterResult<T> first = null;
     for (var it : results) {
       if (first == null) {
@@ -31,7 +31,7 @@ public RouterResultPathAggregator(
 
   @Override
   public Collection<RaptorPath<T>> extractPaths() {
-    return paths;
+    return paths.stream().toList();
   }
 
   @Override

raptor/src/main/java/org/opentripplanner/raptor/rangeraptor/transit/AccessEgressFunctions.java

@@ -137,14 +137,14 @@ static Collection<RaptorAccessEgress> removeNonOptimalPaths(
     ParetoComparator<RaptorAccessEgress> comparator
   ) {
     var mapByStop = groupByStop(paths);
-    var set = new ParetoSet<>(comparator);
+    var set = ParetoSet.of(comparator);
     var result = new ArrayList<RaptorAccessEgress>();
 
     for (int stop : mapByStop.keys()) {
       var list = mapByStop.get(stop);
       set.clear();
       set.addAll(list);
-      result.addAll(set);
+      result.addAll(set.stream().toList());
     }
     return result;
   }

raptor/src/main/java/org/opentripplanner/raptor/util/paretoset/ParetoSet.java

@@ -24,7 +24,7 @@
  *
  * @param <T> the element type
  */
-public sealed class ParetoSet<T> extends AbstractCollection<T> permits ParetoSetWithMarker {
+public final class ParetoSet<T> extends AbstractCollection<T> {
 
   private final ParetoComparator<T> comparator;
 
@@ -38,25 +38,38 @@ public sealed class ParetoSet<T> extends AbstractCollection<T> permits ParetoSet
 
   private T goodElement = null;
 
-  /**
-   * Create a new ParetoSet with a comparator and a drop event listener.
-   *
-   * @param comparator    The comparator to use with this set
-   * @param eventListener At most one listener can be registered to listen for drop events.
-   */
-  public ParetoSet(
+  private int marker = 0;
+
+  private ParetoSet(
     ParetoComparator<T> comparator,
     @Nullable ParetoSetEventListener<? super T> eventListener
   ) {
     this.comparator = comparator;
     this.eventListener = eventListener;
   }
 
+  private ParetoSet(ParetoComparator<T> comparator) {
+    this(comparator, null);
+  }
+
   /**
    * Create a new ParetoSet with a comparator.
    */
-  public ParetoSet(ParetoComparator<T> comparator) {
-    this(comparator, null);
+  public static <T> ParetoSet<T> of(ParetoComparator<T> comparator) {
+    return of(comparator, null);
+  }
+
+  /**
+   * Create a new ParetoSet with a comparator and a drop event listener.
+   *
+   * @param comparator    The comparator to use with this set
+   * @param eventListener At most one listener can be registered to listen for drop events.
+   */
+  public static <T> ParetoSet<T> of(
+    ParetoComparator<T> comparator,
+    @Nullable ParetoSetEventListener<? super T> eventListener
+  ) {
+    return new ParetoSet<>(comparator, eventListener);
   }
 
   public T get(int index) {
@@ -69,17 +82,35 @@ public T get(int index) {
    * This is NOT thread-safe and the behavior is undefined if the collection is modified during the
    * iteration.
    */
-  @Override
   public final Iterator<T> iterator() {
     return tailIterator(0);
   }
 
-  @Override
+  /*
+  public final Iterable iterable() {
+    return new Iterable() {
+      @Override
+      public Iterator iterator() {
+        return iterator();
+      }
+    };
+  }
+  */
+
   public int size() {
     return size;
   }
 
-  @Override
+  public boolean isEmpty() {
+    return size == 0;
+  }
+
+  /*
+  public Stream<T> stream() {
+    return Arrays.stream(elements, 0, size);
+  }
+   */
+
   public boolean add(T newValue) {
     if (size == 0) {
       acceptAndAppendValue(newValue);
@@ -126,15 +157,17 @@ public boolean add(T newValue) {
     return false;
   }
 
-  @Override
-  public boolean remove(Object o) {
-    throw new UnsupportedOperationException();
-  }
+  /*
+  public void addAll(Collection<T> elements) {
+    for (T element : elements) {
+      add(element);
+    }
+  }*/
 
-  @Override
   public void clear() {
     size = 0;
     goodElement = null;
+    marker = 0;
   }
 
   @Override
@@ -210,8 +243,10 @@ public String toString(Function<? super T, String> toStringMapper) {
    * Notify subclasses about reindexing. This method is empty, and only exist for subclasses to
    * override it.
    */
-  protected void notifyElementMoved(int fromIndex, int toIndex) {
-    // Noop
+  private void notifyElementMoved(int fromIndex, int toIndex) {
+    if (fromIndex == marker) {
+      marker = toIndex;
+    }
   }
 
   /**
@@ -326,4 +361,22 @@ private void notifyElementRejected(T element, T rejectByElement) {
       eventListener.notifyElementRejected(element, rejectByElement);
     }
   }
+
+  public boolean hasElementsAfterMarker() {
+    return marker != size();
+  }
+
+  /**
+   * List all elements added after the marker.
+   */
+  public Iterable<T> elementsAfterMarker() {
+    return tail(marker);
+  }
+
+  /**
+   * Move the marker after the last element in the set.
+   */
+  public void markAtEndOfSet() {
+    marker = size();
+  }
 }