Merge pull request #452 from wifiBlack/week-3-king-minDegree-ordering

Week 3 king and minimumdegree ordering

Author: wifiBlack

NEWS.md

@@ -101,6 +101,11 @@ Standardize output columns of functions with different output columns within ove
 
   * Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 
+* [#2908](https://github.com/pgRouting/pgrouting/issues/2908)
+  pgr_binaryBreadthFirstSearch
+
+  * 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/src/migration.rst

@@ -81,6 +81,8 @@ types.
      - `Migration of single path functions`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_bellmanFord` [3]_
      - `Migration of single path functions`_
+   * - .. versionchanged:: 4.0.0 :doc:`pgr_binaryBreadthFirstSearch` [3]_
+     - `Migration of single path functions`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_dagShortestPath` [3]_
      - `Migration of single path functions`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_edwardMoore` [3]_

doc/src/release_notes.rst

@@ -122,6 +122,13 @@ Standardize output columns of functions with different output columns within ove
      :start-after: Version 4.0.0
      :end-before: .. rubric
 
+* `#2908 <https://github.com/pgRouting/pgrouting/issues/2908>`__
+  pgr_binaryBreadthFirstSearch
+
+  .. include:: pgr_binaryBreadthFirstSearch.rst
+     :start-after: Version 4.0.0
+     :end-before: .. rubric
+
 * `#2910 <https://github.com/pgRouting/pgrouting/issues/2910>`__
   pgr_edwardMoore
 

doc/traversal/pgr_binaryBreadthFirstSearch.rst

@@ -29,15 +29,19 @@ non-negative integer, is termed as a 'binary graph'.
 
 .. rubric:: Availability
 
-* Version 3.2.0
+.. rubric:: Version 4.0.0
 
-  * New experimental signature:
+* Output columns standardized to |short-generic-result|
 
-    * pgr_binaryBreadthFirstSearch(Combinations)
+.. rubric:: Version 3.2.0
 
-* Version 3.0.0
+* New experimental signature:
 
-  * New experimental function.
+  * pgr_binaryBreadthFirstSearch(Combinations)
+
+.. rubric:: Version 3.0.0
+
+* New experimental function.
 
 Description
 -------------------------------------------------------------------------------
@@ -47,7 +51,7 @@ vertices can be found using Breadth First Search in :math:`O(|E|)` in an
 unweighted graph, i.e. the distance is the minimal number of edges that you
 need to traverse from the source to another vertex. We can interpret such a
 graph also as a weighted graph, where every edge has the weight :math:`1`.
-If not alledges in graph have the same weight, that we need a more general
+If not all edges in graph have the same weight, that we need a more general
 algorithm, like Dijkstra's Algorithm which runs in :math:`O(|E|log|V|)` time.
 
 However if the weights are more constrained, we can use a faster algorithm.
@@ -87,7 +91,7 @@ Signatures
    | pgr_binaryBreadthFirstSearch(`Edges SQL`_, **start vids**, **end vids**, [``directed``])
    | pgr_binaryBreadthFirstSearch(`Edges SQL`_, `Combinations SQL`_, [``directed``])
 
-   | Returns set of |old-generic-result|
+   | Returns set of |short-generic-result|
    | OR EMPTY SET
 
 **Note:** Using the :doc:`sampledata` Network as all weights are same (i.e
@@ -104,7 +108,7 @@ One to One
 
    | pgr_binaryBreadthFirstSearch(`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
@@ -124,7 +128,7 @@ One to Many
 
    | pgr_binaryBreadthFirstSearch(`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**
@@ -145,7 +149,7 @@ Many to One
 
    | pgr_binaryBreadthFirstSearch(`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**

docqueries/ordering/kingOrdering.pg

@@ -0,0 +1,7 @@
+-- CopyRight(c) pgRouting developers
+-- Creative Commons Attribution-Share Alike 3.0 License : https://creativecommons.org/licenses/by-sa/3.0/
+/* -- q1 */
+SELECT * FROM pgr_kingOrdering(
+  'SELECT id, source, target, cost, reverse_cost FROM edges'
+  );
+/* -- q2 */

docqueries/ordering/kingOrdering.result

@@ -0,0 +1,7 @@
+-- CopyRight(c) pgRouting developers
+-- Creative Commons Attribution-Share Alike 3.0 License : https://creativecommons.org/licenses/by-sa/3.0/
+/* -- q1 */
+SELECT * FROM pgr_minDegreeOrdering(
+  'SELECT id, source, target, cost, reverse_cost FROM edges'
+  );
+/* -- q2 */

docqueries/ordering/minDegreeOrdering.pg

@@ -5,6 +5,8 @@
         'files' => [qw(
             cuthillMckeeOrdering.pg
             topologicalSort.pg
+            minDegreeOrdering.pg
+            kingOrdering.pg
             )]
     },
 

docqueries/ordering/minDegreeOrdering.result

@@ -6,52 +6,52 @@ SET
 SELECT * FROM pgr_binaryBreadthFirstSearch(
   '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)
 
 /* -- q2 */
 SELECT * FROM pgr_binaryBreadthFirstSearch(
   '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)
 
 /* -- q3 */
 SELECT * FROM pgr_binaryBreadthFirstSearch(
   '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)
 
 /* -- q4 */