Fix 2924 standardize pgr edge coloring

NEWS.md

@@ -16,16 +16,31 @@ milestone for 4.0.0
 
 Summary of changes by function
 
-* pgr_contraction
+* pgr_aStar
 
-  * Breaking change, signatures no longer available:
-    * pgr_contraction(text,bigint[],integer,bigint[],boolean)
+  * Combinations signature promoted to official.
+
+* pgr_aStarCost
+
+  * Combinations signature promoted to official.
+
+* pgr_bdAstar
+
+  * Combinations signature promoted to official.
+
+* pgr_bdAstarCost
+
+  * Combinations signature promoted to official.
 
 * pgr_bdDijkstra
 
   * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
   * Combinations signature promoted to official.
 
+* pgr_bdDijkstraCost
+
+  * Combinations signature promoted to official.
+
 * pgr_bellmanFord
 
   * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
@@ -34,14 +49,44 @@ Summary of changes by function
 
   * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 
-* pgr_edwardMoore
+* pgr_contraction
+
+  .. Breaking change
+  * Breaking change, signatures no longer available:
+    * pgr_contraction(text,bigint[],integer,bigint[],boolean)
+
+* pgr_dagShortestPath
 
   * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 
-* pgr_DAGshortestPath
+* pgr_dijkstra
+
+  * Combinations signature promoted to official.
+
+* pgr_dijkstraCost
+
+  * Combinations signature promoted to official.
+
+* pgr_edgeColoring
+
+  * Output columns standardized to ``(edge, color)``
+
+* pgr_edwardMoore
 
   * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 
+* pgr_KSP
+
+  * All signatures promoted to official.
+
+* pgr_maxFlow
+
+  * Combinations signature promoted to official.
+
+* pgr_pushRelabel
+
+  * Combinations signature promoted to official.
+
 * pgr_trsp
 
   * Function promoted to official.
@@ -53,6 +98,7 @@ Summary of changes by function
 * pgr_trspVia
 
   * Function promoted to official.
+  .. Breaking change
   * Breaking change, signatures no longer available:
     * pgr_trspviavertices(text,anyarray,boolean,boolean,text)
 
@@ -147,17 +193,17 @@ Functions promoted to official
   pgr_trspVia_withPoints
 * [#2701](https://github.com/pgRouting/pgrouting/issues/2701)
   pgr_trsp_withPoints
-* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
+* [#2700](https://github.com/pgRouting/pgrouting/issues/2700)
   pgr_withPoints
-* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
+* [#2700](https://github.com/pgRouting/pgrouting/issues/2700)
   pgr_withPointsCost
-* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
+* [#2700](https://github.com/pgRouting/pgrouting/issues/2700)
   pgr_withPointsCostMatrix
-* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
+* [#2700](https://github.com/pgRouting/pgrouting/issues/2700)
   pgr_withPointsDD
-* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
+* [#2700](https://github.com/pgRouting/pgrouting/issues/2700)
   pgr_withPointsKSP
-* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
+* [#2700](https://github.com/pgRouting/pgrouting/issues/2700)
   pgr_withPointsVia
 
 Signatures promoted to official
@@ -216,6 +262,11 @@ Standardize output columns of functions with different output columns within ove
 * [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
   pgr_withPointsCostMatrix
 
+**Standardized to ``(edge, color)``**
+
+* [#2924](https://github.com/pgRouting/pgrouting/issues/2924)
+  pgr_edgeColoring
+
 Removal of SQL deprecated signatures
 
 * [#2798](https://github.com/pgRouting/pgrouting/issues/2798):
@@ -228,6 +279,10 @@ Removal of SQL deprecated signatures
     * pgr_trsp(text,integer,integer,boolean,boolean,text)
     * pgr_trsp(text,integer,double precision,integer,double precision,boolean,boolean,text)
 
+* [#2683](https://github.com/pgRouting/pgrouting/issues/2683): pgr_trspVia
+
+    * pgr_trspviavertices(text,anyarray,boolean,boolean,text)
+
 * [#2700](https://github.com/pgRouting/pgrouting/issues/2700):
   pgr_withPointsVia
 
@@ -385,9 +440,6 @@ Summary of functions and signatures no longer on pgrouting
 * #2919 pgr_withpoints(text,text,text,boolean,character,boolean)
 * #2919 pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean)
 
-**Internal functions**
-
-
 Code enhancements
 
 * Removal of unused C/C++ code

doc/coloring/coloring-family.rst

@@ -49,37 +49,37 @@ Coloring - Family of functions
 Result columns
 -------------------------------------------------------------------------------
 
-.. result columns start
+.. result-edge-color-start
 
-Returns set of ``(vertex_id, color_id)``
+Returns set of |result_edge_color|
 
 ===============  =========== ======================================
 Column           Type        Description
 ===============  =========== ======================================
-``vertex_id``    ``BIGINT``  Identifier of the vertex.
-``color_id``     ``BIGINT``  Identifier of the color of the vertex.
+``edge``         ``BIGINT``  Identifier of the edge.
+``color``        ``BIGINT``  Color of the edge.
 
                              - The minimum value of color is 1.
 
 ===============  =========== ======================================
 
-.. result columns end
+.. result-edge-color-end
 
-.. result columns start edgeColoring
+.. result columns start
 
-Returns set of ``(edge_id, color_id)``
+Returns set of ``(vertex_id, color_id)``
 
-===============  =========== =====================================
+===============  =========== ======================================
 Column           Type        Description
-===============  =========== =====================================
-``edge_id``      ``BIGINT``  Identifier of the edge.
-``color_id``     ``BIGINT``  Identifier of the color of the edge.
+===============  =========== ======================================
+``vertex_id``    ``BIGINT``  Identifier of the vertex.
+``color_id``     ``BIGINT``  Identifier of the color of the vertex.
 
                              - The minimum value of color is 1.
 
-===============  =========== =====================================
+===============  =========== ======================================
 
-.. result columns end edgeColoring
+.. result columns end
 
 See Also
 -------------------------------------------------------------------------------

doc/coloring/pgr_edgeColoring.rst

@@ -25,9 +25,13 @@ graphs
 
 .. rubric:: Availability
 
-* Version 3.3.0
+.. rubric:: Version 4.0.0
 
-  * New experimental function.
+* Output columns standardized to |result_edge_color|
+
+.. rubric:: Version 3.3.0
+
+* New experimental function.
 
 Description
 -------------------------------------------------------------------------------
@@ -77,7 +81,7 @@ Signatures
 
    | pgr_edgeColoring(`Edges SQL`_)
 
-   | Returns set of |result-edge-color|
+   | Returns set of |result_edge_color|
    | OR EMPTY SET
 
 :Example: Graph coloring of pgRouting :doc:`sampledata`
@@ -109,8 +113,8 @@ Result columns
 -------------------------------------------------------------------------------
 
 .. include:: coloring-family.rst
-    :start-after: result columns start edgeColoring
-    :end-before: result columns end edgeColoring
+    :start-after: result-edge-color-start
+    :end-before: result-edge-color-end
 
 
 See Also

doc/conf.py.in

@@ -365,7 +365,7 @@ rst_epilog="""
 .. |result-1-1-no-seq| replace:: ``(seq, node, edge, cost, agg_cost)``
 .. |result-m-1-no-seq| replace:: ``(seq, start_vid, node, edge, cost, agg_cost)``
 .. |result-node-color| replace:: ``(vertex_id, color_id)``
-.. |result-edge-color| replace:: ``(edge_id, color_id)``
+.. |result_edge_color| replace:: ``(edge, color)``
 .. |result-node| replace:: ``(node)``
 .. |result-edge| replace:: ``(edge)``
 .. |result-separate| replace:: ``(seq,id,sub_id,geom)``

doc/contraction/pgr_contraction.rst

@@ -24,6 +24,8 @@ vertices and edges.
 
 .. rubric:: Version 4.0.0
 
+.. Breaking change
+
 * Breaking change, signatures no longer available:
 
   * pgr_contraction(text,bigint[],integer,bigint[],boolean)

doc/dijkstra/pgr_dijkstra.rst

@@ -21,43 +21,43 @@
 
 .. rubric:: Availability
 
-* Version 4.0.0
+.. rubric:: Version 4.0.0
 
-  * Combinations signature promoted to official.
+* Combinations signature promoted to official.
 
-* Version 3.5.0
+.. rubric:: Version 3.5.0
 
-  * Standardizing output columns to |short-generic-result|
+* Standardizing output columns to |short-generic-result|
 
-    * pgr_dijkstra(One to One) added ``start_vid`` and ``end_vid`` columns.
-    * pgr_dijkstra(One to Many) added ``end_vid`` column.
-    * pgr_dijkstra(Many to One) added ``start_vid`` column.
+  * pgr_dijkstra(One to One) added ``start_vid`` and ``end_vid`` columns.
+  * pgr_dijkstra(One to Many) added ``end_vid`` column.
+  * pgr_dijkstra(Many to One) added ``start_vid`` column.
 
-* Version 3.1.0
+.. rubric:: Version 3.1.0
 
-  * New proposed signature:
+* New proposed signature:
 
-    * pgr_dijkstra(Combinations)
+  * pgr_dijkstra(Combinations)
 
-* Version 3.0.0
+.. rubric:: Version 3.0.0
 
-  * Function promoted to official.
+* Function promoted to official.
 
-* Version 2.2.0
+.. rubric:: Version 2.2.0
 
-  * New proposed signatures:
+* New proposed signatures:
 
-    * pgr_dijkstra(One to Many)
-    * pgr_dijkstra(Many to One)
-    * pgr_dijkstra(Many to Many)
+  * pgr_dijkstra(One to Many)
+  * pgr_dijkstra(Many to One)
+  * pgr_dijkstra(Many to Many)
 
-* Version 2.1.0
+.. rubric:: Version 2.1.0
 
-  * Signature change on pgr_dijkstra(One to One)
+* Signature change on pgr_dijkstra(One to One)
 
-* Version 2.0.0
+.. rubric:: Version 2.0.0
 
-  * Official function.
+* Official function.
 
 
 Description

doc/dijkstra/pgr_dijkstraCost.rst

@@ -23,19 +23,19 @@ algorithm.
 
 .. rubric:: Availability
 
-* Version 4.0.0
+.. rubric:: Version 4.0.0
 
-  * Combinations signature promoted to official.
+* Combinations signature promoted to official.
 
-* Version 3.1.0
+.. rubric:: Version 3.1.0
 
-  * New proposed signature:
+* New proposed signature:
 
-    * pgr_dijkstraCost(Combinations)
+  * pgr_dijkstraCost(Combinations)
 
-* Version 2.2.0
+.. rubric:: Version 2.2.0
 
-  * Official function.
+* Official function.
 
 
 Description

doc/ksp/pgr_KSP.rst

@@ -20,9 +20,9 @@
 
 .. rubric:: Availability
 
-* Version 4.0.0
+.. rubric:: Version 4.0.0
 
-  * All signatures promoted to official.
+* All signatures promoted to official.
 
 .. rubric:: Version 3.6.0
 

doc/max_flow/pgr_maxFlow.rst

@@ -21,23 +21,23 @@ source(s) to the targets(s) using the Push Relabel 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_maxFlow(Combinations)
+  * pgr_maxFlow(Combinations)
 
-* Version 3.0.0
+.. rubric:: Version 3.0.0
 
-  *  Function promoted to official.
+*  Function promoted to official.
 
-* Version 2.4.0
+.. rubric:: Version 2.4.0
 
-  * New proposed function.
+* New proposed function.
 
 
 Description