Promotion of functions to official (#2721)

* (doc/withPoints) with points functions promoted to official * (doc/trsp) trsp functions promoted to official * (doc/Combinations) combinations signatures promoted to official * (doc) Updating release notes and NEWS
pgRouting · Jan 15, 2025 · 4a97025 · 4a97025
1 parent 7fefaf7
commit 4a97025
Show file tree

Hide file tree

Showing 35 changed files with 228 additions and 146 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -8,6 +8,40 @@
 
 ### pgRouting 4.0.0 Release Notes
 
+To see all issues & pull requests closed by this release see the [Git closed
+milestone for 4.0.0
+](https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%204.0.0%22)
+
+**Functions promoted to official**
+
+* pgr_trsp
+* pgr_trspVia
+* pgr_trspVia_withPoints
+* pgr_trsp_withPoints
+* pgr_withPoints
+* pgr_withPointsCost
+* pgr_withPointsCostMatrix
+* pgr_withPointsDD
+* pgr_withPointsKSP
+* pgr_withPointsVia
+
+**Signatures promoted to official**
+
+* pgr_aStar(Combinations)
+* pgr_aStarCost(Combinations)
+* pgr_bdAstar(Combinations)
+* pgr_bdAstarCost(Combinations)
+* pgr_bdDijkstra(Combinations)
+* pgr_bdDijkstraCost(Combinations)
+* pgr_dijkstra(Combinations)
+* pgr_dijkstraCost(Combinations)
+* pgr_KSP(All signatures)
+* pgr_boykovKolmogorov(Combinations)
+* pgr_edmondsKarp(Combinations)
+* pgr_maxFlow(Combinations)
+* pgr_pushRelabel(Combinations)
+
+
 **Removal of deprecated functions and signatures**
 
 * ``pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text)``

diff --git a/doc/astar/pgr_aStar.rst b/doc/astar/pgr_aStar.rst
@@ -20,6 +20,10 @@
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.6.0
 
   * Standarizing output columns to |short-generic-result|
@@ -184,7 +188,7 @@ Many to Many
    :end-before: -- q51
 
 .. index::
-    single: aStar ; Combinations - Proposed on v3.2
+    single: aStar ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/astar/pgr_aStarCost.rst b/doc/astar/pgr_aStarCost.rst
@@ -21,6 +21,10 @@
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -171,7 +175,7 @@ Many to Many
     :end-before: -- q51
 
 .. index::
-    single: aStarCost ; Combinations - Proposed on v3.2
+    single: aStarCost ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/bdAstar/pgr_bdAstar.rst b/doc/bdAstar/pgr_bdAstar.rst
@@ -20,6 +20,10 @@
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.6.0
 
   * Standarizing output columns to |short-generic-result|
@@ -182,7 +186,7 @@ Many to Many
    :end-before: -- q51
 
 .. index::
-    single: bdAstar ; Combinations - Proposed on v3.2
+    single: bdAstar ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/bdAstar/pgr_bdAstarCost.rst b/doc/bdAstar/pgr_bdAstarCost.rst
@@ -21,6 +21,10 @@ A* algorithm.
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -171,7 +175,7 @@ Many to Many
     :end-before: -- q51
 
 .. index::
-    single: bdAstarCost ; Combinations - Proposed on v3.2
+    single: bdAstarCost ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/bdDijkstra/pgr_bdDijkstra.rst b/doc/bdDijkstra/pgr_bdDijkstra.rst
@@ -21,6 +21,10 @@ algorithm.
 
 .. rubric:: Availability:
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -162,7 +166,7 @@ Many to Many
     :end-before: -- q51
 
 .. index::
-    single: bdDijkstra ; Combinations - Proposed on v3.2
+    single: bdDijkstra ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/bdDijkstra/pgr_bdDijkstraCost.rst b/doc/bdDijkstra/pgr_bdDijkstraCost.rst
@@ -21,6 +21,10 @@ Dijkstra algorithm.
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -153,7 +157,7 @@ Many to Many
     :end-before: -- q51
 
 .. index::
-    single: bdDijkstraCost ; Combinations - Proposed on v3.2
+    single: bdDijkstraCost ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/dijkstra/pgr_dijkstra.rst b/doc/dijkstra/pgr_dijkstra.rst
@@ -21,6 +21,10 @@
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.5.0
 
   * Standarizing output columns to |short-generic-result|
@@ -175,7 +179,7 @@ Many to Many
    :end-before: -- q51
 
 .. index::
-    single: dijkstra ; Combinations - Proposed on v3.1
+    single: dijkstra ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/dijkstra/pgr_dijkstraCost.rst b/doc/dijkstra/pgr_dijkstraCost.rst
@@ -23,6 +23,10 @@ algorithm.
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.1.0
 
   * New proposed signature:
@@ -155,7 +159,7 @@ Many to Many
     :end-before: -- q51
 
 .. index::
-    single: dijkstraCost ; Combinations - Proposed on v3.1
+    single: dijkstraCost ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/ksp/pgr_KSP.rst b/doc/ksp/pgr_KSP.rst
@@ -20,6 +20,10 @@
 
 .. rubric:: Availability
 
+* Version 4.0.0
+
+  * All signatures promoted to official.
+
 .. rubric:: Version 3.6.0
 
 * Result columns standarized to: |nksp-result|
@@ -93,7 +97,7 @@ One to One
     :end-before: --q2
 
 .. index::
-    single: KSP ; One to Many - Proposed on 3.6
+    single: KSP ; One to Many
 
 One to Many
 ...............................................................................
@@ -114,7 +118,7 @@ One to Many
     :end-before: --q3
 
 .. index::
-    single: KSP ; Many to One - Proposed in 3.6
+    single: KSP ; Many to One
 
 Many to One
 ...............................................................................
@@ -135,7 +139,7 @@ Many to One
     :end-before: --q4
 
 .. index::
-    single: KSP ; Many to Many - Proposed in 3.6
+    single: KSP ; Many to Many
 
 Many to Many
 ...............................................................................
@@ -156,7 +160,7 @@ Many to Many
     :end-before: --q5
 
 .. index::
-   single: KSP ; Combinations - Proposed in 3.6
+   single: KSP ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/max_flow/pgr_boykovKolmogorov.rst b/doc/max_flow/pgr_boykovKolmogorov.rst
@@ -21,6 +21,10 @@ the flow from the sources to the targets using Boykov Kolmogorov algorithm.
 
 .. Rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -150,7 +154,7 @@ Many to Many
    :end-before: -- q5
 
 .. index::
-    single: boykovKolmogorov ; Combinations - Proposed on v3.2
+    single: boykovKolmogorov ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/max_flow/pgr_edmondsKarp.rst b/doc/max_flow/pgr_edmondsKarp.rst
@@ -21,6 +21,10 @@ flow from the sources to the targets using Edmonds Karp Algorithm.
 
 .. Rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -150,7 +154,7 @@ Many to Many
    :end-before: -- q5
 
 .. index::
-    single: edmondsKarp ; Combinations - Proposed on v3.2
+    single: edmondsKarp ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/max_flow/pgr_maxFlow.rst b/doc/max_flow/pgr_maxFlow.rst
@@ -21,6 +21,10 @@ source(s) to the targets(s) using the Push Relabel algorithm.
 
 .. Rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -147,7 +151,7 @@ Many to Many
    :end-before: -- q5
 
 .. index::
-    single: maxFlow ; Combinations - Proposed on v3.2
+    single: maxFlow ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/max_flow/pgr_pushRelabel.rst b/doc/max_flow/pgr_pushRelabel.rst
@@ -21,6 +21,10 @@ flow from the sources to the targets using Push Relabel Algorithm.
 
 .. Rubric:: Availability
 
+* Version 4.0.0
+
+  * Combinations signature promoted to official.
+
 * Version 3.2.0
 
   * New proposed signature:
@@ -150,7 +154,7 @@ Many to Many
    :end-before: -- q5
 
 .. index::
-    single: pushRelabel ; Combinations - Proposed on v3.2
+    single: pushRelabel ; Combinations
 
 Combinations
 ...............................................................................

diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst
@@ -39,6 +39,40 @@ pgRouting 4.0
 pgRouting 4.0.0 Release Notes
 -------------------------------------------------------------------------------
 
+To see all issues & pull requests closed by this release see the `Git closed
+milestone for 4.0.0
+<https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%204.0.0%22>`__
+
+.. rubric:: Functions promoted to official
+
+* pgr_trsp
+* pgr_trspVia
+* pgr_trspVia_withPoints
+* pgr_trsp_withPoints
+* pgr_withPoints
+* pgr_withPointsCost
+* pgr_withPointsCostMatrix
+* pgr_withPointsDD
+* pgr_withPointsKSP
+* pgr_withPointsVia
+
+.. rubric:: Signatures promoted to official
+
+* pgr_aStar(Combinations)
+* pgr_aStarCost(Combinations)
+* pgr_bdAstar(Combinations)
+* pgr_bdAstarCost(Combinations)
+* pgr_bdDijkstra(Combinations)
+* pgr_bdDijkstraCost(Combinations)
+* pgr_dijkstra(Combinations)
+* pgr_dijkstraCost(Combinations)
+* pgr_KSP(All signatures)
+* pgr_boykovKolmogorov(Combinations)
+* pgr_edmondsKarp(Combinations)
+* pgr_maxFlow(Combinations)
+* pgr_pushRelabel(Combinations)
+
+
 .. rubric:: Removal of deprecated functions and signatures
 
 * ``pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text)``