Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Document why unused parameters in Raptor API should NOT be deleted. #4413

Merged
merged 1 commit into from
Aug 25, 2022
Merged

doc: Document why unused parameters in Raptor API should NOT be deleted. #4413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/main/java/org/opentripplanner/transit/raptor/api/response/StopArrivals.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ public interface StopArrivals {
/**
* The earliest arrival time at the given stop. If the stop is not reached, the behavior is
* undefined; It may return an arbitrary value or throw an exception.
* <p>
* This is currently unused in OTP, but useful for analyses/comparing the results.
*/
@SuppressWarnings("unused")
int bestArrivalTime(int stopIndex);

/**
Expand All @@ -30,6 +33,9 @@ public interface StopArrivals {
/**
* The smallest number of transfers needed to reach the given stop. If the stop is not reached,
* the behavior is undefined; It may return an arbitrary value or throw an exception.
* <p>
* This is currently unused in OTP, but useful for analyses/comparing the results.
*/
@SuppressWarnings("unused")
int smallestNumberOfTransfers(int stopIndex);
}
3 changes: 3 additions & 0 deletions src/main/java/org/opentripplanner/transit/raptor/rangeraptor/internalapi/Heuristics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@ public interface Heuristics {

/**
* Return the best/minimum required number of transfers from origin to destination.
* <p>
* Currently unused, but useful for debugging.
*/
@SuppressWarnings("unused")
int bestOverallJourneyNumOfTransfers();

/**
Expand Down