Standarizing output spanning tree functions

NEWS.md

@@ -9,6 +9,27 @@ To see all issues & pull requests closed by this release see the [Git closed
 milestone for 3.7.0
 ](https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%203.7.0%22)
 
+**Official functions changes**
+
+* [#2605](https://github.com/pgRouting/pgrouting/pull/2605) Standarize
+  spanning tree functions output
+
+  * Functions:
+
+    * ``pgr_kruskalDD``
+    * ``pgr_kruskalDFS``
+    * ``pgr_kruskalBFS``
+    * ``pgr_primDD``
+    * ``pgr_primDFS``
+    * ``pgr_primBFS``
+
+
+  * Standarizing output columns to ``(seq, depth, start_vid, pred, node, edge, cost, agg_cost)``
+
+    * Added ``pred`` result columns.
+
+
+
 **Code enhancement**
 
 * [#2599](https://github.com/pgRouting/pgrouting/pull/2599)  Driving distance

doc/driving_distance/drivingDistance-category.rst

@@ -61,7 +61,7 @@ Calculate nodes that are within a distance.
 Parameters
 -------------------------------------------------------------------------------
 
-.. mst-dd-params_start
+.. spantree-params_start
 
 .. list-table::
    :width: 81
@@ -91,7 +91,7 @@ Where:
 
 :ANY-NUMERIC: ``SMALLINT``, ``INTEGER``, ``BIGINT``, ``REAL``, ``FLOAT``
 
-.. mst-dd-params_end
+.. spantree-params_end
 
 Inner Queries
 -------------------------------------------------------------------------------

doc/driving_distance/pgr_drivingDistance.rst

@@ -108,8 +108,8 @@ Parameters
 -------------------------------------------------------------------------------
 
 .. include:: drivingDistance-category.rst
-    :start-after: mst-dd-params_start
-    :end-before: mst-dd-params_end
+    :start-after: spantree-params_start
+    :end-before: spantree-params_end
 
 Optional parameters
 ...............................................................................

doc/spanningTree/pgr_kruskalBFS.rst

@@ -23,10 +23,15 @@ First Search ordering.
 
 .. rubric:: Availability
 
-* Version 3.0.0
+:Version 3.7.0:
 
-  * New **Official** function
+* Standarizing output columns to |result-spantree|
+
+  * Added ``pred`` result columns.
 
+:Version 3.0.0:
+
+  * New **Official** function
 
 Description
 -------------------------------------------------------------------------------
@@ -52,7 +57,7 @@ Signatures
    | pgr_kruskalBFS(`Edges SQL`_, **root vid**, [``max_depth``])
    | pgr_kruskalBFS(`Edges SQL`_, **root vids**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 .. index::
     single: kruskalBFS(Single vertex)
@@ -65,7 +70,7 @@ Single vertex
 
    | pgr_kruskalBFS(`Edges SQL`_, **root vid**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree having as root vertex :math:`6`
 
@@ -84,7 +89,7 @@ Multiple vertices
 
    | pgr_kruskalBFS(`Edges SQL`_, **root vids**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with
           :math:`depth \leq 3`
@@ -96,9 +101,9 @@ Multiple vertices
 Parameters
 -------------------------------------------------------------------------------
 
-.. include:: BFS-category.rst
-   :start-after: mst-bfs-dfs-params_start
-   :end-before: mst-bfs-dfs-params_end
+.. include:: drivingDistance-category.rst
+    :start-after: spantree-params_start
+    :end-before: spantree-params_end
 
 BFS optional parameters
 ...............................................................................
@@ -111,7 +116,7 @@ Inner Queries
 -------------------------------------------------------------------------------
 
 Edges SQL
-...............................................................................
+..............................................................................
 
 .. include:: pgRouting-concepts.rst
    :start-after: basic_edges_sql_start
@@ -120,9 +125,9 @@ Edges SQL
 Result columns
 -------------------------------------------------------------------------------
 
-.. include:: BFS-category.rst
-   :start-after: mst-bfs-dfs-dd-result-columns-start
-   :end-before: mst-bfs-dfs-dd-result-columns-end
+.. include:: drivingDistance-category.rst
+   :start-after: spantree-result-columns-start
+   :end-before: spantree-result-columns-end
 
 See Also
 -------------------------------------------------------------------------------

doc/spanningTree/pgr_kruskalDD.rst

@@ -22,7 +22,13 @@
 
 .. rubric:: Availability
 
-* Version 3.0.0
+:Version 3.7.0:
+
+* Standarizing output columns to |result-spantree|
+
+  * Added ``pred`` result columns.
+
+:Version 3.0.0:
 
   * New **Official** function
 
@@ -55,7 +61,7 @@ Signatures
    | pgr_kruskalDD(`Edges SQL`_, **root vid**, **distance**)
    | pgr_kruskalDD(`Edges SQL`_, **root vids**, **distance**)
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 .. index::
     single: kruskalDD(Single vertex)
@@ -68,7 +74,7 @@ Single vertex
 
    | pgr_kruskalDD(`Edges SQL`_, **root vid**, **distance**)
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree starting on vertex :math:`6` with
           :math:`distance \leq 3.5`
@@ -88,7 +94,7 @@ Multiple vertices
 
    | pgr_kruskalDD(`Edges SQL`_, **root vids**, **distance**)
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with
           :math:`distance \leq 3.5`
@@ -101,8 +107,8 @@ Parameters
 -------------------------------------------------------------------------------
 
 .. include:: drivingDistance-category.rst
-   :start-after: mst-dd-params_start
-   :end-before: mst-dd-params_end
+    :start-after: spantree-params_start
+    :end-before: spantree-params_end
 
 Inner Queries
 -------------------------------------------------------------------------------
@@ -117,9 +123,9 @@ Edges SQL
 Result columns
 -------------------------------------------------------------------------------
 
-.. include:: BFS-category.rst
-   :start-after: mst-bfs-dfs-dd-result-columns-start
-   :end-before: mst-bfs-dfs-dd-result-columns-end
+.. include:: drivingDistance-category.rst
+   :start-after: spantree-result-columns-start
+   :end-before: spantree-result-columns-end
 
 See Also
 -------------------------------------------------------------------------------

doc/spanningTree/pgr_kruskalDFS.rst

@@ -23,7 +23,13 @@ First Search ordering.
 
 .. rubric:: Availability
 
-* Version 3.0.0
+:Version 3.7.0:
+
+* Standarizing output columns to |result-spantree|
+
+  * Added ``pred`` result columns.
+
+:Version 3.0.0:
 
   * New **Official** function
 
@@ -52,7 +58,7 @@ Signatures
    | pgr_kruskalDFS(`Edges SQL`_, **root vid**, [``max_depth``])
    | pgr_kruskalDFS(`Edges SQL`_, **root vids**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 .. index::
     single: kruskalDFS(Single vertex)
@@ -65,7 +71,7 @@ Single vertex
 
    | pgr_kruskalDFS(`Edges SQL`_, **root vid**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree having as root vertex :math:`6`
 
@@ -84,7 +90,7 @@ Multiple vertices
 
    | pgr_kruskalDFS(`Edges SQL`_, **root vids**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with
           :math:`depth \leq 3`
@@ -96,9 +102,9 @@ Multiple vertices
 Parameters
 -------------------------------------------------------------------------------
 
-.. include:: BFS-category.rst
-   :start-after: mst-bfs-dfs-params_start
-   :end-before: mst-bfs-dfs-params_end
+.. include:: drivingDistance-category.rst
+    :start-after: spantree-params_start
+    :end-before: spantree-params_end
 
 DFS optional parameters
 ...............................................................................
@@ -111,7 +117,7 @@ Inner Queries
 -------------------------------------------------------------------------------
 
 Edges SQL
-...............................................................................
+..............................................................................
 
 .. include:: pgRouting-concepts.rst
    :start-after: basic_edges_sql_start
@@ -120,9 +126,9 @@ Edges SQL
 Result columns
 -------------------------------------------------------------------------------
 
-.. include:: BFS-category.rst
-   :start-after: mst-bfs-dfs-dd-result-columns-start
-   :end-before: mst-bfs-dfs-dd-result-columns-end
+.. include:: drivingDistance-category.rst
+   :start-after: spantree-result-columns-start
+   :end-before: spantree-result-columns-end
 
 See Also
 -------------------------------------------------------------------------------

doc/spanningTree/pgr_primBFS.rst

@@ -23,16 +23,21 @@ Search ordering.
 
 .. rubric:: Availability
 
-* Version 3.0.0
+:Version 3.7.0:
 
-  * New **Official** function
+* Standarizing output columns to |result-spantree|
+
+  * Added ``pred`` result columns.
 
+:Version 3.0.0:
+
+  * New **Official** function
 
 Description
 -------------------------------------------------------------------------------
 
 Visits and extracts the nodes information in Breath First Search ordering
-of the Minimum Spanning Tree created with Prims's algorithm.
+of the Minimum Spanning Tree created using Prims's algorithm.
 
 **The main Characteristics are:**
 
@@ -52,7 +57,7 @@ Signatures
    | pgr_primBFS(`Edges SQL`_, **root vid**, [``max_depth``])
    | pgr_primBFS(`Edges SQL`_, **root vids**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 .. index::
     single: primBFS(Single vertex)
@@ -65,7 +70,7 @@ Single vertex
 
    | pgr_primBFS(`Edges SQL`_, **root vid**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree having as root vertex :math:`6`
 
@@ -84,7 +89,7 @@ Multiple vertices
 
    | pgr_primBFS(`Edges SQL`_, **root vids**, [``max_depth``])
 
-   | Returns set of |result-bfs|
+   | Returns set of |result-spantree|
 
 :Example: The Minimum Spanning Tree starting on vertices :math:`\{9, 6\}` with
           :math:`depth \leq 3`
@@ -96,9 +101,9 @@ Multiple vertices
 Parameters
 -------------------------------------------------------------------------------
 
-.. include:: BFS-category.rst
-   :start-after: mst-bfs-dfs-params_start
-   :end-before: mst-bfs-dfs-params_end
+.. include:: drivingDistance-category.rst
+    :start-after: spantree-params_start
+    :end-before: spantree-params_end
 
 BFS optional parameters
 ...............................................................................
@@ -111,25 +116,25 @@ Inner Queries
 -------------------------------------------------------------------------------
 
 Edges SQL
-...............................................................................
+..............................................................................
 
 .. include:: pgRouting-concepts.rst
-    :start-after: basic_edges_sql_start
-    :end-before: basic_edges_sql_end
+   :start-after: basic_edges_sql_start
+   :end-before: basic_edges_sql_end
 
 Result columns
 -------------------------------------------------------------------------------
 
-.. include:: BFS-category.rst
-   :start-after: mst-bfs-dfs-dd-result-columns-start
-   :end-before: mst-bfs-dfs-dd-result-columns-end
+.. include:: drivingDistance-category.rst
+   :start-after: spantree-result-columns-start
+   :end-before: spantree-result-columns-end
 
 See Also
 -------------------------------------------------------------------------------
 
 * :doc:`spanningTree-family`
 * :doc:`prim-family`
-* The queries use the :doc:`sampledata` network.
+* :doc:`sampledata`
 * `Boost: Prim's algorithm documentation
   <https://www.boost.org/libs/graph/doc/prim_minimum_spanning_tree.html>`__
 * `Wikipedia: Prim's algorithm