Skip to content

Commit

Permalink
[withPointsDD][doc] Updating documentations
Browse files Browse the repository at this point in the history
* [pgr_withPointsDD] Updating for new signature and new outputs
* [migration] Updating migration guidance for pgr_withPointsDD
* [pgRouting-introduction] Adding name into developer list
  • Loading branch information
squarege committed Aug 19, 2023
1 parent 9e9a861 commit 09bba03
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 3 deletions.
2 changes: 1 addition & 1 deletion doc/driving_distance/pgr_drivingDistance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Driving distance optional parameters
* - ``equicost``
- ``BOOLEAN``
- ``true``
- * When ``true`` the node will only appear in the closest ``from_v``
- * When ``true`` the node will only appear in the closest ``start_vid``
list.
* When ``false`` which resembles several calls using the single starting
point signatures. Tie brakes are arbitrary.
Expand Down
75 changes: 75 additions & 0 deletions doc/src/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ Migrating functions:
signatures. This section will show how to migrate from the old signatures to the
new replacement functions. This also affects the restrictions.

:doc:`pgr_withPointsDD` signatures have changed, with the addition of new columns
in the new signatures. It works mainly for driving cases, therefore the ``driving side``
parameter changed from optional to compulsory, and its valid values differ for
directed and undirected graphs.

.. warning::
All deprecated functions will be removed on next mayor version 4.0.0

Expand Down Expand Up @@ -239,6 +244,76 @@ Signatures to be migrated:
the function ``my_dijkstra`` returns the new additional columns of
``pgr_dijkstra``.

Migration of ``pgr_withPointsDD``
-------------------------------------------------------------------------------

Starting from `v3.6.0 <https://docs.pgrouting.org/3.6/en/migration.html>`__

Signatures to be migrated:

* ``pgr_withPointsDD`` (`Single vertex`)
* ``pgr_withPointsDD`` (`Multiple vertices`)

:Before Migration:

.. literalinclude:: migration.queries
:start-after: --withpointsdd1
:end-before: --withpointsdd2

* ``driving_side`` parameter is optional.
* Output columns were |result-generic-no-seq|

* Depending on the overload used, the columns ``start_vid`` might be missing:

* ``pgr_withPointsDD`` (`Single vertex`) does not have ``start_vid``

:Migration:

* ``driving side`` parameter is compulsory, and valid values differ for directed
and undirected graphs.

* Does not have a default value.

* In directed graph, valid values are [``r``, ``R``, ``l``, ``L``]

* In undirected graph, valid values are [``b``, ``B``]


* Be aware of the existance of the additional columns.

* In ``pgr_withPointsDD`` (`Single vertex`)

* ``start_vid`` contains the **start vid** parameter value.
* ``depth`` contains the **depth** parameter value.

.. literalinclude:: migration.queries
:start-after: --withpointsdd2
:end-before: --withpointsdd3

* In ``pgr_withPointsDD`` (`Multiple vertices`)

* ``depth`` contains the **depth** parameter value.

.. literalinclude:: migration.queries
:start-after: --withpointsdd3
:end-before: --withpointsdd4

* If needed filter out the added columns, for example:

.. literalinclude:: migration.queries
:start-after: --withpointsdd4
:end-before: --withpointsdd5

* If needed add the new columns, similar to the following example where
``pgr_dijkstra`` is used, and the function had to be modified to be able to
return the new columns:

* In `v3.0 <https://docs.pgrouting.org/3.0/en/contraction-family.html#case-1-both-source-and-target-belong-to-the-contracted-graph>`__
the function ``my_dijkstra`` uses ``pgr_dijkstra``.
* Starting from `v3.5 <https://docs.pgrouting.org/3.5/en/contraction-family.html#case-1-both-source-and-target-belong-to-the-contracted-graph>`__
the function ``my_dijkstra`` returns the new additional columns of
``pgr_dijkstra``.

Migration of functions that change inner query columns names
*******************************************************************************

Expand Down
6 changes: 4 additions & 2 deletions doc/src/pgRouting-introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ Rajat Shinde,
Regina Obe,
Shobhit Chaurasia,
Swapnil Joshi,
Virginia Vergara
Virginia Vergara,
Yige Huang


And all the people that give us a little of their time making comments, finding
Expand Down Expand Up @@ -150,7 +151,8 @@ Sylvain Housseman,
Sylvain Pasche,
Veenit Kumar,
Vidhan Jain,
Virginia Vergara
Virginia Vergara,
Yige Huang

Corporate Sponsors (in alphabetical order)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 09bba03

Please sign in to comment.