Transit group priority - Part 1

[t2gran]

Summary

Transit group priority enable routing search where the transit services can be grouped and given mutual priority over other groups. By "mutual priority" we mean that both groups are is prioritised and end up in the result. A relax function is used to say how much worse a group may be before it is dropped. Within the group, only the best options are kept.

Issue

This build on top of PR #4996.
Fixes most of #3665

Unit tests

TODO

• Add module tests for c2 and run all relevant module test with c2 enabled (no used).
• Make sure all new classes have unit-tests.
• Support for grouping on Route mode (witch may be different from Trip mode/subMode)
• Fix issue reluctanceForMode uses route mode, not Trip/pattern #5248
• Copy and log c2 values to Path, PathLeg and Itinerary+Leg for better debugging.
• Heuristics - this is needed by both pass-through and this.
• Cleanup - filtering, make this filters API POJOs not Filters. This will allow us to reuse it in the API and apply it more than one place.

Documentation

TODO

• Write documentation for this feature

[codecov]

Codecov Report

Attention: 193 lines in your changes are missing coverage. Please review.

Comparison is base (428970b) 66.97% compared to head (5083681) 67.06%.
Report is 46 commits behind head on dev-2.x.

Files	Patch %	Lines
...er/transit/model/timetable/ScheduledTripTimes.java	55.88%	29 Missing and 1 partial ⚠️
...onfig/routerequest/TransitPriorityGroupConfig.java	52.63%	18 Missing ⚠️
...est/request/filter/TransitPriorityGroupSelect.java	74.54%	9 Missing and 5 partials ⚠️
...planner/routing/service/DefaultRoutingService.java	36.84%	11 Missing and 1 partial ⚠️
.../timetable/StopTimeToScheduledTripTimesMapper.java	83.33%	11 Missing and 1 partial ⚠️
...tripplanner/transit/model/timetable/TripTimes.java	82.08%	11 Missing and 1 partial ⚠️
...er/ext/transmodelapi/model/plan/RelaxCostType.java	63.33%	11 Missing ⚠️
...planner/api/common/RequestToPreferencesMapper.java	8.33%	10 Missing and 1 partial ⚠️
...radapter/transit/request/PriorityGroupMatcher.java	83.87%	8 Missing and 2 partials ⚠️
...entripplanner/raptor/api/request/SearchParams.java	0.00%	9 Missing ⚠️
... and 21 more

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #4999      +/-   ##
=============================================
+ Coverage      66.97%   67.06%   +0.09%     
- Complexity     15821    15978     +157     
=============================================
  Files           1833     1847      +14     
  Lines          70599    71067     +468     
  Branches        7410     7448      +38     
=============================================
+ Hits           47281    47664     +383     
- Misses         20845    20917      +72     
- Partials        2473     2486      +13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[t2gran]

I tested all test cases in issue #3665:

Test Results

Case 1

• Rleaxing by 1.1x+2140 return VY146 13:19 - 15:32 (Dominated by F6 Train 13:39 - 15:00)
• Bus not found: VY ekspressbuss depart 12:20 from Otta and arrive at Lillehammer 13:52

Case 2

• Fixed by relaxTransitPriorityGroup=1.1x+4030

Case 3

• Test case is not valid, trips does not overlap in time.

Case 4

• Fixed by relaxTransitPriorityGroup=1.2x+6460

Case 5

• Same route diffrent patterns?

Case 6
This is difficult, but

• R65 Shown with relaxTransitPriorityGroup=1.0x+1530 and local-tradic in separate pri.group(index 1 not 0)

Case 7

• Test case description need to be clearified. Strange results VY 146 is shown without relax, but not when relaxTransitPriorityGroup=1.1x+3620

Case 8

• Is possible solved by adding Røros banen as a priority-group

Case 9

• This is not about neutral trip planning, this is about optimal place to transfer

Case 10

• This only possible to support by doing 2 trip calls, one where riding train have a higher cost than waiting.

Case 11
Fix by: relaxTransitPriorityGroup=1.0x+213

Case 12
Fix by: relaxTransitPriorityGroup=1.05x+710

[t2gran]

I want to merge this to avoid falling to fare behind, I will make a second PR - Part 2 to fix the reminding tasks.

[leonardehrenfried]

Please format.

[leonardehrenfried]

There are a few tiny suggestions.

[leonardehrenfried]

Please resolve the conflicts.

[jtorin]

Found some minor question-marks.

[jtorin]

Shouldn't this be ferryD ?

[jtorin]

Doesn't matter that much, but maybe these two should be bus1 and ferry1 to be consistent. Or just rail.

[t2gran]

@jtorin I will cleanup the test in the next PR...