Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,12 @@ linkcheck_ignore = [
"https://vrp.pgrouting.org/latest/en/vrp_vroomJobs.html",
"https://vrp.pgrouting.org/v0/en/vrp_vroomShipments.html",
"https://vrp.pgrouting.org/latest/en/vrp_vroomShipments.html",
"https://vrp.pgrouting.org/v0/en/vrp_vroomPlain.html",
"https://vrp.pgrouting.org/latest/en/vrp_vroomPlain.html",
"https://vrp.pgrouting.org/v0/en/vrp_vroomJobsPlain.html",
"https://vrp.pgrouting.org/latest/en/vrp_vroomJobsPlain.html",
"https://vrp.pgrouting.org/v0/en/vrp_vroomShipmentsPlain.html",
"https://vrp.pgrouting.org/latest/en/vrp_vroomShipmentsPlain.html",

# (see: https://github.com/sphinx-doc/sphinx/issues/7388)
r"https://github.com/pgRouting/vrprouting/", # limit only vrprouting
Expand Down
9 changes: 9 additions & 0 deletions doc/general/sampledata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,15 @@ Matrix
:start-after: -- MATRIX TABLE start
:end-before: -- MATRIX TABLE end

Modified VROOM Data
-------------------------------------------------------------------------------

The tables created using the above VROOM Data are modified for the VROOM functions
with timestamps/interval, as:

.. literalinclude:: ../../docqueries/vroom/doc-vrp_vroom.test.sql
:start-after: -- q0
:end-before: -- q1

Images
-------------------------------------------------------------------------------
Expand Down
3 changes: 3 additions & 0 deletions doc/general/vroom-category.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ VROOM - Category (Experimental)
vrp_vroom
vrp_vroomJobs
vrp_vroomShipments
vrp_vroomPlain
vrp_vroomJobsPlain
vrp_vroomShipmentsPlain


Synopsis
Expand Down
3 changes: 3 additions & 0 deletions doc/vroom/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ SET(LOCAL_FILES
vrp_vroom.rst
vrp_vroomJobs.rst
vrp_vroomShipments.rst
vrp_vroomPlain.rst
vrp_vroomJobsPlain.rst
vrp_vroomShipmentsPlain.rst
)

foreach (f ${LOCAL_FILES})
Expand Down
3 changes: 2 additions & 1 deletion doc/vroom/vrp_vroom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ Signature
:start-after: signature start
:end-before: signature end

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
The modification in the tables is mentioned at the end of the :doc:`sampledata`.

.. literalinclude:: doc-vrp_vroom.queries
:start-after: -- q1
Expand Down
3 changes: 2 additions & 1 deletion doc/vroom/vrp_vroomJobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ Signature
:start-after: signature start
:end-before: signature end

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
The modification in the tables is mentioned at the end of the :doc:`sampledata`.

.. literalinclude:: doc-vrp_vroomJobs.queries
:start-after: -- q1
Expand Down
108 changes: 108 additions & 0 deletions doc/vroom/vrp_vroomJobsPlain.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
..
****************************************************************************
vrpRouting Manual
Copyright(c) vrpRouting Contributors

This documentation is licensed under a Creative Commons Attribution-Share
Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
****************************************************************************

|

* `Documentation <https://vrp.pgrouting.org/>`__ → `vrpRouting v0 <https://vrp.pgrouting.org/v0>`__
* Supported Versions
`Latest <https://vrp.pgrouting.org/latest/en/vrp_vroomJobsPlain.html>`__
(`v0 <https://vrp.pgrouting.org/v0/en/vrp_vroomJobsPlain.html>`__)


vrp_vroomJobsPlain - Experimental
===============================================================================

``vrp_vroomJobsPlain`` - Vehicle Routing Problem with VROOM, involving only jobs.

.. include:: experimental.rst
:start-after: begin-warn-expr
:end-before: end-warn-expr

.. rubric:: Availability

Version 0.2.0

* New **experimental** function


Description
-------------------------------------------------------------------------------

VROOM is an open-source optimization engine that aims at providing good solutions
to various real-life vehicle routing problems (VRP) within a small computing time.
This function can be used to get the solution to a problem involving only jobs.

.. index::
single: vrp_vroomJobsPlain -- Experimental on v0.2

Signature
-------------------------------------------------------------------------------

.. include:: ../sql/vroom/vrp_vroomJobs.sql
:start-after: signature start
:end-before: signature end

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:

.. literalinclude:: doc-vrp_vroomJobsPlain.queries
:start-after: -- q1
:end-before: -- q2

Parameters
-------------------------------------------------------------------------------

.. include:: ../sql/vroom/vrp_vroomJobs.sql
:start-after: parameters start
:end-before: parameters end

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

Result Columns
-------------------------------------------------------------------------------

.. include:: vroom-category.rst
:start-after: result_columns_start
:end-before: result_columns_end

Additional 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>`__.

.. literalinclude:: doc-vrp_vroomJobsPlain.queries
:start-after: -- q2
:end-before: -- q3

See Also
-------------------------------------------------------------------------------

* :doc:`vroom-category`
* The queries use the :doc:`sampledata` network.

.. include:: vroom-category.rst
:start-after: see_also_start
:end-before: see_also_end

.. rubric:: Indices and tables

* :ref:`genindex`
* :ref:`search`
116 changes: 116 additions & 0 deletions doc/vroom/vrp_vroomPlain.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
..
****************************************************************************
vrpRouting Manual
Copyright(c) vrpRouting Contributors

This documentation is licensed under a Creative Commons Attribution-Share
Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
****************************************************************************

|

* `Documentation <https://vrp.pgrouting.org/>`__ → `vrpRouting v0 <https://vrp.pgrouting.org/v0>`__
* Supported Versions
`Latest <https://vrp.pgrouting.org/latest/en/vrp_vroomPlain.html>`__
(`v0 <https://vrp.pgrouting.org/v0/en/vrp_vroomPlain.html>`__)


vrp_vroomPlain - Experimental
===============================================================================

``vrp_vroomPlain`` - Vehicle Routing Problem with VROOM, involving both jobs and shipments.

.. include:: experimental.rst
:start-after: begin-warn-expr
:end-before: end-warn-expr

.. rubric:: Availability

Version 0.2.0

* New **experimental** function


Description
-------------------------------------------------------------------------------

VROOM is an open-source optimization engine that aims at providing good solutions
to various real-life vehicle routing problems (VRP) within a small computing time.
This function can be used to get the solution to a problem involving both jobs and
shipments.

.. index::
single: vrp_vroomPlain -- Experimental on v0.2

Signature
-------------------------------------------------------------------------------

.. include:: ../sql/vroom/vrp_vroom.sql
:start-after: signature start
:end-before: signature end

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:

.. literalinclude:: doc-vrp_vroomPlain.queries
:start-after: -- q1
:end-before: -- q2

Parameters
-------------------------------------------------------------------------------

.. include:: ../sql/vroom/vrp_vroom.sql
:start-after: parameters start
:end-before: parameters end

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

Result Columns
-------------------------------------------------------------------------------

.. include:: vroom-category.rst
:start-after: result_columns_start
:end-before: result_columns_end

Additional 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.

.. literalinclude:: doc-vrp_vroomPlain.queries
:start-after: -- q2
:end-before: -- q3

See Also
-------------------------------------------------------------------------------

* :doc:`vroom-category`
* The queries use the :doc:`sampledata` network.

.. include:: vroom-category.rst
:start-after: see_also_start
:end-before: see_also_end

.. rubric:: Indices and tables

* :ref:`genindex`
* :ref:`search`
3 changes: 2 additions & 1 deletion doc/vroom/vrp_vroomShipments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ Signature
:start-after: signature start
:end-before: signature end

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:
**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
The modification in the tables is mentioned at the end of the :doc:`sampledata`.

.. literalinclude:: doc-vrp_vroomShipments.queries
:start-after: -- q1
Expand Down
Loading