Distance support for table service

CMakeLists.txt

@@ -711,7 +711,7 @@ file(GLOB VariantGlob third_party/variant/include/mapbox/*.hpp)
 file(GLOB LibraryGlob include/osrm/*.hpp)
 file(GLOB ParametersGlob include/engine/api/*_parameters.hpp)
 set(EngineHeader include/engine/status.hpp include/engine/engine_config.hpp include/engine/hint.hpp include/engine/bearing.hpp include/engine/phantom_node.hpp)
-set(UtilHeader include/util/coordinate.hpp include/util/json_container.hpp include/util/typedefs.hpp include/util/strong_typedef.hpp include/util/exception.hpp)
+set(UtilHeader include/util/coordinate.hpp include/util/json_container.hpp include/util/typedefs.hpp include/util/strong_typedef.hpp include/util/exception.hpp include/util/payload.hpp)
 set(ExtractorHeader include/extractor/extractor.hpp include/extractor/extractor_config.hpp include/extractor/travel_mode.hpp)
 set(PartitionerHeader include/partition/partitioner.hpp include/partition/partition_config.hpp)
 set(ContractorHeader include/contractor/contractor.hpp include/contractor/contractor_config.hpp)
@@ -830,3 +830,15 @@ foreach(header ${headers_to_check})
 endforeach()
 add_library(check-headers STATIC EXCLUDE_FROM_ALL ${sources})
 set_target_properties(check-headers PROPERTIES ARCHIVE_OUTPUT_DIRECTORY ${check_headers_dir})
+
+if(PAYLOAD_TYPE MATCHES DurationsAndDistances)
+  message(STATUS "Configuring OSRM to support duration+distance payload")
+  add_definitions("-DPAYLOAD_TYPE_DURATIONS_AND_DISTANCES")
+elseif(PAYLOAD_TYPE MATCHES Durations)
+  message(STATUS "Configuring OSRM to support duration payload")
+  add_definitions("-DPAYLOAD_TYPE_DURATIONS")
+else()
+  message(STATUS "Unrecognized or missing payload type - will default to duration payload")
+  add_definitions("-DPAYLOAD_TYPE_DURATIONS")
+endif()
+

docs/http.md

@@ -212,10 +212,11 @@ GET /table/v1/{profile}/{coordinates}?{sources}=[{elem}...];&destinations=[{elem
 
 In addition to the [general options](#general-options) the following options are supported for this service:
 
-|Option      |Values                                            |Description                                  |
-|------------|--------------------------------------------------|---------------------------------------------|
-|sources     |`{index};{index}[;{index} ...]` or `all` (default)|Use location with given index as source.     |
-|destinations|`{index};{index}[;{index} ...]` or `all` (default)|Use location with given index as destination.|
+|Option       |Values                                             |Description                                  |
+|-------------|---------------------------------------------------|---------------------------------------------|
+|sources      |`{index};{index}[;{index} ...]` or `all` (default) |Use location with given index as source.     |
+|destinations |`{index};{index}[;{index} ...]` or `all` (default) |Use location with given index as destination.|
+|output_fields|`{durations|distances}[;{durations|distances} ...]`|Matrix fields to output in the reponse. Defaults to `durations` is missing. |
 
 Unlike other array encoded options, the length of `sources` and `destinations` can be **smaller or equal**
 to number of input locations;
@@ -248,6 +249,8 @@ curl 'http://router.project-osrm.org/table/v1/driving/polyline(egs_Iq_aqAppHzbHu
 - `code` if the request was successful `Ok` otherwise see the service dependent and general status codes.
 - `durations` array of arrays that stores the matrix in row-major order. `durations[i][j]` gives the travel time from
   the i-th waypoint to the j-th waypoint. Values are given in seconds. Can be `null` if no route between `i` and `j` can be found.
+- `distances` array of arrays that stores the matrix in row-major order. `distances[i][j]` gives the distance from
+  the i-th waypoint to the j-th waypoint. Values are given in meters.
 - `sources` array of `Waypoint` objects describing all sources in order
 - `destinations` array of `Waypoint` objects describing all destinations in order
 

features/support/route.js

@@ -10,7 +10,7 @@ module.exports = function () {
         if (service == 'timestamp') {
             uri = [this.HOST, service].join('/');
         } else {
-            uri = [this.HOST, service, 'v1', this.profile].join('/');
+            uri = [this.HOST, service, 'v2', this.profile].join('/');
         }
 
         return this.sendRequest(uri, params, callback);

features/testbot/status.feature

@@ -51,23 +51,23 @@ Feature: Status messages
 
         When I route I should get
             | request                             | status | message                                           |
-            | route/v1/driving/1,1;1,2            | 200    |                                                   |
-            | route/v1/driving/-74697224,5.191564 | 400    | Query string malformed close to position 18       |
-            | route/v1/driving/200,5.191564;44,5  | 400    | Invalid coordinate value.                         |
+            | route/v2/driving/1,1;1,2            | 200    |                                                   |
+            | route/v2/driving/-74697224,5.191564 | 400    | Query string malformed close to position 18       |
+            | route/v2/driving/200,5.191564;44,5  | 400    | Invalid coordinate value.                         |
             | nonsense                            | 400    | URL string malformed close to position 9: "nse"   |
-            | nonsense/v1/driving/1,1;1,2         | 400    | Service nonsense not found!                       |
+            | nonsense/v2/driving/1,1;1,2         | 400    | Service nonsense not found!                       |
             |                                     | 400    | URL string malformed close to position 1: "/"     |
             | /                                   | 400    | URL string malformed close to position 1: "//"    |
             | ?                                   | 400    | URL string malformed close to position 1: "/?"    |
-            | route/v1/driving                    | 400    | URL string malformed close to position 17: "ing"  |
-            | route/v1/driving/                   | 400    | URL string malformed close to position 18: "ng/"  |
-            | route/v1/driving/1                  | 400    | Query string malformed close to position 19       |
-            | route/v1/driving/1,1                | 400    | Number of coordinates needs to be at least two.   |
-            | route/v1/driving/1,1,1              | 400    | Query string malformed close to position 21       |
-            | route/v1/driving/x                  | 400    | Query string malformed close to position 18       |
-            | route/v1/driving/x,y                | 400    | Query string malformed close to position 18       |
-            | route/v1/driving/1,1;               | 400    | Query string malformed close to position 21       |
-            | route/v1/driving/1,1;1              | 400    | Query string malformed close to position 23       |
-            | route/v1/driving/1,1;1,1,1          | 400    | Query string malformed close to position 25       |
-            | route/v1/driving/1,1;x              | 400    | Query string malformed close to position 21       |
-            | route/v1/driving/1,1;x,y            | 400    | Query string malformed close to position 21       |
+            | route/v2/driving                    | 400    | URL string malformed close to position 17: "ing"  |
+            | route/v2/driving/                   | 400    | URL string malformed close to position 18: "ng/"  |
+            | route/v2/driving/1                  | 400    | Query string malformed close to position 19       |
+            | route/v2/driving/1,1                | 400    | Number of coordinates needs to be at least two.   |
+            | route/v2/driving/1,1,1              | 400    | Query string malformed close to position 21       |
+            | route/v2/driving/x                  | 400    | Query string malformed close to position 18       |
+            | route/v2/driving/x,y                | 400    | Query string malformed close to position 18       |
+            | route/v2/driving/1,1;               | 400    | Query string malformed close to position 21       |
+            | route/v2/driving/1,1;1              | 400    | Query string malformed close to position 23       |
+            | route/v2/driving/1,1;1,1,1          | 400    | Query string malformed close to position 25       |
+            | route/v2/driving/1,1;x              | 400    | Query string malformed close to position 21       |
+            | route/v2/driving/1,1;x,y            | 400    | Query string malformed close to position 21       |

include/contractor/contractor_graph.hpp

@@ -2,6 +2,7 @@
 #define OSRM_CONTRACTOR_CONTRACTOR_GRAPH_HPP_
 
 #include "util/dynamic_graph.hpp"
+#include "util/payload.hpp"
 #include <algorithm>
 
 namespace osrm
@@ -12,24 +13,24 @@ namespace contractor
 struct ContractorEdgeData
 {
     ContractorEdgeData()
-        : weight(0), duration(0), id(0), originalEdges(0), shortcut(0), forward(0), backward(0),
+        : weight(0), payload(), id(0), originalEdges(0), shortcut(0), forward(0), backward(0),
           is_original_via_node_ID(false)
     {
     }
     ContractorEdgeData(EdgeWeight weight,
-                       EdgeWeight duration,
+                       EdgePayload payload,
                        unsigned original_edges,
                        unsigned id,
                        bool shortcut,
                        bool forward,
                        bool backward)
-        : weight(weight), duration(duration), id(id),
+        : weight(weight), payload(payload), id(id),
           originalEdges(std::min((1u << 28) - 1u, original_edges)), shortcut(shortcut),
           forward(forward), backward(backward), is_original_via_node_ID(false)
     {
     }
     EdgeWeight weight;
-    EdgeWeight duration;
+    EdgePayload payload;
     unsigned id;
     unsigned originalEdges : 28;
     bool shortcut : 1;

include/contractor/graph_contractor.hpp

@@ -134,7 +134,7 @@ class GraphContractor
                     BOOST_ASSERT_MSG(SPECIAL_NODEID != new_edge.source, "Source id invalid");
                     BOOST_ASSERT_MSG(SPECIAL_NODEID != new_edge.target, "Target id invalid");
                     new_edge.data.weight = data.weight;
-                    new_edge.data.duration = data.duration;
+                    new_edge.data.payload = data.payload;
                     new_edge.data.shortcut = data.shortcut;
                     if (!data.is_original_via_node_ID && !orig_node_id_from_new_node_id_map.empty())
                     {
@@ -244,7 +244,7 @@ class GraphContractor
                             inserted_edges.emplace_back(source,
                                                         target,
                                                         path_weight,
-                                                        in_data.duration + out_data.duration,
+                                                        in_data.payload + out_data.payload,
                                                         out_data.originalEdges +
                                                             in_data.originalEdges,
                                                         node,
@@ -255,7 +255,7 @@ class GraphContractor
                             inserted_edges.emplace_back(target,
                                                         source,
                                                         path_weight,
-                                                        in_data.duration + out_data.duration,
+                                                        in_data.payload + out_data.payload,
                                                         out_data.originalEdges +
                                                             in_data.originalEdges,
                                                         node,
@@ -316,7 +316,7 @@ class GraphContractor
                         inserted_edges.emplace_back(source,
                                                     target,
                                                     path_weight,
-                                                    in_data.duration + out_data.duration,
+                                                    in_data.payload + out_data.payload,
                                                     out_data.originalEdges + in_data.originalEdges,
                                                     node,
                                                     SHORTCUT_ARC,
@@ -326,7 +326,7 @@ class GraphContractor
                         inserted_edges.emplace_back(target,
                                                     source,
                                                     path_weight,
-                                                    in_data.duration + out_data.duration,
+                                                    in_data.payload + out_data.payload,
                                                     out_data.originalEdges + in_data.originalEdges,
                                                     node,
                                                     SHORTCUT_ARC,

include/contractor/graph_contractor_adaptors.hpp

@@ -36,7 +36,7 @@ std::vector<ContractorEdge> adaptToContractorInput(InputEdgeContainer input_edge
         edges.emplace_back(input_edge.source,
                            input_edge.target,
                            std::max(input_edge.data.weight, 1),
-                           input_edge.data.duration,
+                           input_edge.data.payload,
                            1,
                            input_edge.data.turn_id,
                            false,
@@ -46,7 +46,7 @@ std::vector<ContractorEdge> adaptToContractorInput(InputEdgeContainer input_edge
         edges.emplace_back(input_edge.target,
                            input_edge.source,
                            std::max(input_edge.data.weight, 1),
-                           input_edge.data.duration,
+                           input_edge.data.payload,
                            1,
                            input_edge.data.turn_id,
                            false,

include/contractor/query_edge.hpp

@@ -1,6 +1,7 @@
 #ifndef QUERYEDGE_HPP
 #define QUERYEDGE_HPP
 
+#include "util/payload.hpp"
 #include "util/typedefs.hpp"
 
 #include <tuple>
@@ -17,28 +18,28 @@ struct QueryEdge
     struct EdgeData
     {
         explicit EdgeData()
-            : turn_id(0), shortcut(false), weight(0), duration(0), forward(false), backward(false)
+            : turn_id(0), shortcut(false), weight(0), forward(false), backward(false), payload()
         {
         }
 
         template <class OtherT> EdgeData(const OtherT &other)
         {
             weight = other.weight;
-            duration = other.duration;
             shortcut = other.shortcut;
             turn_id = other.id;
             forward = other.forward;
             backward = other.backward;
+            payload = other.payload;
         }
         // this ID is either the middle node of the shortcut, or the ID of the edge based node (node
         // based edge) storing the appropriate data. If `shortcut` is set to true, we get the middle
         // node. Otherwise we see the edge based node to access node data.
         NodeID turn_id : 31;
         bool shortcut : 1;
-        EdgeWeight weight;
-        EdgeWeight duration : 30;
+        EdgeWeight weight : 30;
         std::uint32_t forward : 1;
         std::uint32_t backward : 1;
+        EdgePayload payload;
     } data;
 
     QueryEdge() : source(SPECIAL_NODEID), target(SPECIAL_NODEID) {}
@@ -56,9 +57,9 @@ struct QueryEdge
     bool operator==(const QueryEdge &right) const
     {
         return (source == right.source && target == right.target &&
-                data.weight == right.data.weight && data.duration == right.data.duration &&
-                data.shortcut == right.data.shortcut && data.forward == right.data.forward &&
-                data.backward == right.data.backward && data.turn_id == right.data.turn_id);
+                data.weight == right.data.weight && data.shortcut == right.data.shortcut &&
+                data.forward == right.data.forward && data.backward == right.data.backward &&
+                data.payload == right.data.payload && data.turn_id == right.data.turn_id);
     }
 };
 }

include/engine/api/table_api.hpp

@@ -4,6 +4,7 @@
 #include "engine/api/base_api.hpp"
 #include "engine/api/json_factory.hpp"
 #include "engine/api/table_parameters.hpp"
+#include "engine/api/table_payload.hpp"
 
 #include "engine/datafacade/datafacade_base.hpp"
 
@@ -36,9 +37,10 @@ class TableAPI final : public BaseAPI
     {
     }
 
-    virtual void MakeResponse(const std::vector<EdgeWeight> &durations,
+    virtual void MakeResponse(const std::vector<RoutingPayload> &entries,
                               const std::vector<PhantomNode> &phantoms,
-                              util::json::Object &response) const
+                              util::json::Object &response,
+                              const std::vector<TableOutputField> &output_fields) const
     {
         auto number_of_sources = parameters.sources.size();
         auto number_of_destinations = parameters.destinations.size();
@@ -65,8 +67,15 @@ class TableAPI final : public BaseAPI
             response.values["destinations"] = MakeWaypoints(phantoms, parameters.destinations);
         }
 
-        response.values["durations"] =
-            MakeTable(durations, number_of_sources, number_of_destinations);
+        for (auto &component : output_fields.size() == 0 ? DEFAULT_FIELDS : output_fields)
+        {
+            response.values[TableOutputFieldName[component]] =
+                MakeTable(entries,
+                          number_of_sources,
+                          number_of_destinations,
+                          get_encoder<RoutingPayload>(component));
+        }
+
         response.values["code"] = "Ok";
     }
 
@@ -98,9 +107,10 @@ class TableAPI final : public BaseAPI
         return json_waypoints;
     }
 
-    virtual util::json::Array MakeTable(const std::vector<EdgeWeight> &values,
+    virtual util::json::Array MakeTable(const std::vector<RoutingPayload> &values,
                                         std::size_t number_of_rows,
-                                        std::size_t number_of_columns) const
+                                        std::size_t number_of_columns,
+                                        PAYLOAD_ENCODER<RoutingPayload> encoder) const
     {
         util::json::Array json_table;
         for (const auto row : util::irange<std::size_t>(0UL, number_of_rows))
@@ -109,24 +119,20 @@ class TableAPI final : public BaseAPI
             auto row_begin_iterator = values.begin() + (row * number_of_columns);
             auto row_end_iterator = values.begin() + ((row + 1) * number_of_columns);
             json_row.values.resize(number_of_columns);
-            std::transform(row_begin_iterator,
-                           row_end_iterator,
-                           json_row.values.begin(),
-                           [](const EdgeWeight duration) {
-                               if (duration == MAXIMAL_EDGE_DURATION)
-                               {
-                                   return util::json::Value(util::json::Null());
-                               }
-                               return util::json::Value(util::json::Number(duration / 10.));
-                           });
+            std::transform(row_begin_iterator, row_end_iterator, json_row.values.begin(), encoder);
             json_table.values.push_back(std::move(json_row));
         }
         return json_table;
     }
 
     const TableParameters &parameters;
+
+    static const std::vector<TableOutputField> DEFAULT_FIELDS;
 };
 
+const std::vector<TableOutputField> TableAPI::DEFAULT_FIELDS =
+    std::vector<TableOutputField>(1, DURATION);
+
 } // ns api
 } // ns engine
 } // ns osrm