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
25 changes: 24 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ Summary of changes by function

* Output columns standardized to ``(node, color)``

* pgr_boykovKolmogorov

* Combinations signature promoted to official.

* pgr_breadthFirstSearch

* Standardizing output columns to ``(seq, depth, start_vid, pred, node, edge, cost, agg_cost)``
Expand Down Expand Up @@ -83,6 +87,14 @@ Summary of changes by function

* Output columns standardized to ``(edge, color)``

* pgr_edgeDisjointPaths

* Output columns standardized to ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``

* pgr_edmondsKarp

* Combinations signature promoted to official.

* pgr_edwardMoore

* Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
Expand Down Expand Up @@ -139,6 +151,10 @@ Summary of changes by function
* pgr_trsp_withpoints(text,text,text,bigint,bigint,boolean,character,boolean)
* pgr_trsp_withpoints(text,text,text,text,boolean,character,boolean)

* pgr_turnRestrictedPath

* Output columns standardized to ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``

* pgr_withPoints

* Function promoted to official.
Expand Down Expand Up @@ -297,6 +313,13 @@ Standardize output columns of functions with different output columns within ove
* [#2931](https://github.com/pgRouting/pgrouting/issues/2931)
pgr_depthFirstSearch

**Standardized to ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``**

* [#2909](https://github.com/pgRouting/pgrouting/issues/2909)
pgr_edgeDisjointPaths
* [#2909](https://github.com/pgRouting/pgrouting/issues/2909)
pgr_turnRestrictedPaths

Removal of SQL deprecated signatures

* [#2798](https://github.com/pgRouting/pgrouting/issues/2798):
Expand Down Expand Up @@ -481,7 +504,7 @@ Code enhancements

**Deprecation of internal C/C++ functions**

Deprecated functions are substitued by new function.
Deprecated functions are substituted by new function.

* _pgr_drivingdistance => _pgr_drivingdistancev4
* _pgr_withpointsdd => _pgr_withpointsddv4
Expand Down
50 changes: 3 additions & 47 deletions doc/categories/drivingDistance-category.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,53 +87,9 @@ Edges SQL
Result columns
...............................................................................

.. spantree-result-columns-start

Returns set of |result-spantree|

.. list-table::
:width: 81
:widths: auto
:header-rows: 1

* - Parameter
- Type
- Description
* - ``seq``
- ``BIGINT``
- Sequential value starting from :math:`1`.
* - ``depth``
- ``BIGINT``
- Depth of the ``node``.

- :math:`0` when ``node`` = ``start_vid``.
- :math:`depth-1` is the depth of ``pred``

* - ``start_vid``
- ``BIGINT``
- Identifier of the root vertex.
* - ``pred``
- ``BIGINT``
- Predecessor of ``node``.

- When ``node`` = ``start_vid`` then has the value ``node``.
* - ``node``
- ``BIGINT``
- Identifier of ``node`` reached using ``edge``.
* - ``edge``
- ``BIGINT``
- Identifier of the ``edge`` used to arrive from ``pred`` to ``node``.

- :math:`-1` when ``node`` = ``start_vid``.

* - ``cost``
- ``FLOAT``
- Cost to traverse ``edge``.
* - ``agg_cost``
- ``FLOAT``
- Aggregate cost from ``start_vid`` to ``node``.

.. spantree-result-columns-end
.. include:: pgRouting-concepts.rst
:start-after: spantree-result-columns-start
:end-before: spantree-result-columns-end

See Also
-------------------------------------------------------------------------------
Expand Down
5 changes: 0 additions & 5 deletions doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -381,11 +381,6 @@ rst_epilog="""
.. |result-lineg| replace:: ``(seq, source, target, cost, reverse_cost)``
.. |result-flow| replace:: ``(seq, edge, start_vid, end_vid, flow, residual_capacity)``
.. |result-flow-mincost| replace:: ``(seq, edge, source, target, flow, residual_capacity, cost, agg_cost)``
.. |result-disjoint| replace:: ``(seq, path_id, path_seq, [start_vid,] [end_vid,] node, edge, cost, agg_cost)``
.. |result-disjoint-1-1| replace:: ``(seq, path_id, path_seq, node, edge, cost, agg_cost)``
.. |result-disjoint-1-m| replace:: ``(seq, path_id, path_seq, end_vid, node, edge, cost, agg_cost)``
.. |result-disjoint-m-1| replace:: ``(seq, path_id, path_seq, start_vid, node, edge, cost, agg_cost)``
.. |result-disjoint-m-m| replace:: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
.. |result-mincut| replace:: ``(seq, edge, cost, mincut)``
.. |result-pickdrop| replace:: ``(seq, vehicle_number, vehicle_id, stop, order_id, stop_type, cargo, travel_time, arrival_time, wait_time, service_time, departure_time)``
.. |boost| image:: images/boost-inside.jpeg
Expand Down
47 changes: 3 additions & 44 deletions doc/ksp/pgr_KSP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -273,50 +273,9 @@ Combinations SQL
Result columns
-------------------------------------------------------------------------------

.. ksp_returns_start

Returns set of |nksp-result|

.. list-table::
:width: 81
:widths: auto
:header-rows: 1

* - Column
- Type
- Description
* - ``seq``
- ``INTEGER``
- Sequential value starting from **1**.
* - ``path_id``
- ``INTEGER``
- Path identifier.

* Has value **1** for the first of a path from ``start_vid`` to
``end_vid``
* - ``path_seq``
- ``INTEGER``
- Relative position in the path. Has value **1** for the beginning of a
path.
* - ``node``
- ``BIGINT``
- Identifier of the node in the path from ``start_vid`` to ``end_vid``
* - ``edge``
- ``BIGINT``
- Identifier of the edge used to go from ``node`` to the next node in the
path sequence. **-1** for the last node of the path.
* - ``cost``
- ``FLOAT``
- Cost to traverse from ``node`` using ``edge`` to the next node in the
path sequence.

* :math:`0` for the last ``node`` of the path.
* - ``agg_cost``
- ``FLOAT``
- Aggregate cost from **start vid** to ``node``.

.. ksp_returns_end

.. include:: pgRouting-concepts.rst
:start-after: return_path_all_columns_start
:end-before: return_path_all_columns_end

Additional Examples
-------------------------------------------------------------------------------
Expand Down
24 changes: 12 additions & 12 deletions doc/max_flow/pgr_boykovKolmogorov.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,28 @@ the flow from the sources to the targets using Boykov Kolmogorov algorithm.

.. Rubric:: Availability

* Version 4.0.0
.. rubric:: Version 4.0.0

* Combinations signature promoted to official.
* Combinations signature promoted to official.

* Version 3.2.0
.. rubric:: Version 3.2.0

* New proposed signature:
* New proposed signature:

* pgr_boykovKolmogorov(Combinations)
* pgr_boykovKolmogorov(Combinations)

* Version 3.0.0
.. rubric:: Version 3.0.0

* Function promoted to official.
* Function promoted to official.

* Version 2.5.0
.. rubric:: Version 2.5.0

* Renamed from ``pgr_maxFlowBoykovKolmogorov``
* Function promoted to proposed.
* Renamed from ``pgr_maxFlowBoykovKolmogorov``
* Function promoted to proposed.

* Version 2.3.0
.. rubric:: Version 2.3.0

* New experimental function.
* New experimental function.


Description
Expand Down
38 changes: 21 additions & 17 deletions doc/max_flow/pgr_edgeDisjointPaths.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,27 @@ vertices.

.. Rubric:: Availability

* Version 3.2.0
.. rubric:: Version 4.0.0

* New proposed signature:
* Output columns standardized to |generic-result|

* pgr_edgeDisjointPaths(Combinations)
.. rubric:: Version 3.2.0

* Version 3.0.0
* New proposed signature:

* Function promoted to official.
* pgr_edgeDisjointPaths(Combinations)

* Version 2.5.0
.. rubric:: Version 3.0.0

* Function promoted to proposed.
* Function promoted to official.

* Version 2.3.0
.. rubric:: Version 2.5.0

* New experimental function.
* Function promoted to proposed.

.. rubric:: Version 2.3.0

* New experimental function.


Description
Expand Down Expand Up @@ -69,7 +73,7 @@ Signatures
| pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vids**, [``directed``])
| pgr_edgeDisjointPaths(`Edges SQL`_, `Combinations SQL`_, [``directed``])

| Returns set of |result-disjoint|
| Returns set of |generic-result|
| OR EMPTY SET

.. index::
Expand All @@ -83,7 +87,7 @@ One to One

| pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vid**, [``directed``])

| Returns set of |result-disjoint-1-1|
| Returns set of |generic-result|
| OR EMPTY SET

:Example: From vertex :math:`11` to vertex :math:`12`
Expand All @@ -103,7 +107,7 @@ One to Many

| pgr_edgeDisjointPaths(`Edges SQL`_, **start vid**, **end vids**, [``directed``])

| Returns set of |result-disjoint-1-m|
| Returns set of |generic-result|
| OR EMPTY SET

:Example: From vertex :math:`11` to vertices :math:`\{5, 10, 12\}`
Expand All @@ -124,7 +128,7 @@ Many to One

| pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vid**, [``directed``])

| Returns set of |result-disjoint-m-1|
| Returns set of |generic-result|
| OR EMPTY SET

:Example: From vertices :math:`\{11, 3, 17\}` to vertex :math:`12`
Expand All @@ -144,7 +148,7 @@ Many to Many

| pgr_edgeDisjointPaths(`Edges SQL`_, **start vids**, **end vids**, [``directed``])

| Returns set of |result-disjoint-m-m|
| Returns set of |generic-result|
| OR EMPTY SET

:Example: From vertices :math:`\{11, 3, 17\}` to vertices :math:`\{5, 10, 12\}`
Expand All @@ -164,7 +168,7 @@ Combinations

| pgr_edgeDisjointPaths(`Edges SQL`_, `Combinations SQL`_, [``directed``])

| Returns set of |result-disjoint-m-m|
| Returns set of |generic-result|
| OR EMPTY SET

:Example: Using a combinations table, equivalent to calculating result from
Expand Down Expand Up @@ -218,8 +222,8 @@ Result columns
-------------------------------------------------------------------------------

.. include:: pgRouting-concepts.rst
:start-after: return_path_start
:end-before: return_path_end
:start-after: return_path_all_columns_start
:end-before: return_path_all_columns_end

Additional Examples
-------------------------------------------------------------------------------
Expand Down
24 changes: 12 additions & 12 deletions doc/max_flow/pgr_edmondsKarp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,28 @@ flow from the sources to the targets using Edmonds Karp Algorithm.

.. Rubric:: Availability

* Version 4.0.0
.. rubric:: Version 4.0.0

* Combinations signature promoted to official.
* Combinations signature promoted to official.

* Version 3.2.0
.. rubric:: Version 3.2.0

* New proposed signature:
* New proposed signature:

* pgr_edmondsKarp(Combinations)
* pgr_edmondsKarp(Combinations)

* Version 3.0.0
.. rubric:: Version 3.0.0

* Function promoted to official.
* Function promoted to official.

* Version 2.5.0
.. rubric:: Version 2.5.0

* Renamed from ``pgr_maxFlowEdmondsKarp``
* Function promoted to proposed.
* Renamed from ``pgr_maxFlowEdmondsKarp``
* Function promoted to proposed.

* Version 2.3.0
.. rubric:: Version 2.3.0

* New experimental function.
* New experimental function.


Description
Expand Down
2 changes: 1 addition & 1 deletion doc/spanningTree/pgr_primDD.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Edges SQL
Result columns
-------------------------------------------------------------------------------

.. include:: drivingDistance-category.rst
.. include:: pgRouting-concepts.rst
:start-after: spantree-result-columns-start
:end-before: spantree-result-columns-end

Expand Down
2 changes: 1 addition & 1 deletion doc/spanningTree/pgr_primDFS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Edges SQL
Result columns
-------------------------------------------------------------------------------

.. include:: drivingDistance-category.rst
.. include:: pgRouting-concepts.rst
:start-after: spantree-result-columns-start
:end-before: spantree-result-columns-end

Expand Down
Loading