depthFirstSearch_driver.h

Go to the documentation of this file.

/*PGR-GNU*****************************************************************
File: depthFirstSearch_driver.h
 
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*/
 
#ifndef INCLUDE_DRIVERS_TRAVERSAL_DEPTHFIRSTSEARCH_DRIVER_H_
#define INCLUDE_DRIVERS_TRAVERSAL_DEPTHFIRSTSEARCH_DRIVER_H_
#pragma once
 
/* for size-t */
#ifdef __cplusplus
#   include <cstddef>
#else
#   include <stddef.h>
#endif
 
#include "c_types/pgr_edge_t.h"
#include "c_types/pgr_mst_rt.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**************************************************
     *
     *   pgr_depthFirstSearch(
     *      edges_sql TEXT,
     *      root_vids ANYARRAY,
     *      directed BOOLEAN DEFAULT true
     *      max_depth BIGINT DEFAULT 9223372036854775807,
     *   );
     *
     *************************************************/
    void do_pgr_depthFirstSearch(
            pgr_edge_t  *data_edges,
            size_t total_edges,
 
            int64_t *rootsArr,
            size_t size_rootsArr,
 
            bool directed,
            int64_t max_depth,
 
            pgr_mst_rt **return_tuples,
            size_t *return_count,
 
            char ** log_msg,
            char ** notice_msg,
            char ** err_msg);
 
#ifdef __cplusplus
}
#endif
 
#endif  // INCLUDE_DRIVERS_TRAVERSAL_DEPTHFIRSTSEARCH_DRIVER_H_