Add trip plugin

src/engine/engine.cpp

@@ -7,7 +7,7 @@
 //#include "engine/plugins/hello_world.hpp"
 #include "engine/plugins/nearest.hpp"
 //#include "engine/plugins/timestamp.hpp"
-//#include "engine/plugins/trip.hpp"
+#include "engine/plugins/trip.hpp"
 #include "engine/plugins/viaroute.hpp"
 //#include "engine/plugins/tile.hpp"
 #include "engine/plugins/match.hpp"
@@ -146,7 +146,7 @@ Engine::Engine(EngineConfig &config)
     route_plugin = create<ViaRoutePlugin>(*query_data_facade, config.max_locations_viaroute);
     table_plugin = create<TablePlugin>(*query_data_facade, config.max_locations_distance_table);
     nearest_plugin = create<NearestPlugin>(*query_data_facade);
-    // trip_plugin = ceate<TripPlugin>(*query_data_facade, config.max_locations_trip);
+    trip_plugin = create<TripPlugin>(*query_data_facade, config.max_locations_trip);
     match_plugin = create<MatchPlugin>(*query_data_facade, config.max_locations_map_matching);
 }
 
@@ -172,8 +172,7 @@ Status Engine::Nearest(const api::NearestParameters &params, util::json::Object
 
 Status Engine::Trip(const api::TripParameters &params, util::json::Object &result)
 {
-    // return RunQuery(lock, *query_data_facade, params, *trip_plugin, result);
-    return Status::Error;
+    return RunQuery(lock, *query_data_facade, params, *trip_plugin, result);
 }
 
 Status Engine::Match(const api::MatchParameters &params, util::json::Object &result)

src/engine/plugins/match.cpp

@@ -163,7 +163,7 @@ Status MatchPlugin::HandleRequest(const api::MatchParameters &parameters,
     std::vector<InternalRouteResult> sub_routes(sub_matchings.size());
     for (auto index : util::irange(0UL, sub_matchings.size()))
     {
-        BOOST_ASSERT(sub.nodes.size() > 1);
+        BOOST_ASSERT(sub_matchings[index].nodes.size() > 1);
 
         // FIXME we only run this to obtain the geometry
         // The clean way would be to get this directly from the map matching plugin
@@ -177,7 +177,7 @@ Status MatchPlugin::HandleRequest(const api::MatchParameters &parameters,
             sub_routes[index].segment_end_coordinates.emplace_back(current_phantom_node_pair);
         }
         shortest_path(sub_routes[index].segment_end_coordinates, {}, sub_routes[index]);
-        BOOST_ASSERT(raw_route.shortest_path_length != INVALID_EDGE_WEIGHT);
+        BOOST_ASSERT(sub_routes[index].shortest_path_length != INVALID_EDGE_WEIGHT);
     }
 
     api::MatchAPI match_api{BasePlugin::facade, parameters};

src/engine/plugins/trip.cpp

@@ -0,0 +1,258 @@
+#include "engine/plugins/trip.hpp"
+
+#include "extractor/tarjan_scc.hpp"
+
+#include "engine/api/trip_api.hpp"
+#include "engine/api/trip_parameters.hpp"
+#include "engine/trip/trip_nearest_neighbour.hpp"
+#include "engine/trip/trip_farthest_insertion.hpp"
+#include "engine/trip/trip_brute_force.hpp"
+#include "util/dist_table_wrapper.hpp"   // to access the dist table more easily
+#include "util/matrix_graph_wrapper.hpp" // wrapper to use tarjan scc on dist table
+#include "util/json_container.hpp"
+
+#include <boost/assert.hpp>
+
+#include <cstdlib>
+#include <algorithm>
+#include <memory>
+#include <string>
+#include <utility>
+#include <vector>
+#include <iterator>
+
+namespace osrm
+{
+namespace engine
+{
+namespace plugins
+{
+
+// Object to hold all strongly connected components (scc) of a graph
+// to access all graphs with component ID i, get the iterators by:
+// auto start = std::begin(scc_component.component) + scc_component.range[i];
+// auto end = std::begin(scc_component.component) + scc_component.range[i+1];
+struct SCC_Component
+{
+    // in_component: all NodeIDs sorted by component ID
+    // in_range: index where a new component starts
+    //
+    // example: NodeID 0, 1, 2, 4, 5 are in component 0
+    //          NodeID 3, 6, 7, 8    are in component 1
+    //          => in_component = [0, 1, 2, 4, 5, 3, 6, 7, 8]
+    //          => in_range = [0, 5]
+    SCC_Component(std::vector<NodeID> in_component_nodes, std::vector<size_t> in_range)
+        : component(std::move(in_component_nodes)), range(std::move(in_range))
+    {
+        BOOST_ASSERT_MSG(component.size() > 0, "there's no scc component");
+        BOOST_ASSERT_MSG(*std::max_element(range.begin(), range.end()) == component.size(),
+                         "scc component ranges are out of bound");
+        BOOST_ASSERT_MSG(*std::min_element(range.begin(), range.end()) == 0,
+                         "invalid scc component range");
+        BOOST_ASSERT_MSG(std::is_sorted(std::begin(range), std::end(range)),
+                         "invalid component ranges");
+    }
+
+    std::size_t GetNumberOfComponents() const
+    {
+        BOOST_ASSERT_MSG(range.size() > 0, "there's no range");
+        return range.size() - 1;
+    }
+
+    const std::vector<NodeID> component;
+    std::vector<std::size_t> range;
+};
+
+// takes the number of locations and its duration matrix,
+// identifies and splits the graph in its strongly connected components (scc)
+// and returns an SCC_Component
+SCC_Component SplitUnaccessibleLocations(const std::size_t number_of_locations,
+                                         const util::DistTableWrapper<EdgeWeight> &result_table)
+{
+
+    if (std::find(std::begin(result_table), std::end(result_table), INVALID_EDGE_WEIGHT) ==
+        std::end(result_table))
+    {
+        // whole graph is one scc
+        std::vector<NodeID> location_ids(number_of_locations);
+        std::iota(std::begin(location_ids), std::end(location_ids), 0);
+        std::vector<size_t> range = {0, location_ids.size()};
+        return SCC_Component(std::move(location_ids), std::move(range));
+    }
+
+    // Run TarjanSCC
+    auto wrapper = std::make_shared<util::MatrixGraphWrapper<EdgeWeight>>(result_table.GetTable(),
+                                                                          number_of_locations);
+    auto scc = extractor::TarjanSCC<util::MatrixGraphWrapper<EdgeWeight>>(wrapper);
+    scc.run();
+
+    const auto number_of_components = scc.get_number_of_components();
+
+    std::vector<std::size_t> range_insertion;
+    std::vector<std::size_t> range;
+    range_insertion.reserve(number_of_components);
+    range.reserve(number_of_components);
+
+    std::vector<NodeID> components(number_of_locations, 0);
+
+    std::size_t prefix = 0;
+    for (std::size_t j = 0; j < number_of_components; ++j)
+    {
+        range_insertion.push_back(prefix);
+        range.push_back(prefix);
+        prefix += scc.get_component_size(j);
+    }
+    // senitel
+    range.push_back(components.size());
+
+    for (std::size_t i = 0; i < number_of_locations; ++i)
+    {
+        components[range_insertion[scc.get_component_id(i)]] = i;
+        ++range_insertion[scc.get_component_id(i)];
+    }
+
+    return SCC_Component(std::move(components), std::move(range));
+}
+
+InternalRouteResult TripPlugin::ComputeRoute(const std::vector<PhantomNode> &snapped_phantoms,
+                                             const api::TripParameters &parameters,
+                                             const std::vector<NodeID> &trip)
+{
+    InternalRouteResult min_route;
+    // given he final trip, compute total duration and return the route and location permutation
+    PhantomNodes viapoint;
+    const auto start = std::begin(trip);
+    const auto end = std::end(trip);
+    // computes a roundtrip from the nodes in trip
+    for (auto it = start; it != end; ++it)
+    {
+        const auto from_node = *it;
+        // if from_node is the last node, compute the route from the last to the first location
+        const auto to_node = std::next(it) != end ? *std::next(it) : *start;
+
+        viapoint = PhantomNodes{snapped_phantoms[from_node], snapped_phantoms[to_node]};
+        min_route.segment_end_coordinates.emplace_back(viapoint);
+    }
+    BOOST_ASSERT(min_route.segment_end_coordinates.size() == trip.size());
+
+    std::vector<boost::optional<bool>> uturns;
+    if (parameters.uturns.size() > 0)
+    {
+        uturns.resize(trip.size() + 1);
+        std::transform(trip.begin(), trip.end(), uturns.begin(), [&parameters](const NodeID idx)
+                {
+                return parameters.uturns[idx];
+                });
+        BOOST_ASSERT(uturns.size() > 0);
+        uturns.back() = parameters.uturns[trip.front()];
+    }
+
+    shortest_path(min_route.segment_end_coordinates, uturns, min_route);
+
+    BOOST_ASSERT_MSG(min_route.shortest_path_length < INVALID_EDGE_WEIGHT, "unroutable route");
+    return min_route;
+}
+
+Status TripPlugin::HandleRequest(const api::TripParameters &parameters,
+                                 util::json::Object &json_result)
+{
+    BOOST_ASSERT(parameters.IsValid());
+
+    // enforce maximum number of locations for performance reasons
+    if (max_locations_trip > 0 &&
+        static_cast<int>(parameters.coordinates.size()) > max_locations_trip)
+    {
+        return Error("TooBig", "Too many trip coordinates", json_result);
+    }
+
+    if (!CheckAllCoordinates(parameters.coordinates))
+    {
+        return Error("InvalidValue", "Invalid coordinate value.", json_result);
+    }
+
+    auto phantom_node_pairs = GetPhantomNodes(parameters);
+    if (phantom_node_pairs.size() != parameters.coordinates.size())
+    {
+        return Error("no-segment",
+                     std::string("Could not find a matching segment for coordinate ") +
+                         std::to_string(phantom_node_pairs.size()),
+                     json_result);
+    }
+    BOOST_ASSERT(phantom_node_pairs.size() == parameters.coordinates.size());
+
+    auto snapped_phantoms = SnapPhantomNodes(phantom_node_pairs);
+
+    const auto number_of_locations = snapped_phantoms.size();
+
+    // compute the duration table of all phantom nodes
+    const auto result_table = util::DistTableWrapper<EdgeWeight>(
+        duration_table(snapped_phantoms), number_of_locations);
+
+    if (result_table.size() == 0)
+    {
+        return Status::Error;
+    }
+
+    const constexpr std::size_t BF_MAX_FEASABLE = 10;
+    BOOST_ASSERT_MSG(result_table.size() == number_of_locations * number_of_locations,
+                     "Distance Table has wrong size");
+
+    // get scc components
+    SCC_Component scc = SplitUnaccessibleLocations(number_of_locations, result_table);
+
+    using NodeIDIterator = typename std::vector<NodeID>::const_iterator;
+
+    std::vector<std::vector<NodeID>> trips;
+    trips.reserve(scc.GetNumberOfComponents());
+    // run Trip computation for every SCC
+    for (std::size_t k = 0; k < scc.GetNumberOfComponents(); ++k)
+    {
+        const auto component_size = scc.range[k + 1] - scc.range[k];
+
+        BOOST_ASSERT_MSG(component_size > 0, "invalid component size");
+
+        std::vector<NodeID> scc_route;
+        NodeIDIterator start = std::begin(scc.component) + scc.range[k];
+        NodeIDIterator end = std::begin(scc.component) + scc.range[k + 1];
+
+        if (component_size > 1)
+        {
+
+            if (component_size < BF_MAX_FEASABLE)
+            {
+                scc_route = trip::BruteForceTrip(start, end, number_of_locations, result_table);
+            }
+            else
+            {
+                scc_route =
+                    trip::FarthestInsertionTrip(start, end, number_of_locations, result_table);
+            }
+        }
+        else
+        {
+            scc_route = std::vector<NodeID>(start, end);
+        }
+
+        trips.push_back(std::move(scc_route));
+    }
+    if (trips.empty())
+    {
+        return Error("NoTrips", "Cannot find trips", json_result);
+    }
+
+    // compute all round trip routes
+    std::vector<InternalRouteResult> routes;
+    routes.reserve(trips.size());
+    for (auto &trip : trips)
+    {
+        routes.push_back(ComputeRoute(snapped_phantoms, parameters, trip));
+    }
+
+    api::TripAPI trip_api{BasePlugin::facade, parameters};
+    trip_api.MakeResponse(trips, routes, snapped_phantoms, json_result);
+
+    return Status::Ok;
+}
+}
+}
+}

src/server/service/trip_service.cpp

@@ -1,4 +1,5 @@
 #include "server/service/trip_service.hpp"
+#include "server/service/utils.hpp"
 
 #include "engine/api/trip_parameters.hpp"
 #include "server/api/parameters_parser.hpp"
@@ -13,14 +14,60 @@ namespace server
 {
 namespace service
 {
+namespace
+{
+std::string getWrongOptionHelp(const engine::api::TripParameters &parameters)
+{
+    std::string help;
+
+    const auto coord_size = parameters.coordinates.size();
+
+    const bool param_size_mismatch = constrainParamSize(PARAMETER_SIZE_MISMATCH_MSG, "hints",
+                                                        parameters.hints, coord_size, help) ||
+                                     constrainParamSize(PARAMETER_SIZE_MISMATCH_MSG, "bearings",
+                                                        parameters.bearings, coord_size, help) ||
+                                     constrainParamSize(PARAMETER_SIZE_MISMATCH_MSG, "radiuses",
+                                                        parameters.radiuses, coord_size, help);
+
+    if (!param_size_mismatch && parameters.coordinates.size() < 2)
+    {
+        help = "Number of coordinates needs to be at least two.";
+    }
+
+    return help;
+}
+} // anon. ns
 
 engine::Status TripService::RunQuery(std::vector<util::FixedPointCoordinate> coordinates,
-                                     std::string &options,
-                                     util::json::Object &result)
+                                      std::string &options,
+                                      util::json::Object &result)
 {
-    // TODO(daniel-j-h)
-    return Status::Error;
-}
+    auto options_iterator = options.begin();
+    auto parameters =
+        api::parseParameters<engine::api::TripParameters>(options_iterator, options.end());
+    if (!parameters || options_iterator != options.end())
+    {
+        const auto position = std::distance(options.begin(), options_iterator);
+        result.values["code"] = "invalid-options";
+        result.values["message"] =
+            "Options string malformed close to position " + std::to_string(position);
+        return engine::Status::Error;
+    }
+
+    BOOST_ASSERT(parameters);
+    parameters->coordinates = std::move(coordinates);
+
+    if (!parameters->IsValid())
+    {
+        result.values["code"] = "invalid-options";
+        result.values["message"] = getWrongOptionHelp(*parameters);
+        return engine::Status::Error;
+    }
+    BOOST_ASSERT(parameters->IsValid());
+
+    return BaseService::routing_machine.Trip(*parameters, result);
+}
+
 }
 }
 }