Allow specifing a weight for routing that is independent of duration

Author: TheMarex

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 6.0.0
+  - Profiles:
+    - `turn_function` now does not return an integer but takes in a `turn` object and modifies it
+    - `uturn_penalty` is deprecated set it over the `turn_function`
+    - traffic light penalties now need to be set over the node function, `traffic_light_penalty` is deprecated:
+        result.weight_penalty and result.duration_penalty
+
 # 5.6.0
   - Changes from 5.5
     - Bugfixes

features/car/traffic_speeds.feature

@@ -24,5 +24,5 @@ Feature: osrm-contract command line options: invalid options
     Scenario: osrm-contract - Someone forgot --generate-edge-lookup on osrm-extract
         When I try to run "osrm-contract --segment-speed-file /dev/null {processed_file}"
         Then stderr should contain "Error while trying to mmap"
-        Then stderr should contain ".osrm.edge_penalties"
+        Then stderr should contain ".osrm.turn_penalties_index"
         And it should exit with an error

features/options/contract/invalid.feature

@@ -27,7 +27,7 @@ end
     Scenario: Out-bound API version
         Given the profile file
           """
-api_version = 1
+api_version = 2
           """
         And the node map
           """
@@ -55,6 +55,7 @@ properties.max_speed_for_map_matching      = 180/3.6
 properties.use_turn_restrictions           = true
 properties.continue_straight_at_waypoint   = true
 properties.left_hand_driving               = false
+properties.weight_name                     = 'duration'
 
 function node_function (node, result)
   print ('node_function ' .. node:id())
@@ -71,7 +72,7 @@ end
 
 function turn_function (angle)
   print('turn_function ' .. angle)
-  return angle == 0 and 0 or 42
+  return angle == 0 and 0 or 17
 end
 
 function segment_function (source, target, distance, weight)
@@ -101,6 +102,6 @@ end
 
         When I route I should get
            | from | to | route    | time  |
-           | a    | b  | ac,cb,cb | 19.2s |
-           | a    | d  | ac,cd,cd | 19.2s |
+           | a    | b  | ac,cb,cb | 16.7s |
+           | a    | d  | ac,cd,cd | 16.7s |
            | a    | e  | ac,ce,ce | 20s   |

features/options/profiles/version0.feature

@@ -0,0 +1,66 @@
+Feature: Profile API version 1
+
+    Background:
+        Given a grid size of 100 meters
+
+    Scenario: Basic profile function calls and property values
+        Given the profile file
+           """
+api_version = 1
+
+-- set profile properties
+properties.max_speed_for_map_matching      = 180/3.6
+properties.use_turn_restrictions           = true
+properties.continue_straight_at_waypoint   = true
+properties.weight_name                     = 'test_version1'
+
+function node_function (node, result)
+  print ('node_function ' .. node:id())
+end
+
+function way_function(way, result)
+  result.name = way:get_value_by_key('name')
+  result.weight = 10
+  result.forward_mode = mode.driving
+  result.backward_mode = mode.driving
+  result.forward_speed = 36
+  result.backward_speed = 36
+  print ('way_function ' .. way:id() .. ' ' .. result.name)
+end
+
+function turn_function (turn)
+  print('turn_function', turn.angle, turn.turn_type, turn.direction_modifier, turn.has_traffic_light)
+  turn.weight = turn.angle == 0 and 0 or 4.2
+  turn.duration = turn.weight
+end
+
+function segment_function (segment)
+    print ('segment_function ' .. segment.source.lon .. ' ' .. segment.source.lat)
+end
+           """
+        And the node map
+           """
+               a
+              bcd
+               e
+           """
+        And the ways
+            | nodes  |
+            | ac     |
+            | cb     |
+            | cd     |
+            | ce     |
+        And the data has been saved to disk
+
+        When I run "osrm-extract --profile {profile_file} {osm_file}"
+        Then it should exit successfully
+        And stdout should contain "node_function"
+        And stdout should contain "way_function"
+        And stdout should contain "turn_function"
+        And stdout should contain "segment_function"
+
+        When I route I should get
+           | from | to | route    | time  |
+           | a    | b  | ac,cb,cb | 19.2s |
+           | a    | d  | ac,cd,cd | 19.2s |
+           | a    | e  | ac,ce,ce | 20s   |

features/options/profiles/version1.feature

@@ -164,15 +164,21 @@ module.exports = function () {
     };
 
     this.annotationList = (instructions) => {
-        function zip(list_1, list_2, list_3)
+        if (!('annotation' in instructions.legs[0]))
+            return '';
+
+        function zip(list_1, list_2, list_3, list_4)
         {
             let tuples = [];
-            for (let i = 0; i <  list_1.length; ++i) {
-                tuples.push([list_1[i], list_2[i], list_3[i]]);
+            for (let i = 0; i < list_1.length; ++i) {
+                tuples.push([list_1[i], list_2[i], list_3[i], list_4[i]]);
             }
             return tuples;
         }
-        return instructions.legs.map(l => {return zip(l.annotation.duration, l.annotation.distance, l.annotation.datasources).map(p => { return p.join(':'); }).join(','); }).join(',');
+        return instructions.legs.map(l => {
+            const values = zip( l.annotation.weight, l.annotation.duration, l.annotation.distance, l.annotation.datasources);
+            return values.map(p => { return p.join(':'); }).join(',');
+        }).join(',');
     };
 
     this.OSMIDList = (instructions) => {
@@ -250,4 +256,12 @@ module.exports = function () {
     this.distanceList = (instructions) => {
         return this.extractInstructionList(instructions, s => s.distance + 'm');
     };
+
+    this.weightName = (instructions) => {
+        return instructions ? instructions.weight_name : '';
+    };
+
+    this.weightList = (instructions) => {
+        return this.extractInstructionList(instructions, s => s.weight);
+    };
 };

features/support/route.js

@@ -35,7 +35,7 @@ module.exports = function () {
                     if (err) return cb(err);
                     if (body && body.length) {
                         let destinations, pronunciations, instructions, refs, bearings, turns, modes, times,
-                            distances, summary, intersections, lanes, locations;
+                            distances, summary, intersections, lanes, locations, annotation, weight_name, weights;
 
                         let json = JSON.parse(body);
 
@@ -55,6 +55,9 @@ module.exports = function () {
                             lanes = this.lanesList(json.routes[0]);
                             summary = this.summary(json.routes[0]);
                             locations = this.locations(json.routes[0]);
+                            annotation = this.annotationList(json.routes[0]);
+                            weight_name = this.weightName(json.routes[0]);
+                            weights = this.weightList(json.routes[0]);
                         }
 
                         if (headers.has('status')) {
@@ -130,6 +133,10 @@ module.exports = function () {
                                 got.locations = (locations || '').trim();
                             }
 
+                            if (headers.has('annotation')){
+                                got.annotation = (annotation || '').trim();
+                            }
+
                             var putValue = (key, value) => {
                                 if (headers.has(key)) got[key] = instructions ? value : '';
                             };
@@ -142,6 +149,8 @@ module.exports = function () {
                             putValue('distances', distances);
                             putValue('pronunciations', pronunciations);
                             putValue('destinations', destinations);
+                            putValue('weight_name', weight_name);
+                            putValue('weights', weights);
                         }
 
                         for (var key in row) {

features/support/shared_steps.js

@@ -141,9 +141,9 @@ Feature: Basic Map Matching
         And the contract extra arguments "--segment-speed-file {speeds_file}"
 
         When I match I should get
-            | trace | matchings | annotation                                                                                      |
-            | abeh  | abeh      | 1:10.008842:1,0:0:0,1:10.008842:0,1:10.008842:0,1:10.008842:0,0:0:0,2:19.906475:0,1:10.008842:0 |
-            | abci  | abci      | 1:10.008842:1,0:0:0,1:10.008842:0,0:0:0,1:10.010367:0                                           |
+            | trace | matchings | annotation                                                                                                      |
+            | abeh  | abeh      | 1:1:10.008842:1,0:0:0:0,1:1:10.008842:0,1:1:10.008842:0,1:1:10.008842:0,0:0:0:0,2:2:19.906475:0,1:1:10.008842:0 |
+            | abci  | abci      | 1:1:10.008842:1,0:0:0:0,1:1:10.008842:0,0:0:0:0,1:1:10.010367:0                                                 |
 
         # The following is the same as the above, but separated for readability (line length)
         When I match I should get
@@ -337,4 +337,3 @@ Feature: Basic Map Matching
             | trace | OSM IDs     |
             | 12    | 1,2,3,4,5,6 |
             | 21    | 6,5,4,3,2,1 |
-

features/testbot/matching.feature

@@ -9,13 +9,10 @@ Feature: Testbot - side bias
         """
 
     Scenario: Left hand bias
-        Given the profile file "testbot" extended with
+        Given the profile file "car" extended with
         """
         properties.left_hand_driving = true
-        function turn_function (angle)
-          local k = 10 * angle * angle * 50 / (90.0 * 90.0)
-          return (angle >= 0) and k * 1.2 or k / 1.2
-        end
+        turn_bias = properties.left_hand_driving and 1/1.075 or 1.075
         """
         Given the node map
             """
@@ -31,17 +28,14 @@ Feature: Testbot - side bias
 
         When I route I should get
             | from | to | route    | time       |
-            | d    | a  | bd,ab,ab | 82s +-1    |
-            | d    | c  | bd,bc,bc | 100s +-1   |
+            | d    | a  | bd,ab,ab | 29s +-1    |
+            | d    | c  | bd,bc,bc | 33s +-1    |
 
     Scenario: Right hand bias
-        Given the profile file "testbot" extended with
+        Given the profile file "car" extended with
         """
         properties.left_hand_driving = false
-        function turn_function (angle)
-          local k = 10 * angle * angle * 50 / (90.0 * 90.0)
-          return (angle >= 0) and k / 1.2 or k * 1.2
-        end
+        turn_bias = properties.left_hand_driving and 1/1.075 or 1.075
         """
         And the node map
             """
@@ -57,8 +51,8 @@ Feature: Testbot - side bias
 
         When I route I should get
             | from | to | route    | time       |
-            | d    | a  | bd,ab,ab | 100s +-1   |
-            | d    | c  | bd,bc,bc | 82s +-1    |
+            | d    | a  | bd,ab,ab | 33s +-1    |
+            | d    | c  | bd,bc,bc | 29s +-1    |
 
     Scenario: Roundabout exit counting for left sided driving
         And a grid size of 10 meters