[depthFirstSearch] Added directed boolean parameter

Author: krashish8

include/drivers/depthFirstSearch/depthFirstSearch_driver.h

@@ -53,6 +53,7 @@ void do_pgr_depthFirstSearch(
         size_t size_rootsArr,
 
         int64_t max_depth,
+        bool directed,
 
         pgr_mst_rt **return_tuples,
         size_t *return_count,

sql/depthFirstSearch/_depthFirstSearch.sql

@@ -37,6 +37,7 @@ CREATE OR REPLACE FUNCTION _pgr_depthFirstSearch(
     edges_sql TEXT,
     root_vids ANYARRAY,
     max_depth BIGINT,
+    directed BOOLEAN,
 
     OUT seq BIGINT,
     OUT depth BIGINT,
@@ -53,6 +54,6 @@ LANGUAGE C VOLATILE STRICT;
 -- COMMENTS
 
 
-COMMENT ON FUNCTION _pgr_depthFirstSearch(TEXT, ANYARRAY, BIGINT)
+COMMENT ON FUNCTION _pgr_depthFirstSearch(TEXT, ANYARRAY, BIGINT, BOOLEAN)
 IS 'pgRouting internal function';
 

sql/depthFirstSearch/depthFirstSearch.sql

@@ -33,6 +33,7 @@ CREATE OR REPLACE FUNCTION pgr_depthFirstSearch(
     BIGINT, -- root_vid (required)
 
     max_depth BIGINT DEFAULT 9223372036854775807,
+    directed BOOLEAN DEFAULT true,
 
     OUT seq BIGINT,
     OUT depth BIGINT,
@@ -52,7 +53,7 @@ BEGIN
 
     RETURN QUERY
     SELECT *
-    FROM _pgr_depthFirstSearch(_pgr_get_statement($1), ARRAY[$2]::BIGINT[], $3);
+    FROM _pgr_depthFirstSearch(_pgr_get_statement($1), ARRAY[$2]::BIGINT[], max_depth, directed);
 END;
 $BODY$
 LANGUAGE plpgsql VOLATILE STRICT;
@@ -64,6 +65,7 @@ CREATE OR REPLACE FUNCTION pgr_depthFirstSearch(
     ANYARRAY, -- root_vids (required)
 
     max_depth BIGINT DEFAULT 9223372036854775807,
+    directed BOOLEAN DEFAULT true,
 
     OUT seq BIGINT,
     OUT depth BIGINT,
@@ -83,7 +85,7 @@ BEGIN
 
     RETURN QUERY
     SELECT *
-    FROM _pgr_depthFirstSearch(_pgr_get_statement($1), $2, $3);
+    FROM _pgr_depthFirstSearch(_pgr_get_statement($1), $2, max_depth, directed);
 END;
 $BODY$
 LANGUAGE plpgsql VOLATILE STRICT;
@@ -92,26 +94,26 @@ LANGUAGE plpgsql VOLATILE STRICT;
 -- COMMENTS
 
 
-COMMENT ON FUNCTION pgr_depthFirstSearch(TEXT, BIGINT, BIGINT)
+COMMENT ON FUNCTION pgr_depthFirstSearch(TEXT, BIGINT, BIGINT, BOOLEAN)
 IS 'pgr_depthFirstSearch(Single Vertex)
-- Undirected graph
 - Parameters:
     - Edges SQL with columns: id, source, target, cost [,reverse_cost]
     - From root vertex identifier
 - Optional parameters
     - max_depth := 9223372036854775807
+    - directed := true
 - Documentation:
     - ${PGROUTING_DOC_LINK}/pgr_depthFirstSearch.html
 ';
 
-COMMENT ON FUNCTION pgr_depthFirstSearch(TEXT, ANYARRAY, BIGINT)
+COMMENT ON FUNCTION pgr_depthFirstSearch(TEXT, ANYARRAY, BIGINT, BOOLEAN)
 IS 'pgr_depthFirstSearch(Multiple Vertices)
-- Undirected graph
 - Parameters:
     - Edges SQL with columns: id, source, target, cost [,reverse_cost]
     - From ARRAY[root vertices identifiers]
 - Optional parameters
     - max_depth := 9223372036854775807
+    - directed := true
 - Documentation:
     - ${PGROUTING_DOC_LINK}/pgr_depthFirstSearch.html
 ';

sql/sigs/pgrouting--3.0.0.sig

@@ -80,9 +80,9 @@ _pgr_dagshortestpath(text,anyarray,anyarray,boolean,boolean)
 pgr_dagshortestpath(text,anyarray,bigint)
 pgr_dagshortestpath(text,bigint,anyarray)
 pgr_dagshortestpath(text,bigint,bigint)
-_pgr_depthfirstsearch(text,anyarray,bigint)
-pgr_depthfirstsearch(text,anyarray,bigint)
-pgr_depthfirstsearch(text,bigint,bigint)
+_pgr_depthfirstsearch(text,anyarray,bigint,boolean)
+pgr_depthfirstsearch(text,anyarray,bigint,boolean)
+pgr_depthfirstsearch(text,bigint,bigint,boolean)
 pgr_dijkstracostmatrix(text,anyarray,boolean)
 pgr_dijkstracost(text,anyarray,anyarray,boolean)
 pgr_dijkstracost(text,anyarray,bigint,boolean)

src/depthFirstSearch/depthFirstSearch.c

@@ -50,6 +50,7 @@ process(
         char* edges_sql,
         ArrayType *roots,
         int64_t max_depth,
+        bool directed,
 
         pgr_mst_rt **result_tuples,
         size_t *result_count) {
@@ -75,22 +76,23 @@ process(
 
     pgr_get_edges(edges_sql, &edges, &total_edges);
 
-
+    PGR_DBG("Starting processing");
     clock_t start_t = clock();
     do_pgr_depthFirstSearch(
             edges, total_edges,
             rootsArr, size_rootsArr,
 
             max_depth,
+            directed,
 
             result_tuples,
             result_count,
             &log_msg,
             &notice_msg,
             &err_msg);
 
-
     time_msg("processing pgr_depthFirstSearch", start_t, clock());
+    PGR_DBG("Returning %ld tuples", *result_count);
 
     if (err_msg) {
         if (*result_tuples) pfree(*result_tuples);
@@ -111,22 +113,38 @@ PGDLLEXPORT Datum _pgr_depthfirstsearch(PG_FUNCTION_ARGS) {
     FuncCallContext     *funcctx;
     TupleDesc           tuple_desc;
 
+    /**********************************************************************/
     pgr_mst_rt *result_tuples = NULL;
     size_t result_count = 0;
+    /**********************************************************************/
 
     if (SRF_IS_FIRSTCALL()) {
         MemoryContext   oldcontext;
         funcctx = SRF_FIRSTCALL_INIT();
         oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
 
-        /* Edge sql, tree roots, max_depth */
+        /**********************************************************************/
+        /*
+        pgr_depthFirstSearch(
+            edges_sql TEXT,
+            root_vids ANYARRAY,
+            max_depth BIGINT DEFAULT 9223372036854775807,
+            directed BOOLEAN DEFAULT true
+        );
+        */
+        /**********************************************************************/
+
+        PGR_DBG("Calling process");
         process(
                 text_to_cstring(PG_GETARG_TEXT_P(0)),
                 PG_GETARG_ARRAYTYPE_P(1),
                 PG_GETARG_INT64(2),
+                PG_GETARG_BOOL(3),
                 &result_tuples,
                 &result_count);
 
+        /**********************************************************************/
+
 
 #if PGSQL_VERSION > 95
         funcctx->max_calls = result_count;
@@ -156,6 +174,18 @@ PGDLLEXPORT Datum _pgr_depthfirstsearch(PG_FUNCTION_ARGS) {
         Datum        *values;
         bool*        nulls;
 
+        /**********************************************************************/
+        /*
+            OUT seq BIGINT,
+            OUT depth BIGINT,
+            OUT start_vid BIGINT,
+            OUT node BIGINT,
+            OUT edge BIGINT,
+            OUT cost FLOAT,
+            OUT agg_cost FLOAT
+        */
+        /**********************************************************************/
+
         size_t num  = 7;
         values = palloc(num * sizeof(Datum));
         nulls = palloc(num * sizeof(bool));

src/depthFirstSearch/depthFirstSearch_driver.cpp

@@ -40,6 +40,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #include "spanningTree/details.hpp"
 
 
+// TODO(krashish8): Use the directed parameter below.
 void
 do_pgr_depthFirstSearch(
         pgr_edge_t  *data_edges,
@@ -49,6 +50,7 @@ do_pgr_depthFirstSearch(
         size_t size_rootsArr,
 
         int64_t max_depth,
+        bool directed,
 
         pgr_mst_rt **return_tuples,
         size_t *return_count,