pgr_transitiveClosure GSOC-2019 week 11

configuration.conf

@@ -37,8 +37,8 @@ chinese             | Y | Y | Y
 spanningTree        | Y | Y | Y
 mincut              | Y | Y | Y
 version             | Y | Y | Y
-topologicalSort     | Y | Y | Y
-#transitiveClosure   | Y | Y | N
+topologicalSort     | Y | Y | Y 
+transitiveClosure   | Y | Y | Y
 
 
 #----------------------

doc/topologicalSort/pgr_topologicalSort.rst

@@ -24,6 +24,15 @@ In particular, the topological sort algorithm implemented by Boost.Graph.
 
 .. rubric:: Availability
 
+* Version 3.0.0
+
+  * New **experimental** function
+
+.. rubric:: Support
+
+* **Supported versions:**
+  current(`3.0 <https://docs.pgrouting.org/dev/en/pgr_topologicalSort.html>`__)
+
 * **TBD**
 
 Description
@@ -35,8 +44,7 @@ in the graph, then v comes before u in the ordering.
 This implementation can only be used with a **directed** graph with no cycles i.e. directed acyclic graph. 
 
 The main characteristics are:
-  - Process is valid for weighted directed acyclic graphs only. otherwise it will throw warnings.
-  - Values are returned when there is a path.
+  - Process is valid for directed acyclic graphs only. otherwise it will throw warnings.
 
   - For optimization purposes, if there are more than one answer, the function will return one of them.
 
@@ -57,22 +65,11 @@ Signatures
     RETURNS SET OF (seq, sorted_v)
     OR EMPTY SET
 
-
-.. index::
-    single: topologicalSort(One to One) - Experimental
-
-One to One
-...............................................................................
-
-.. code-block:: none
-
-    pgr_dagShortestPath(edges_sql)
-    RETURNS SET OF (seq, sorted_v) 
-    OR EMPTY SET
-
-:Example: From vertex :math:`1` to vertex :math:`6` 
+:Example: For a **directed** graph
 
 .. literalinclude:: doc-pgr_topologicalSort.queries
+   :start-after: -- q1
+   :end-before: -- q2
 
 Parameters
 -------------------------------------------------------------------------------

doc/transitiveClosure/CMakeLists.txt

@@ -0,0 +1,12 @@
+
+SET(LOCAL_FILES
+    pgr_transitiveClosure.rst
+    )
+
+foreach (f ${LOCAL_FILES})
+    configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
+    list(APPEND LOCAL_DOC_FILES  ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
+endforeach()
+
+set(PGROUTING_DOC_FILES ${PGROUTING_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
+

doc/transitiveClosure/pgr_transitiveClosure.rst

@@ -0,0 +1,122 @@
+..
+   ****************************************************************************
+    pgRouting Manual
+    Copyright(c) pgRouting Contributors
+
+    This documentation is licensed under a Creative Commons Attribution-Share
+    Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
+   ****************************************************************************
+
+pgr_transitiveClosure
+===============================================================================
+
+``pgr_transitiveClosure`` — Returns the transitive closure graph of the input graph.
+In particular, the transitive closure algorithm implemented by Boost.Graph.
+
+.. figure:: images/boost-inside.jpeg
+   :target: https://www.boost.org/doc/libs/1_70_0/libs/graph/doc/transitive_closure.html
+
+   Boost Graph Inside
+
+.. include:: proposed.rst
+   :start-after: begin-warn-expr
+   :end-before: end-warn-expr
+
+.. rubric:: Availability
+
+* Version 3.0.0
+
+  * New **experimental** function
+
+.. rubric:: Support
+
+* **Supported versions:**
+  current(`3.0 <https://docs.pgrouting.org/dev/en/pgr_transitiveClosure.html>`__)
+
+Description
+-------------------------------------------------------------------------------
+
+The transitive_closure() function transforms the input graph g into the transitive closure graph tc.
+
+This implementation can only be used with a **directed** graph with no cycles i.e. directed acyclic graph. 
+
+The main characteristics are:
+  - Process is valid for directed acyclic graphs only. otherwise it will throw warnings.
+
+  - The returned values are not ordered:
+
+  * Running time: :math:`O(|V||E|)`
+
+
+Signatures
+-------------------------------------------------------------------------------
+
+.. rubric:: Summary
+
+The pgr_transitiveClosure function has the following signature:
+
+.. index::
+   single: transitiveClosure
+
+.. code-block:: none
+
+    pgr_transitiveClosure(Edges SQL)
+    RETURNS SETOF (id, vid, target_array)
+
+:Example: Complete Graph of 3 vertexs
+
+.. literalinclude:: doc-pgr_transitiveClosure.queries
+   :start-after: -- q1
+   :end-before: -- q2
+
+Parameters
+-------------------------------------------------------------------------------
+
+======================= ====================== =================================================
+Column                  Type                   Description
+======================= ====================== =================================================
+**Edges SQL**           ``TEXT``               SQL query as described in `Inner query`_
+======================= ====================== =================================================
+
+Inner query
+-------------------------------------------------------------------------------
+
+.. include:: pgRouting-concepts.rst
+    :start-after: basic_edges_sql_start
+    :end-before: basic_edges_sql_end
+
+Result Columns
+-------------------------------------------------------------------------------
+
+RETURNS SETOF  (seq, vid, target_array)
+
+The function returns a single row. The columns of the row are:
+
+============================ =================   ===================================================================
+Column                       Type                Description
+============================ =================   ===================================================================
+**seq**                      ``INTEGER``         Sequential value starting from **1**.
+**vid**                      ``BIGINT``          Identifier of the vertex. 
+**target_array**             ``ARRAY[BIGINT]``   Array of identifiers of the vertices that are reachable from vertex v.
+============================ =================   ===================================================================
+
+Additional Examples
+-------------------------------------------------------------------------------
+
+:Example: Some sub graphs of the sample data
+
+.. literalinclude:: doc-pgr_transitiveClosure.queries
+   :start-after: -- q2
+   :end-before: -- q4
+
+
+See Also
+-------------------------------------------------------------------------------
+
+* https://en.wikipedia.org/wiki/Transitive_closure
+* The queries use the :doc:`sampledata` network.
+
+.. rubric:: Indices and tables
+
+* :ref:`genindex`
+* :ref:`search`

docqueries/transitiveClosure/CMakeLists.txt

@@ -0,0 +1,11 @@
+# Do not use extensions
+SET(LOCAL_FILES
+    doc-transitiveClosure
+    )
+
+foreach (f ${LOCAL_FILES})
+    configure_file("${f}.result" "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
+    list(APPEND LOCAL_DOC_FILES  "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
+endforeach()
+
+set(PGROUTING_DOC_FILES ${PGROUTING_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)

docqueries/transitiveClosure/doc-transitiveClosure.result

@@ -0,0 +1,92 @@
+BEGIN;
+BEGIN
+SET client_min_messages TO NOTICE;
+SET
+CREATE TABLE edge_table1 (
+    id serial,
+    source integer,
+    target integer,
+    cost double precision,
+    reverse_cost double precision
+);
+CREATE TABLE
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (0,1,1,-1);
+INSERT 0 1
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (0,3,1,-1);
+INSERT 0 1
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (0,2,1,-1);
+INSERT 0 1
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (1,3,1,-1);
+INSERT 0 1
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (1,2,1,-1);
+INSERT 0 1
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (3,2,1,-1);
+INSERT 0 1
+-- q1
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table1'
+);
+ seq | vid | target_array
+-----+-----+--------------
+   1 |   0 | {1,3,2}
+   2 |   1 | {3,2}
+   3 |   3 | {2}
+   4 |   2 | {}
+(4 rows)
+
+-- q2
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=2'
+);
+ seq | vid | target_array
+-----+-----+--------------
+   1 |   2 | {}
+   2 |   3 | {2}
+(2 rows)
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=3'
+);
+ seq | vid | target_array
+-----+-----+--------------
+   1 |   3 | {}
+   2 |   4 | {3}
+(2 rows)
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=2 or id=3'
+);
+ seq | vid | target_array
+-----+-----+--------------
+   1 |   2 | {}
+   2 |   3 | {2}
+   3 |   4 | {3,2}
+(3 rows)
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=11'
+);
+ seq | vid | target_array
+-----+-----+--------------
+   1 |   6 | {11}
+   2 |  11 | {}
+(2 rows)
+
+-- q3
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where cost=-1 or reverse_cost=-1'
+);
+ seq | vid | target_array
+-----+-----+---------------
+   1 |   2 | {}
+   2 |   3 | {11,12,6,2}
+   3 |   4 | {11,12,3,6,2}
+   4 |   6 | {11,12}
+   5 |  11 | {12}
+   6 |  10 | {11,12}
+   7 |  12 | {}
+(7 rows)
+
+-- q4
+ROLLBACK;
+ROLLBACK

docqueries/transitiveClosure/doc-transitiveClosure.test.sql

@@ -0,0 +1,45 @@
+CREATE TABLE edge_table1 (
+    id serial,
+    source integer,
+    target integer,
+    cost double precision,
+    reverse_cost double precision
+);
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (0,1,1,-1);
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (0,3,1,-1);
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (0,2,1,-1);
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (1,3,1,-1);
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (1,2,1,-1);
+INSERT INTO edge_table1 (source,target,cost,reverse_cost) VALUES (3,2,1,-1);
+
+\echo -- q1
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table1'
+);
+
+\echo -- q2
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=2'
+);
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=3'
+);
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=2 or id=3'
+);
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where id=11'
+);
+
+\echo -- q3
+
+SELECT * FROM pgr_transitiveclosure(
+  'SELECT id,source,target,cost,reverse_cost FROM edge_table where cost=-1 or reverse_cost=-1'
+);
+
+
+\echo -- q4

docqueries/transitiveClosure/test.conf

@@ -0,0 +1,17 @@
+#!/usr/bin/perl -w
+
+%main::tests = (
+    'any' => {
+        'comment' => 'transitiveClosure algorithm tests.',
+        'data' => [ ],
+        'tests' => [qw(
+            doc-transitiveClosure
+            )],
+        'documentation' => [qw(
+            doc-transitiveClosure
+            )]
+    },
+
+);
+
+1;

include/c_types/transitiveClosure_rt.h

@@ -42,9 +42,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  * return type for contraction
  * ***********************************************************************/
 typedef struct {
-    int64_t id;
-    int64_t *transitiveClosure_vertices;
-    int transitiveClosure_vertices_size;
+    int seq;
+    int64_t vid;
+    int64_t *target_array;
+    int target_array_size;
 } transitiveClosure_rt;
 
 #endif  // INCLUDE_C_TYPES_TRANSITIVECLOSURE_RT_H_

include/drivers/transitiveClosure/transitiveClosure_driver.h

@@ -49,7 +49,7 @@ extern "C" {
 
      ********************************************************/
     void
-        do_pgr_contractGraph(
+        do_pgr_transitiveClosure(
                pgr_edge_t  *data_edges,
         size_t total_tuples,
         transitiveClosure_rt **return_tuples,