depthFirstSearch.c

Go to the documentation of this file.

/*PGR-GNU*****************************************************************
File: depthFirstSearch.c
Generated with Template by:
 
Copyright (c) 2020 pgRouting developers
Mail: [email protected]
 
Function's developer:
Copyright (c) 2020 Ashish Kumar
Mail: [email protected]
------
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 ********************************************************************PGR-GNU*/
 
#include <stdbool.h>
#include "c_common/postgres_connection.h"
#include "utils/array.h"
 
#include "c_common/debug_macro.h"
#include "c_common/e_report.h"
#include "c_common/time_msg.h"
 
#include "c_common/edges_input.h"
#include "c_common/arrays_input.h"
 
#include "drivers/traversal/depthFirstSearch_driver.h"
 
PGDLLEXPORT Datum _pgr_depthfirstsearch(PG_FUNCTION_ARGS);
PG_FUNCTION_INFO_V1(_pgr_depthfirstsearch);
 
static
void
process(
        char* edges_sql,
        ArrayType *roots,
        bool directed,
        int64_t max_depth,
 
        pgr_mst_rt **result_tuples,
        size_t *result_count) {
    pgr_SPI_connect();
 
    size_t size_rootsArr = 0;
 
    int64_t* rootsArr = (int64_t*) pgr_get_bigIntArray(&size_rootsArr, roots);
 
    (*result_tuples) = NULL;
    (*result_count) = 0;
 
    pgr_edge_t *edges = NULL;
    size_t total_edges = 0;
 
    pgr_get_edges(edges_sql, &edges, &total_edges);
 
    clock_t start_t = clock();
    char *log_msg = NULL;
    char *notice_msg = NULL;
    char *err_msg = NULL;
    do_pgr_depthFirstSearch(
            edges, total_edges,
            rootsArr, size_rootsArr,
 
            directed,
            max_depth,
 
            result_tuples,
            result_count,
            &log_msg,
            &notice_msg,
            &err_msg);
 
    time_msg("processing pgr_depthFirstSearch", start_t, clock());
 
    if (err_msg && (*result_tuples)) {
        pfree(*result_tuples);
        (*result_tuples) = NULL;
        (*result_count) = 0;
    }
 
    pgr_global_report(log_msg, notice_msg, err_msg);
 
    if (log_msg) pfree(log_msg);
    if (notice_msg) pfree(notice_msg);
    if (err_msg) pfree(err_msg);
    if (edges) pfree(edges);
    if (rootsArr) pfree(rootsArr);
 
    pgr_SPI_finish();
}
/*                                                                            */
/******************************************************************************/
 
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);
 
        /***********************************************************************
         *
         *   pgr_depthFirstSearch(
         *       edges_sql TEXT,
         *       root_vids ANYARRAY,
         *       directed BOOLEAN DEFAULT true
         *       max_depth BIGINT DEFAULT 9223372036854775807,
         *   );
         *
         **********************************************************************/
 
        process(
                text_to_cstring(PG_GETARG_TEXT_P(0)),
                PG_GETARG_ARRAYTYPE_P(1),
                PG_GETARG_BOOL(2),
                PG_GETARG_INT64(3),
                &result_tuples,
                &result_count);
 
        /**********************************************************************/
 
 
#if PGSQL_VERSION > 95
        funcctx->max_calls = result_count;
#else
        funcctx->max_calls = (uint32_t)result_count;
#endif
        funcctx->user_fctx = result_tuples;
        if (get_call_result_type(fcinfo, NULL, &tuple_desc)
                != TYPEFUNC_COMPOSITE) {
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("function returning record called in context "
                         "that cannot accept type record")));
        }
 
        funcctx->tuple_desc = tuple_desc;
        MemoryContextSwitchTo(oldcontext);
    }
 
    funcctx = SRF_PERCALL_SETUP();
    tuple_desc = funcctx->tuple_desc;
    result_tuples = (pgr_mst_rt*) funcctx->user_fctx;
 
    if (funcctx->call_cntr < funcctx->max_calls) {
        HeapTuple    tuple;
        Datum        result;
        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));
 
 
        size_t i;
        for (i = 0; i < num; ++i) {
            nulls[i] = false;
        }
 
        values[0] = Int64GetDatum(funcctx->call_cntr + 1);
        values[1] = Int64GetDatum(result_tuples[funcctx->call_cntr].depth);
        values[2] = Int64GetDatum(result_tuples[funcctx->call_cntr].from_v);
        values[3] = Int64GetDatum(result_tuples[funcctx->call_cntr].node);
        values[4] = Int64GetDatum(result_tuples[funcctx->call_cntr].edge);
        values[5] = Float8GetDatum(result_tuples[funcctx->call_cntr].cost);
        values[6] = Float8GetDatum(result_tuples[funcctx->call_cntr].agg_cost);
 
        /**********************************************************************/
 
        tuple = heap_form_tuple(tuple_desc, values, nulls);
        result = HeapTupleGetDatum(tuple);
        SRF_RETURN_NEXT(funcctx, result);
    } else {
        SRF_RETURN_DONE(funcctx);
    }
}