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
28 changes: 23 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ Summary of changes by function

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

* pgr_topologicalSort

* Standardize output to ``(node)``-order

* pgr_transitiveClosure

* Standardized output to ``(node,targets)``

* pgr_trsp

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

**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

**Standardized to ``(edge, color)``**

* [#2924](https://github.com/pgRouting/pgrouting/issues/2924)
Expand All @@ -313,12 +328,15 @@ 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)``**
**Standardized to ``(node)``-order**

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

**Standardized to ``(node,targets)``**

* [#2934](https://github.com/pgRouting/pgrouting/issues/2934)
pgr_transitiveClosure

Removal of SQL deprecated signatures

Expand Down
2 changes: 1 addition & 1 deletion ci/winnie/build_pgrouting.sh
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ if [ $JENKINS_DEBUG -eq 1 ]
then
echo
echo "***************************"
echo Recived variables used in this script
echo Received variables used in this script
echo "**************************"

echo "OS_BUILD ${OS_BUILD}"
Expand Down
2 changes: 1 addition & 1 deletion doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ message(STATUS "PROJECT_DOC_TARGETS = ${PROJECT_DOC_TARGETS}")
#---------------------------------------------
#---------------------------------------------

# LANGUAGES SETINGS
# LANGUAGES SETTINGS

#---------------------------------------------
#---------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/categories/withPoints-category.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Points SQL
* - ``fraction``
- **ANY-NUMERICAL**
-
- Value in <0,1> that indicates the relative postition from the first end
- Value in <0,1> that indicates the relative position from the first end
point of the edge.
* - ``side``
- ``CHAR``
Expand Down
3 changes: 1 addition & 2 deletions doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,7 @@ rst_epilog="""
.. |result-extract| replace:: ``(id, in_edges, out_edges, x, y, geom)``
.. |result-find| replace:: ``(edge_id, fraction, side, distance, geom, edge)``
.. |result-version| replace:: ``(version, build_type, compile_date, library, system, PostgreSQL, compiler, boost, hash)``
.. |result-toposort| replace:: ``(seq, sorted_v)``
.. |result-closure| replace:: ``(seq, vid, target_array)``
.. |result-closure| replace:: ``(node,targets)``
.. |result-component-E| replace:: ``(seq, component, edge)``
.. |result-component-V| replace:: ``(seq, component, node)``
.. |result-component-make| replace:: ``(seq, start_vid, end_vid)``
Expand Down
14 changes: 9 additions & 5 deletions doc/ordering/pgr_topologicalSort.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,13 @@ graphs (DAG).

.. rubric:: Availability

* Version 3.0.0
.. rubric:: Version 4.0.0

* New experimental function.
* Standardize output to |result-node-order|

.. rubric:: Version 3.0.0

* New experimental function.

Description
-------------------------------------------------------------------------------
Expand Down Expand Up @@ -60,7 +64,7 @@ Signatures

| pgr_topologicalSort(`Edges SQL`_)

| Returns set of |result-toposort|
| Returns set of |result-node-order|
| OR EMPTY SET

:Example: Topologically sorting the graph
Expand Down Expand Up @@ -89,7 +93,7 @@ Edges SQL
Result columns
-------------------------------------------------------------------------------

Returns set of |result-toposort|
Returns set of |result-node-order|

.. list-table::
:width: 81
Expand All @@ -102,7 +106,7 @@ Returns set of |result-toposort|
* - ``seq``
- ``INTEGER``
- Sequential value starting from :math:`1`
* - ``sorted_v``
* - ``node``
- ``BIGINT``
- Linear topological ordering of the vertices

Expand Down
51 changes: 45 additions & 6 deletions doc/src/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ Migration to standardized columns
.. |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-toposort| replace:: ``(seq, sorted_v)``
.. |result-old-closure| replace:: ``(seq, vid, target_array)``

There has been an effort to standardize function output columns names and
types.

Expand Down Expand Up @@ -118,6 +121,8 @@ types.
- `Migration of multiple paths functions`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_sequentialVertexColoring`
- `Migration of output column name change`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_topologicalSort`
- `Migration of output column name change`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_withPoints`
- `Migration of single path functions`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_withPointsCost`
Expand Down Expand Up @@ -922,14 +927,15 @@ After updating pgRouting:
Migration of output column name change
-------------------------------------------------------------------------------

The standardized result columns for color functions are
The standardized result columns:

* |result_edge_color|
* |result_node_color|
* |result-node-order|

.. warning:: Breaking change

Changes must be done after updating pgRouting.
Changes on column names must be done after updating pgRouting.

.. list-table::
:header-rows: 1
Expand All @@ -946,6 +952,43 @@ The standardized result columns for color functions are
* - ``pgr_sequentialVertexColoring``
- v < 4.0.0
- :ref:`from_old_node_color`
* - ``pgr_topologicalSort``
- v < 4.0.0
- :ref:`from_toposort`
* - ``pgr_transitiveClosure``
- v < 4.0.0
- :ref:`from_old_closure`

.. _from_old_closure:

Migration from |result-old-closure|
.................................................................................

Migration to: |result-old-closure|

.. warning:: Breaking change

Changes must be done after updating pgRouting.

After update:

* Remove column ``seq``
* Rename ``vid`` to ``node`` and ``target_array`` to ``targets``

.. _from_toposort:

Migration from |result-toposort|
.................................................................................

Migration to: |result-node-order|

.. warning:: Breaking change

Changes must be done after updating pgRouting.

After update:

* Rename ``sorted_v`` to ``node``

.. _from_old_edge_color:

Expand All @@ -962,8 +1005,6 @@ After update:

* Rename ``edge_id`` to ``edge`` and ``color_id`` to ``color``.

.. TODO examples

.. _from_old_node_color:

Migration from |old-node-color|
Expand All @@ -979,8 +1020,6 @@ After update:

* Rename ``vertex_id`` to ``node`` and ``color_id`` to ``color``.

.. TODO examples

Migration of deleted functions
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Expand Down
32 changes: 27 additions & 5 deletions doc/src/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,18 @@ Summary of changes by function
:start-after: Version 4.0.0
:end-before: .. rubric

* pgr_topologicalSort

.. include:: pgr_topologicalSort.rst
:start-after: Version 4.0.0
:end-before: .. rubric

* pgr_transitiveClosure

.. include:: pgr_transitiveClosure.rst
:start-after: Version 4.0.0
:end-before: .. rubric

* pgr_trsp

.. include:: pgr_trsp.rst
Expand Down Expand Up @@ -342,6 +354,13 @@ Standardize output columns of functions with different output columns within ove
* `#2905 <https://github.com/pgRouting/pgrouting/issues/2905>`__
pgr_withPointsCostMatrix

.. rubric:: Standardized to |generic-result|

* `#2909 <https://github.com/pgRouting/pgrouting/issues/2909>`__
pgr_edgeDisjointPaths
* `#2909 <https://github.com/pgRouting/pgrouting/issues/2909>`__
pgr_turnRestrictedPaths

.. rubric:: Standardized to |result_edge_color|

* `#2924 <https://github.com/pgRouting/pgrouting/issues/2924>`__
Expand All @@ -361,12 +380,15 @@ Standardize output columns of functions with different output columns within ove
* `#2931 <https://github.com/pgRouting/pgrouting/issues/2931>`__
pgr_depthFirstSearch

.. rubric:: Standardized to |generic-result|
.. rubric:: Standardized to |result-node-order|

* `#2909 <https://github.com/pgRouting/pgrouting/issues/2909>`__
pgr_edgeDisjointPaths
* `#2909 <https://github.com/pgRouting/pgrouting/issues/2909>`__
pgr_turnRestrictedPaths
* `#2934 <https://github.com/pgRouting/pgrouting/issues/2934>`__
pgr_topologicalSort

.. rubric:: Standardized to |result-closure|

* `#2934 <https://github.com/pgRouting/pgrouting/issues/2934>`__
pgr_transitiveClosure

Removal of SQL deprecated signatures
...............................................................................
Expand Down
8 changes: 6 additions & 2 deletions doc/transitiveClosure/pgr_transitiveClosure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,13 @@

.. rubric:: Availability

* Version 3.0.0
.. rubric:: Version 4.0.0

* New experimental function.
* Standardized output to |result-closure|

.. rubric:: Version 3.0.0

* New experimental function.


Description
Expand Down
76 changes: 38 additions & 38 deletions docqueries/ordering/topologicalSort.result
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ SELECT * FROM pgr_topologicalsort(
UNION
SELECT id, target, source, reverse_cost
FROM edges WHERE cost < 0$$);
seq | sorted_v
-----+----------
1 | 1
2 | 5
3 | 2
4 | 4
5 | 3
6 | 13
7 | 14
8 | 15
9 | 10
10 | 6
11 | 7
12 | 8
13 | 9
14 | 11
15 | 16
16 | 12
17 | 17
seq | node
-----+------
1 | 1
2 | 5
3 | 2
4 | 4
5 | 3
6 | 13
7 | 14
8 | 15
9 | 10
10 | 6
11 | 7
12 | 8
13 | 9
14 | 11
15 | 16
16 | 12
17 | 17
(17 rows)

/* -- q2 */
Expand All @@ -37,25 +37,25 @@ SELECT * FROM pgr_topologicalsort(
UNION
SELECT id, source, target, -1, reverse_cost
FROM edges WHERE cost < 0$$);
seq | sorted_v
-----+----------
1 | 5
2 | 2
3 | 4
4 | 13
5 | 14
6 | 1
7 | 3
8 | 15
9 | 10
10 | 6
11 | 7
12 | 8
13 | 9
14 | 11
15 | 12
16 | 16
17 | 17
seq | node
-----+------
1 | 5
2 | 2
3 | 4
4 | 13
5 | 14
6 | 1
7 | 3
8 | 15
9 | 10
10 | 6
11 | 7
12 | 8
13 | 9
14 | 11
15 | 12
16 | 16
17 | 17
(17 rows)

/* -- q3 */
Expand Down
2 changes: 1 addition & 1 deletion docqueries/transitiveClosure/transitiveClosure.pg
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
SELECT * FROM pgr_transitiveclosure(
'SELECT id, source, target, cost, reverse_cost
FROM edges WHERE id IN (2, 3, 5, 11, 12, 13, 15)')
ORDER BY vid;
ORDER BY node;
/* -- q2 */
Loading