feature: implement isInIteration on RaptorTransitCalculator

Author: sigtot

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

@@ -82,6 +82,30 @@ public boolean oneIterationOnly() {
     return searchWindowInSeconds <= iterationStep;
   }
 
+  /**
+   * Note: This implementation is an identical copy of the one in
+   * {@link ReverseRaptorTransitCalculator}, because introducing a common ancestor with
+   * iterationStep for these two calculators would be too large a performance hit.
+   * {@inheritDoc}
+   */
+  @Override
+  public boolean isInIteration(int subjectTime, int iterationDepartureTime) {
+    // A <= x
+    boolean iterationDepartureBeforeOrEqSubject = !isAfter(iterationDepartureTime, subjectTime);
+    if (oneIterationOnly()) {
+      return iterationDepartureBeforeOrEqSubject;
+    }
+
+    // x < B
+    boolean subjectBeforeIterationWindowEnd = isBefore(
+      subjectTime,
+      plusDuration(iterationDepartureTime, iterationStep)
+    );
+
+    // A <= x < B
+    return iterationDepartureBeforeOrEqSubject && subjectBeforeIterationWindowEnd;
+  }
+
   @Override
   public IntIterator patternStopIterator(int nStopsInPattern) {
     return IntIterators.intIncIterator(0, nStopsInPattern);

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

@@ -103,6 +103,12 @@ static <T extends RaptorTripSchedule> RaptorTransitCalculator<T> testDummyCalcul
    */
   boolean oneIterationOnly();
 
+  /**
+   * Return TRUE if the subject time is within the iteration given by the provided iteration
+   * departure time.
+   */
+  boolean isInIteration(int subjectTime, int iterationDepartureTime);
+
   /**
    * Return an iterator, iterating over the stop positions in a pattern. Iterate from '0' to
    * 'nStopsInPattern - 1' in a forward search and from 'nStopsInPattern - 1' to '0' in a reverse

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

@@ -85,6 +85,27 @@ public boolean oneIterationOnly() {
     return searchWindowInSeconds <= iterationStep;
   }
 
+  /**
+   * Note: This implementation is an identical copy of the one in
+   * {@link ForwardRaptorTransitCalculator}, because introducing a common ancestor with
+   * iterationStep for these two calculators would be too large a performance hit.
+   * {@inheritDoc}
+   */
+  @Override
+  public boolean isInIteration(int subjectTime, int iterationDepartureTime) {
+    boolean iterationDepartureBeforeOrEqSubject = !isAfter(iterationDepartureTime, subjectTime);
+    if (oneIterationOnly()) {
+      return iterationDepartureBeforeOrEqSubject;
+    }
+
+    boolean subjectBeforeIterationWindowEnd = isBefore(
+      subjectTime,
+      plusDuration(iterationDepartureTime, iterationStep)
+    );
+
+    return iterationDepartureBeforeOrEqSubject && subjectBeforeIterationWindowEnd;
+  }
+
   @Override
   public IntIterator patternStopIterator(int nStopsInPattern) {
     return IntIterators.intDecIterator(nStopsInPattern, 0);

raptor/src/test/java/org/opentripplanner/raptor/rangeraptor/transit/ForwardRaptorTransitCalculatorTest.java

@@ -57,6 +57,16 @@ public void oneIterationOnly() {
     assertTrue(subject.oneIterationOnly());
   }
 
+  @Test
+  public void isInIteration() {
+    var subject = create();
+
+    assertFalse(subject.isInIteration(59, 60));
+    assertTrue(subject.isInIteration(60, 60));
+    assertTrue(subject.isInIteration(119, 60));
+    assertFalse(subject.isInIteration(120, 60));
+  }
+
   @Test
   public void rangeRaptorMinutes() {
     earliestDepartureTime = 500;

raptor/src/test/java/org/opentripplanner/raptor/rangeraptor/transit/ReverseRaptorTransitCalculatorTest.java

@@ -58,6 +58,16 @@ public void oneIterationOnly() {
     assertTrue(subject.oneIterationOnly());
   }
 
+  @Test
+  public void isInIteration() {
+    var subject = create();
+
+    assertFalse(subject.isInIteration(60, 120));
+    assertTrue(subject.isInIteration(61, 120));
+    assertTrue(subject.isInIteration(120, 120));
+    assertFalse(subject.isInIteration(121, 120));
+  }
+
   @Test
   public void rangeRaptorMinutes() {
     latestArrivalTime = 500;