GSoC-2021 Week-9: vrp_vroom

CMakeLists.txt

@@ -297,14 +297,14 @@ endif()
 
 if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
   add_compile_options(
-    "$<$<CONFIG:Debug>:-Wall;-Wextra;-Wpedantic;-W;-Wunused;-Wuninitialized;-Wextra;-Wdouble-promotion;-Wconversion>"
+    "$<$<CONFIG:Debug>:-Wall;-Wextra;-Werror;-Wpedantic;-W;-Wunused;-Wuninitialized;-Wextra;-Wdouble-promotion;-Wconversion>"
     "$<$<CXX_COMPILER_ID:GNU>:-frounding-math>"
     )
 endif()
 
 
 #-------------------
-# Adding the VROOM library and dependencies
+# Add the VROOM library and dependencies
 #-------------------
 
 if(NOT VROOM_INSTALL_PATH)

README.md

@@ -7,7 +7,7 @@
 ### Branches
 
 * The *master* branch has the development of the next micro release
-* The *develop* branch has the development of the next minor/mayor release
+* The *develop* branch has the development of the next minor/major release
 
 For the complete list of releases go to:
 https://github.com/pgRouting/pgrouting/releases
@@ -26,13 +26,17 @@ Status of the project can be found [here](https://github.com/pgRouting/vrproutin
 
 ## INTRODUCTION
 
-vrpRouting extends the pgRouting/PostGIS/PostgreSQL geospatial database to provide algorithms for Vehilce Routing Problems
+vrpRouting extends the pgRouting/PostGIS/PostgreSQL geospatial database to provide algorithms for Vehicle Routing Problems.
+It requires VROOM as a dependency for building and computing the VRP solution. This release is compatible with VROOM version 1.10.0
 
-This library is under develpment an currently contains the following features:
+This library is under development and currently contains the following functions:
 
 * `vrp_onedepot`
 * `vrp_pgr_pickdelivereuclidean`
-* `vrp_pgr_pickdelive`r
+* `vrp_pgr_pickdeliver`
+* `vrp_vroom`
+* `vrp_vroomJobs`
+* `vrp_vroomShipments`
 
 ## REQUIREMENTS
 
@@ -44,7 +48,7 @@ Building requirements
 * The Boost Graph Library (BGL) >= 1.65
 * CMake >= 3.12
 * Sphinx >= TBD
-
+* VROOM >= 1.10.0
 
 User's requirements
 --------------------

doc/general/sampledata.rst

@@ -77,41 +77,55 @@ Jobs
    :start-after: -- JOBS TABLE start
    :end-before: -- JOBS TABLE end
 
+Jobs Time Windows
+...............................................................................
+
+.. literalinclude:: ../../tools/testers/vroomdata.sql
+   :start-after: -- JOBS TIME WINDOWS TABLE start
+   :end-before: -- JOBS TIME WINDOWS TABLE end
+
 Shipments
 ...............................................................................
 
 .. literalinclude:: ../../tools/testers/vroomdata.sql
    :start-after: -- SHIPMENTS TABLE start
    :end-before: -- SHIPMENTS TABLE end
 
+Shipments Time Windows
+...............................................................................
+
+.. literalinclude:: ../../tools/testers/vroomdata.sql
+   :start-after: -- SHIPMENTS TIME WINDOWS TABLE start
+   :end-before: -- SHIPMENTS TIME WINDOWS TABLE end
+
 Vehicles
 ...............................................................................
 
 .. literalinclude:: ../../tools/testers/vroomdata.sql
    :start-after: -- VEHICLES TABLE start
    :end-before: -- VEHICLES TABLE end
 
-Matrix
+Breaks
 ...............................................................................
 
 .. literalinclude:: ../../tools/testers/vroomdata.sql
-   :start-after: -- MATRIX TABLE start
-   :end-before: -- MATRIX TABLE end
-
+   :start-after: -- BREAKS TABLE start
+   :end-before: -- BREAKS TABLE end
 
-Time Windows
+Breaks Time Windows
 ...............................................................................
 
 .. literalinclude:: ../../tools/testers/vroomdata.sql
-   :start-after: -- TIME WINDOWS TABLE start
-   :end-before: -- TIME WINDOWS TABLE end
+   :start-after: -- BREAKS TIME WINDOWS TABLE start
+   :end-before: -- BREAKS TIME WINDOWS TABLE end
 
-Breaks
+Matrix
 ...............................................................................
 
 .. literalinclude:: ../../tools/testers/vroomdata.sql
-   :start-after: -- BREAKS TABLE start
-   :end-before: -- BREAKS TABLE end
+   :start-after: -- MATRIX TABLE start
+   :end-before: -- MATRIX TABLE end
+
 
 Images
 -------------------------------------------------------------------------------

doc/general/vroom-category.rst

@@ -95,8 +95,6 @@ Terminologies
 Inner Queries
 -------------------------------------------------------------------------------
 
-.. inner_queries_start
-
 Jobs SQL
 ...............................................................................
 
@@ -111,6 +109,8 @@ Shipments SQL
    :start-after: vrp_vroom start
    :end-before: vrp_vroom end
 
+.. inner_queries_start
+
 Vehicles SQL
 ...............................................................................
 
@@ -119,14 +119,14 @@ Vehicles SQL
    :end-before: vrp_vroom end
 
 Breaks SQL
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+...............................................................................
 
 .. include:: ../../src/common/vroom/breaks_input.c
    :start-after: vrp_vroom start
    :end-before: vrp_vroom end
 
 Time Windows SQL
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+...............................................................................
 
 .. include:: ../../src/common/vroom/time_windows_input.c
    :start-after: vrp_vroom start

doc/vroom/vrp_vroom.rst

@@ -49,8 +49,7 @@ Signature
    :start-after: signature start
    :end-before: signature end
 
-**Example**: Problem involving 2 jobs and 1 shipment, using a single vehicle, similar to the VROOM Documentation
-`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ with a shipment.
+**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
 
 .. literalinclude:: doc-vrp_vroom.queries
    :start-after: -- q1
@@ -66,6 +65,20 @@ Parameters
 Inner Queries
 -------------------------------------------------------------------------------
 
+Jobs SQL
+...............................................................................
+
+.. include:: ../../src/common/vroom/jobs_input.c
+   :start-after: vrp_vroom start
+   :end-before: vrp_vroom end
+
+Shipments SQL
+...............................................................................
+
+.. include:: ../../src/common/vroom/shipments_input.c
+   :start-after: vrp_vroom start
+   :end-before: vrp_vroom end
+
 .. include:: vroom-category.rst
    :start-after: inner_queries_start
    :end-before: inner_queries_end
@@ -77,10 +90,11 @@ Result Columns
    :start-after: result_columns_start
    :end-before: result_columns_end
 
-Example
+Additional Example
 -------------------------------------------------------------------------------
 
-This example is based on the VROOM Data of the :doc:`sampledata` network:
+Problem involving 2 jobs and 1 shipment, using a single vehicle, similar to the VROOM Documentation
+`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ with a shipment.
 
 .. literalinclude:: doc-vrp_vroom.queries
    :start-after: -- q2

doc/vroom/vrp_vroomJobs.rst

@@ -48,8 +48,7 @@ Signature
    :start-after: signature start
    :end-before: signature end
 
-**Example**: Problem involving 2 jobs, using a single vehicle, corresponding to the VROOM Documentation
-`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__.
+**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
 
 .. literalinclude:: doc-vrp_vroomJobs.queries
    :start-after: -- q1
@@ -65,6 +64,13 @@ Parameters
 Inner Queries
 -------------------------------------------------------------------------------
 
+Jobs SQL
+...............................................................................
+
+.. include:: ../../src/common/vroom/jobs_input.c
+   :start-after: vrp_vroom start
+   :end-before: vrp_vroom end
+
 .. include:: vroom-category.rst
    :start-after: inner_queries_start
    :end-before: inner_queries_end
@@ -76,10 +82,11 @@ Result Columns
    :start-after: result_columns_start
    :end-before: result_columns_end
 
-Example
+Additional Example
 -------------------------------------------------------------------------------
 
-This example is based on the VROOM Data of the :doc:`sampledata` network:
+Problem involving 2 jobs, using a single vehicle, corresponding to the VROOM Documentation
+`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__.
 
 .. literalinclude:: doc-vrp_vroomJobs.queries
    :start-after: -- q2

doc/vroom/vrp_vroomShipments.rst

@@ -48,9 +48,7 @@ Signature
    :start-after: signature start
    :end-before: signature end
 
-**Example**: Problem involving 1 shipment, using a single vehicle, similar to the VROOM Documentation
-`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ without jobs
-and with a shipment.
+**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
 
 .. literalinclude:: doc-vrp_vroomShipments.queries
    :start-after: -- q1
@@ -66,6 +64,13 @@ Parameters
 Inner Queries
 -------------------------------------------------------------------------------
 
+Shipments SQL
+...............................................................................
+
+.. include:: ../../src/common/vroom/shipments_input.c
+   :start-after: vrp_vroom start
+   :end-before: vrp_vroom end
+
 .. include:: vroom-category.rst
    :start-after: inner_queries_start
    :end-before: inner_queries_end
@@ -77,10 +82,12 @@ Result Columns
    :start-after: result_columns_start
    :end-before: result_columns_end
 
-Example
+Additional Example
 -------------------------------------------------------------------------------
 
-This example is based on the VROOM Data of the :doc:`sampledata` network:
+Problem involving 1 shipment, using a single vehicle, similar to the VROOM Documentation
+`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ without jobs
+and with a shipment.
 
 .. literalinclude:: doc-vrp_vroomShipments.queries
    :start-after: -- q2