issue 2907 standardize output columns pgr_bellmanFord

NEWS.md

@@ -68,18 +68,47 @@ Functions promoted to official
 * pgr_maxFlow(Combinations)
 * pgr_pushRelabel(Combinations)
 
-SQL signatures modification on functions
+SQL signatures and output standardization
 ...............................................................................
 
+[#2904](https://github.com/pgRouting/pgrouting/issues/2904)
+Standardize output columns of functions with different output columns within overloads
+
+
 **Official functions**
 
 * [#2906](https://github.com/pgRouting/pgrouting/issues/2906) pgr_bdDijkstra
 
   * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
   * Combinations signature promoted to official.
 
+* [#2905](https://github.com/pgRouting/pgrouting/issues/2905) 
+   pgr_withPoints
+
+  * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
+  * Function promoted to official.
+  * Signature change: ``driving_side`` parameter changed from named optional to
+    unnamed positional.
+    - Directed graph valid values: ``l`` or ``L`` and ``r``, ``R``
+    - Undirected graph valid values: ``b`` or ``B``
+
+* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
+  pgr_withPointsCost
+
+  * Function promoted to official.
+  * Output columns standardized to ``(start_vid, end_vid, agg_cost)``
+  * Signature change: ``driving_side`` parameter changed from named optional to
+    unnamed positional.
+    - Directed graph valid values: ``l`` or ``L`` and ``r``, ``R``
+    - Undirected graph valid values: ``b`` or ``B``
+
 **Experimental functions**
 
+* [#2907](https://github.com/pgRouting/pgrouting/issues/2907)
+  pgr_bellmanFord
+
+  * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
+
 * [#2910](https://github.com/pgRouting/pgrouting/issues/2910)
   pgr_edwardMoore
 

doc/bellman_ford/pgr_bellmanFord.rst

@@ -24,6 +24,10 @@
 
 .. rubric:: Availability:
 
+.. rubric:: Version 4.0.0
+
+* Output columns standardized to |short-generic-result|
+
 .. rubric:: Version 3.2.0
 
 * New experimental signature:
@@ -87,7 +91,7 @@ Signatures
    | pgr_bellmanFord(`Edges SQL`_, **start vids**, **end vids**, [``directed``])
    | pgr_bellmanFord(`Edges SQL`_, `Combinations SQL`_, [``directed``])
 
-   | Returns set of |old-generic-result|
+   | Returns set of |short-generic-result|
    | OR EMPTY SET
 
 .. index::
@@ -101,7 +105,7 @@ One to One
 
    | pgr_bellmanFord(`Edges SQL`_, **start vid**, **end vid**, [``directed``])
 
-   | Returns set of |result-1-1|
+   | Returns set of |short-generic-result|
    | OR EMPTY SET
 
 :Example: From vertex :math:`6` to vertex :math:`10` on a **directed** graph
@@ -121,7 +125,7 @@ One to Many
 
    | pgr_bellmanFord(`Edges SQL`_, **start vid**, **end vids**, [``directed``])
 
-   | Returns set of |result-1-m|
+   | Returns set of |short-generic-result|
    | OR EMPTY SET
 
 :Example: From vertex :math:`6` to vertices :math:`\{10, 17\}` on a **directed**
@@ -142,7 +146,7 @@ Many to One
 
    | pgr_bellmanFord(`Edges SQL`_, **start vids**, **end vid**, [``directed``])
 
-   | Returns set of |result-m-1|
+   | Returns set of |short-generic-result|
    | OR EMPTY SET
 
 :Example: From vertices :math:`\{6, 1\}` to vertex :math:`17` on a **directed**
@@ -187,7 +191,7 @@ Combinations
    | Returns set of |short-generic-result|
    | OR EMPTY SET
 
-:Example: Using a combinations table on an **undirected** graph.
+:Example: Using a combinations table on an **undirected** graph
 
 The combinations table:
 
@@ -236,8 +240,8 @@ Result columns
 -------------------------------------------------------------------------------
 
 .. include:: pgRouting-concepts.rst
-    :start-after: return_path_short_start
-    :end-before: return_path_short_end
+    :start-after: return_path_complete_start
+    :end-before: return_path_complete_end
 
 Additional Examples
 -------------------------------------------------------------------------------

doc/src/migration.rst

@@ -79,7 +79,9 @@ types.
      - `Migration of spanning tree functions`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_bdDijkstra` [1]_
      - `Migration of single path functions`_
-   * - .. versionchanged:: 4.0.0 ``pgr_edwardMoore`` [3]_
+   * - .. versionchanged:: 4.0.0 :doc:`pgr_bellmanFord` [3]_
+     - `Migration of single path functions`_
+   * - .. versionchanged:: 4.0.0 :doc:`pgr_edwardMoore` [3]_
      - `Migration of single path functions`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_withPoints` [2]_
      - `Migration of single path functions`_
@@ -88,13 +90,6 @@ types.
    * - .. versionchanged:: 4.0.0 :doc:`pgr_withPointsCostMatrix` [2]_
      - `Migration of cost functions`_
 
-
-..
-   * - .. versionchanged:: 4.0.0 :doc:`pgr_bellmanFord`
-     - `Migration of single path functions`_
-   * - .. versionchanged:: 4.0.0 :doc:`pgr_binaryBreadthFirstSearch`
-     - `Migration of single path functions`_
-
 .. [1] Official function before v4.0.0
 .. [2] Official function in v4.0.0
 .. [3] Experimental or proposed in v4.0.0
@@ -306,29 +301,24 @@ application.
    * - Function
      - Version
      - From
-   * - ``pgr_aStar``
-     - v < 3.6
-     - |old-generic-result|
    * - ``pgr_dijkstra``
      - v < 3.5
      - |old-generic-result|
-   * - ``pgr_bdDijkstra``
-     - v < 4.0
+   * - ``pgr_aStar``
+     - v < 3.6
      - |old-generic-result|
-   * - ``pgr_withPoints``
-     - v < 4.0
-     - |old-pid-result|
-   * - ``pgr_edwardMoore``
+   * - ``pgr_bdDijkstra``
      - v < 4.0
      - |old-generic-result|
-
-..
    * - ``pgr_bellmanFord``
      - v < 4.0
      - |old-generic-result|
-   * - ``pgr_BinaryBreadthFirstSearch``
+   * - ``pgr_edwardMoore``
      - v < 4.0
      - |old-generic-result|
+   * - ``pgr_withPoints``
+     - v < 4.0
+     - |old-pid-result|
 
 :to: |short-generic-result|
 

doc/src/release_notes.rst

@@ -89,9 +89,13 @@ Functions promoted to official
 * pgr_maxFlow(Combinations)
 * pgr_pushRelabel(Combinations)
 
-SQL signatures modification on functions
+SQL signatures and output standardization
 ...............................................................................
 
+`#2904 <https://github.com/pgRouting/pgrouting/issues/2904>`__
+Standardize output columns of functions with different output columns within overloads
+
+
 .. rubric:: Official functions
 
 * `#2906 <https://github.com/pgRouting/pgrouting/issues/2906>`__ pgr_bdDijkstra
@@ -100,8 +104,29 @@ SQL signatures modification on functions
      :start-after: Version 4.0.0
      :end-before: .. rubric
 
+* `#2905 <https://github.com/pgRouting/pgrouting/issues/2905>`__ 
+   pgr_withPoints
+
+  .. include:: pgr_withPoints.rst
+     :start-after: Version 4.0.0
+     :end-before: .. rubric
+
+* `#2905 <https://github.com/pgRouting/pgrouting/issues/2905>`__
+  pgr_withPointsCost
+
+  .. include:: pgr_withPointsCost.rst
+     :start-after: Version 4.0.0
+     :end-before: .. rubric
+
 .. rubric:: Experimental functions
 
+* `#2907 <https://github.com/pgRouting/pgrouting/issues/2907>`__
+  pgr_bellmanFord
+
+  .. include:: pgr_bellmanFord.rst
+     :start-after: Version 4.0.0
+     :end-before: .. rubric
+
 * `#2910 <https://github.com/pgRouting/pgrouting/issues/2910>`__
   pgr_edwardMoore
 

docqueries/bellman_ford/bellmanFord.result

@@ -6,52 +6,52 @@ SET
 SELECT * FROM pgr_bellmanFord(
   'SELECT id, source, target, cost, reverse_cost FROM edges',
   6, 10, true);
- seq | path_seq | node | edge | cost | agg_cost
------+----------+------+------+------+----------
-   1 |        1 |    6 |    4 |    1 |        0
-   2 |        2 |    7 |    8 |    1 |        1
-   3 |        3 |   11 |    9 |    1 |        2
-   4 |        4 |   16 |   16 |    1 |        3
-   5 |        5 |   15 |    3 |    1 |        4
-   6 |        6 |   10 |   -1 |    0 |        5
+ seq | path_seq | start_vid | end_vid | node | edge | cost | agg_cost
+-----+----------+-----------+---------+------+------+------+----------
+   1 |        1 |         6 |      10 |    6 |    4 |    1 |        0
+   2 |        2 |         6 |      10 |    7 |    8 |    1 |        1
+   3 |        3 |         6 |      10 |   11 |    9 |    1 |        2
+   4 |        4 |         6 |      10 |   16 |   16 |    1 |        3
+   5 |        5 |         6 |      10 |   15 |    3 |    1 |        4
+   6 |        6 |         6 |      10 |   10 |   -1 |    0 |        5
 (6 rows)
 
 /* -- q3 */
 SELECT * FROM pgr_bellmanFord(
   'SELECT id, source, target, cost, reverse_cost FROM edges',
   6, ARRAY[10, 17]);
- seq | path_seq | end_vid | node | edge | cost | agg_cost
------+----------+---------+------+------+------+----------
-   1 |        1 |      10 |    6 |    4 |    1 |        0
-   2 |        2 |      10 |    7 |    8 |    1 |        1
-   3 |        3 |      10 |   11 |    9 |    1 |        2
-   4 |        4 |      10 |   16 |   16 |    1 |        3
-   5 |        5 |      10 |   15 |    3 |    1 |        4
-   6 |        6 |      10 |   10 |   -1 |    0 |        5
-   7 |        1 |      17 |    6 |    4 |    1 |        0
-   8 |        2 |      17 |    7 |    8 |    1 |        1
-   9 |        3 |      17 |   11 |   11 |    1 |        2
-  10 |        4 |      17 |   12 |   13 |    1 |        3
-  11 |        5 |      17 |   17 |   -1 |    0 |        4
+ seq | path_seq | start_vid | end_vid | node | edge | cost | agg_cost
+-----+----------+-----------+---------+------+------+------+----------
+   1 |        1 |         6 |      10 |    6 |    4 |    1 |        0
+   2 |        2 |         6 |      10 |    7 |    8 |    1 |        1
+   3 |        3 |         6 |      10 |   11 |    9 |    1 |        2
+   4 |        4 |         6 |      10 |   16 |   16 |    1 |        3
+   5 |        5 |         6 |      10 |   15 |    3 |    1 |        4
+   6 |        6 |         6 |      10 |   10 |   -1 |    0 |        5
+   7 |        1 |         6 |      17 |    6 |    4 |    1 |        0
+   8 |        2 |         6 |      17 |    7 |    8 |    1 |        1
+   9 |        3 |         6 |      17 |   11 |   11 |    1 |        2
+  10 |        4 |         6 |      17 |   12 |   13 |    1 |        3
+  11 |        5 |         6 |      17 |   17 |   -1 |    0 |        4
 (11 rows)
 
 /* -- q4 */
 SELECT * FROM pgr_bellmanFord(
   'SELECT id, source, target, cost, reverse_cost FROM edges',
   ARRAY[6, 1], 17);
- seq | path_seq | start_vid | node | edge | cost | agg_cost
------+----------+-----------+------+------+------+----------
-   1 |        1 |         1 |    1 |    6 |    1 |        0
-   2 |        2 |         1 |    3 |    7 |    1 |        1
-   3 |        3 |         1 |    7 |    8 |    1 |        2
-   4 |        4 |         1 |   11 |   11 |    1 |        3
-   5 |        5 |         1 |   12 |   13 |    1 |        4
-   6 |        6 |         1 |   17 |   -1 |    0 |        5
-   7 |        1 |         6 |    6 |    4 |    1 |        0
-   8 |        2 |         6 |    7 |    8 |    1 |        1
-   9 |        3 |         6 |   11 |   11 |    1 |        2
-  10 |        4 |         6 |   12 |   13 |    1 |        3
-  11 |        5 |         6 |   17 |   -1 |    0 |        4
+ seq | path_seq | start_vid | end_vid | node | edge | cost | agg_cost
+-----+----------+-----------+---------+------+------+------+----------
+   1 |        1 |         1 |      17 |    1 |    6 |    1 |        0
+   2 |        2 |         1 |      17 |    3 |    7 |    1 |        1
+   3 |        3 |         1 |      17 |    7 |    8 |    1 |        2
+   4 |        4 |         1 |      17 |   11 |   11 |    1 |        3
+   5 |        5 |         1 |      17 |   12 |   13 |    1 |        4
+   6 |        6 |         1 |      17 |   17 |   -1 |    0 |        5
+   7 |        1 |         6 |      17 |    6 |    4 |    1 |        0
+   8 |        2 |         6 |      17 |    7 |    8 |    1 |        1
+   9 |        3 |         6 |      17 |   11 |   11 |    1 |        2
+  10 |        4 |         6 |      17 |   12 |   13 |    1 |        3
+  11 |        5 |         6 |      17 |   17 |   -1 |    0 |        4
 (11 rows)
 
 /* -- q5 */