diff --git a/doc/metrics/pgr_betweennessCentrality.rst b/doc/metrics/pgr_betweennessCentrality.rst new file mode 100644 index 0000000000..254a87d962 --- /dev/null +++ b/doc/metrics/pgr_betweennessCentrality.rst @@ -0,0 +1,111 @@ +.. + **************************************************************************** + 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_betweennessCentrality`` +=============================================================================== + +``pgr_betweennessCentrality`` - Returns the relative betweeness centrality of +all edges in a graph using Brandes Algorithm. + +.. figure:: images/boost-inside.jpeg + :target: https://www.boost.org/doc/libs/1_84_0/libs/graph/doc/betweenness_centrality.html + + Boost Graph Inside + +.. rubric:: Availability +.. TODO: Add availability + +Description +------------------------------------------------------------------------------- + +The Brandes Algorithm for utilises the sparse nature of graphs to evaluating the +betweenness centrality score of all edges/vertices. +We use Boost's implementation which runs in :math:`\Theta(VE)` for unweighted +graphs and :math:`Theta(VE + V(V+E)log(V))` for weighted graphs and uses +:math:`\Theta(VE)` space. + +Signatures +------------------------------------------------------------------------------- + +.. rubric:: Summary + +.. admonition:: \ \ + :class: signatures + + pgr_betweennessCentrality(`Edges SQL`_, [``directed``]) + + | Returns set of ```(seq, edge_id, betweenness_centrality)``` + | OR EMPTY SET + +.. TODO: Fix this when docqueries are made +:Example: For a directed subgraph with edges :math:`\{1, 2, 3, 4\}`. + +.. literalinclude:: floydWarshall.queries + :start-after: -- q1 + :end-before: -- q2 + +Parameters +------------------------------------------------------------------------------- + +.. include:: allpairs-family.rst + :start-after: edges_start + :end-before: edges_end + +Optional parameters +............................................................................... + +.. include:: dijkstra-family.rst + :start-after: dijkstra_optionals_start + :end-before: dijkstra_optionals_end + +Inner Queries +------------------------------------------------------------------------------- + +Edges SQL +............................................................................... + +.. include:: pgRouting-concepts.rst + :start-after: no_id_edges_sql_start + :end-before: no_id_edges_sql_end + +Result columns +------------------------------------------------------------------------------- + +.. list-table:: + :width: 81 + :widths: auto + :header-rows: 1 + + * - Column + - Type + - Description + * - ``seq`` + - ``INTEGER`` + - Sequential Value starting from ``1`` + * - ``edge_id`` + - ``BIGINT`` + - Identifier of the edge + * - ``centrality`` + - ``FLOAT`` + - relative betweenness centrality score of the edge (will be in range [0,1]) + +See Also +------------------------------------------------------------------------------- + +* Boost `centrality + `_ +* Queries uses the :doc:`sampledata` network. + +.. rubric:: Indices and tables + +* :ref:`genindex` +* :ref:`search` diff --git a/docqueries/metrics/CMakeLists.txt b/docqueries/metrics/CMakeLists.txt index 76682554e3..3e4f70e9c1 100644 --- a/docqueries/metrics/CMakeLists.txt +++ b/docqueries/metrics/CMakeLists.txt @@ -1,6 +1,6 @@ # Do not use extensions SET(LOCAL_FILES - centrality.pg + betweennessCentrality.pg ) foreach (f ${LOCAL_FILES}) diff --git a/docqueries/metrics/centrality.pg b/docqueries/metrics/betweennessCentrality.pg similarity index 86% rename from docqueries/metrics/centrality.pg rename to docqueries/metrics/betweennessCentrality.pg index ec5710a60f..bc8b322a35 100644 --- a/docqueries/metrics/centrality.pg +++ b/docqueries/metrics/betweennessCentrality.pg @@ -1,7 +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_centrality( +SELECT * FROM pgr_betweennesscentrality( 'SELECT id, source, target, cost, reverse_cost FROM edges where id < 5' ) ORDER BY start_vid, end_vid; diff --git a/docqueries/metrics/centrality.result b/docqueries/metrics/betweennessCentrality.result similarity index 94% rename from docqueries/metrics/centrality.result rename to docqueries/metrics/betweennessCentrality.result index fd38df1ece..410bfd6f5e 100644 --- a/docqueries/metrics/centrality.result +++ b/docqueries/metrics/betweennessCentrality.result @@ -3,7 +3,7 @@ BEGIN SET client_min_messages TO NOTICE; SET /* -- q1 */ -SELECT * FROM pgr_centrality( +SELECT * FROM pgr_betweennesscentrality( 'SELECT id, source, target, cost, reverse_cost FROM edges where id < 5' ) ORDER BY start_vid, end_vid; diff --git a/docqueries/metrics/test.conf b/docqueries/metrics/test.conf index c9e35d3af9..c1462123db 100644 --- a/docqueries/metrics/test.conf +++ b/docqueries/metrics/test.conf @@ -3,7 +3,7 @@ %main::tests = ( 'any' => { 'files' => [qw( - centrality.pg + betweennessCentrality.pg )] }, # I don't know what this are for or how to use them. diff --git a/include/drivers/metrics/centrality_driver.h b/include/drivers/metrics/betweennessCentrality_driver.h similarity index 84% rename from include/drivers/metrics/centrality_driver.h rename to include/drivers/metrics/betweennessCentrality_driver.h index a9a6f21034..2d849bbaa4 100644 --- a/include/drivers/metrics/centrality_driver.h +++ b/include/drivers/metrics/betweennessCentrality_driver.h @@ -1,5 +1,5 @@ /*PGR-GNU***************************************************************** -File: floydWarshall_driver.h +File: betweennessCentrality_driver.h Generated with Template by: Copyright (c) 2015 pgRouting developers @@ -27,8 +27,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ********************************************************************PGR-GNU*/ -#ifndef INCLUDE_DRIVERS_METRICS_CENTRALITY_DRIVER_H_ -#define INCLUDE_DRIVERS_METRICS_CENTRALITY_DRIVER_H_ +#ifndef INCLUDE_DRIVERS_METRICS_BETWEENNESSCENTRALITY_DRIVER_H_ +#define INCLUDE_DRIVERS_METRICS_BETWEENNESSCENTRALITY_DRIVER_H_ #pragma once /* for size-t */ @@ -48,7 +48,7 @@ extern "C" { #endif void -pgr_do_centrality( +pgr_do_betweennesscentrality( char*, bool, @@ -61,4 +61,4 @@ pgr_do_centrality( } #endif -#endif // INCLUDE_DRIVERS_METRICS_CENTRALITY_DRIVER_H_ +#endif // INCLUDE_DRIVERS_METRICS_BETWEENNESSCENTRALITY_DRIVER_H_ diff --git a/include/metrics/centrality.hpp b/include/metrics/betweennessCentrality.hpp similarity index 62% rename from include/metrics/centrality.hpp rename to include/metrics/betweennessCentrality.hpp index e4e59fddf2..7af4e44e14 100644 --- a/include/metrics/centrality.hpp +++ b/include/metrics/betweennessCentrality.hpp @@ -1,5 +1,5 @@ /*PGR-GNU***************************************************************** -File: centrality.hpp +File: betweennessCentrality.hpp Copyright (c) 2015 pgRouting developers Mail: project@pgrouting.org @@ -26,22 +26,18 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ********************************************************************PGR-GNU*/ -#ifndef INCLUDE_METRICS_CENTRALITY_HPP_ -#define INCLUDE_METRICS_CENTRALITY_HPP_ +#ifndef INCLUDE_METRICS_BETWEENNESSCENTRALITY_HPP_ +#define INCLUDE_METRICS_BETWEENNESSCENTRALITY_HPP_ #pragma once -#include #include -#include -#include +#include #include #include #include #include #include -#include -#include #include "c_types/iid_t_rt.h" #include "cpp_common/basePath_SSEC.hpp" @@ -52,20 +48,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. #include "cpp_common/pgr_alloc.hpp" namespace pgrouting { -template < class G > class Pgr_metrics; +template class Pgr_metrics; -// user's functions -template < class G > -void -pgr_centrality(G &graph, std::vector< IID_t_rt> &rows) { - Pgr_metrics< G > fn_centrality; - fn_centrality.centrality(graph, rows); -} // for postgres -template < class G > +template void -pgr_centrality( +pgr_betweennesscentrality( G &graph, size_t &result_tuple_count, IID_t_rt **postgres_rows) { @@ -75,7 +64,7 @@ pgr_centrality( // template class -template < class G > +template class Pgr_metrics { public: using Graph = typename G::B_G; @@ -85,50 +74,47 @@ class Pgr_metrics { const G &graph, size_t &result_tuple_count, IID_t_rt **postgres_rows ){ - std::map centrality_map; - std::vector centrality_score(boost::num_vertices(graph.graph)); + + std::vector centrality(boost::num_vertices(graph.graph), 0.0); + auto centrality_map = boost::make_iterator_property_map(centrality.begin(), + boost::get(boost::vertex_index, graph.graph) + ); /* abort in case of an interruption occurs (e.g. the query is being cancelled) */ CHECK_FOR_INTERRUPTS(); boost::brandes_betweenness_centrality( graph.graph, - boost::centrality_map( - boost::make_iterator_property_map( - centrality_score.begin(), - boost::get(boost::vertex_index, graph.graph) - ) - ) + centrality_map ); - - typename boost::graph_traits::vertex_iterator vi, vi_end; - for(boost::tie(vi, vi_end) = boost::vertices(graph.graph); vi != vi_end; ++vi) { - int64_t id = graph.graph[*vi].id; - centrality_map[id] = centrality_score[boost::get(boost::vertex_index, graph.graph, *vi)]; + if(boost::num_vertices(graph.graph) > 2){ + boost::relative_betweenness_centrality( + graph.graph, + centrality_map + ); } - generate_results(centrality_map, result_tuple_count, postgres_rows); - + generate_results(graph, centrality, result_tuple_count, postgres_rows); } private: void generate_results( - const std::map centrality_results, + const G &graph, + const std::vector centrality_results, size_t &result_tuple_count, IID_t_rt **postgres_rows) const { result_tuple_count = centrality_results.size(); *postgres_rows = pgr_alloc(result_tuple_count, (*postgres_rows)); - size_t seq = 0; - for(auto results : centrality_results) { - (*postgres_rows)[seq].from_vid = results.first; + for(typename G::V v_i = 0; v_i < graph.num_vertices(); ++v_i) { + (*postgres_rows)[seq].from_vid = graph[v_i].id; (*postgres_rows)[seq].to_vid = 0; - (*postgres_rows)[seq].cost = results.second; - seq++; + (*postgres_rows)[seq].cost = centrality_results[v_i]; + seq++; } } }; } // namespace pgrouting -#endif // INCLUDE_METRICS_CENTRALITY_HPP_ +#endif // INCLUDE_METRICS_BETWEENNESSCENTRALITY_HPP_ diff --git a/sql/metrics/CMakeLists.txt b/sql/metrics/CMakeLists.txt index 01fa5eed6c..c047b395e5 100644 --- a/sql/metrics/CMakeLists.txt +++ b/sql/metrics/CMakeLists.txt @@ -1,7 +1,7 @@ SET(LOCAL_FILES - _centrality.sql - centrality.sql + _betweennessCentrality.sql + betweennessCentrality.sql ) foreach (f ${LOCAL_FILES}) diff --git a/sql/metrics/_centrality.sql b/sql/metrics/_betweennessCentrality.sql similarity index 80% rename from sql/metrics/_centrality.sql rename to sql/metrics/_betweennessCentrality.sql index e79a9ce4e5..a2c6bf26e4 100644 --- a/sql/metrics/_centrality.sql +++ b/sql/metrics/_betweennessCentrality.sql @@ -1,6 +1,6 @@ /*PGR-GNU***************************************************************** -File: _centrality.sql +File: _betweennessCentrality.sql Template: Copyright (c) 2015 pgRouting developers @@ -28,23 +28,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ********************************************************************PGR-GNU*/ ---------------------- --- pgr_centrality ---------------------- +-------------------------------- +-- pgr_betweennessCentrality +-------------------------------- --v3.7 -CREATE FUNCTION _pgr_centrality( +CREATE FUNCTION _pgr_betweennesscentrality( edges_sql TEXT, directed BOOLEAN, - OUT start_vid BIGINT, - OUT end_vid BIGINT, - OUT agg_cost FLOAT) + OUT vid BIGINT, + OUT betweenness_centrality FLOAT) RETURNS SETOF RECORD AS 'MODULE_PATHNAME' LANGUAGE C VOLATILE STRICT; -- COMMENTS -COMMENT ON FUNCTION _pgr_centrality(TEXT, BOOLEAN) +COMMENT ON FUNCTION _pgr_betweennesscentrality(TEXT, BOOLEAN) IS 'pgRouting internal function'; diff --git a/sql/metrics/centrality.sql b/sql/metrics/betweennessCentrality.sql similarity index 78% rename from sql/metrics/centrality.sql rename to sql/metrics/betweennessCentrality.sql index 08307b906f..c5f3f893f9 100644 --- a/sql/metrics/centrality.sql +++ b/sql/metrics/betweennessCentrality.sql @@ -1,6 +1,6 @@ /*PGR-GNU***************************************************************** -File: centrality.sql +File: betweennessCentrality.sql Template: Copyright (c) 2015 pgRouting developers @@ -29,26 +29,25 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ********************************************************************PGR-GNU*/ --v3.7 -CREATE FUNCTION pgr_centrality( +CREATE FUNCTION pgr_betweennesscentrality( TEXT, -- edges_sql (required) - directed BOOLEAN DEFAULT true, + directed BOOLEAN DEFAULT false, - OUT start_vid BIGINT, - OUT end_vid BIGINT, - OUT agg_cost FLOAT) + OUT vid BIGINT, + OUT betweenness_centrality FLOAT) RETURNS SETOF RECORD AS $BODY$ - SELECT start_vid, end_vid, agg_cost - FROM _pgr_centrality(_pgr_get_statement($1), $2); + SELECT vid, betweenness_centrality + FROM _pgr_betweennesscentrality(_pgr_get_statement($1), $2); $BODY$ LANGUAGE SQL VOLATILE STRICT; -- COMMENTS -COMMENT ON FUNCTION pgr_centrality(TEXT, BOOLEAN) -IS 'pgr_centrality +COMMENT ON FUNCTION pgr_betweennesscentrality(TEXT, BOOLEAN) +IS 'pgr_betweennessCentrality - Parameters: - edges SQL with columns: source, target, cost [,reverse_cost]) - Optional Parameters: diff --git a/src/metrics/centrality.c b/src/betweennessCentrality_driver.cpp similarity index 98% rename from src/metrics/centrality.c rename to src/betweennessCentrality_driver.cpp index 34705c8118..4875115983 100644 --- a/src/metrics/centrality.c +++ b/src/betweennessCentrality_driver.cpp @@ -35,7 +35,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. #include "c_common/e_report.h" #include "c_common/time_msg.h" -#include "drivers/metrics/centrality_driver.h" +#include "drivers/metrics/betweennessCentrality_driver.h" PGDLLEXPORT Datum _pgr_centrality(PG_FUNCTION_ARGS); PG_FUNCTION_INFO_V1(_pgr_centrality); diff --git a/src/metrics/CMakeLists.txt b/src/metrics/CMakeLists.txt index 4d082e613a..c88a1dfd8e 100644 --- a/src/metrics/CMakeLists.txt +++ b/src/metrics/CMakeLists.txt @@ -1,4 +1,4 @@ ADD_LIBRARY(metrics OBJECT - centrality.c - centrality_driver.cpp + betweennessCentrality.c + betweennessCentrality_driver.cpp ) diff --git a/src/metrics/betweennessCentrality.c b/src/metrics/betweennessCentrality.c new file mode 100644 index 0000000000..05ffdda9f4 --- /dev/null +++ b/src/metrics/betweennessCentrality.c @@ -0,0 +1,141 @@ +/*PGR-GNU***************************************************************** +File: betweennessCentrality.c + +Generated with Template by: +Copyright (c) 2015 pgRouting developers +Mail: project@pgrouting.org + +Function's developer: +Copyright (c) 2024 Arun Thakur +Mail: bedupako12mas at gmail.com + +------ + +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 +#include "c_common/postgres_connection.h" + +#include "c_types/iid_t_rt.h" +#include "c_common/debug_macro.h" +#include "c_common/e_report.h" +#include "c_common/time_msg.h" + +#include "drivers/metrics/betweennessCentrality_driver.h" + +PGDLLEXPORT Datum _pgr_betweennesscentrality(PG_FUNCTION_ARGS); +PG_FUNCTION_INFO_V1(_pgr_betweennesscentrality); + +static +void +process( + char* edges_sql, + bool directed, + IID_t_rt **result_tuples, + size_t *result_count) { + pgr_SPI_connect(); + char* log_msg = NULL; + char* notice_msg = NULL; + char* err_msg = NULL; + + clock_t start_t = clock(); + pgr_do_betweennesscentrality( + edges_sql, + directed, + result_tuples, + result_count, + &log_msg, + &err_msg); + time_msg(" processing Centrality", 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); + pgr_SPI_finish(); +} + + +PGDLLEXPORT Datum +_pgr_betweennesscentrality(PG_FUNCTION_ARGS) { + FuncCallContext *funcctx; + TupleDesc tuple_desc; + + + IID_t_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); + + + process( + text_to_cstring(PG_GETARG_TEXT_P(0)), + PG_GETARG_BOOL(1), + &result_tuples, + &result_count); + + funcctx->max_calls = result_count; + 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 = (IID_t_rt*) funcctx->user_fctx; + + if (funcctx->call_cntr < funcctx->max_calls) { + HeapTuple tuple; + Datum result; + Datum *values; + bool* nulls; + + values = palloc(2 * sizeof(Datum)); + nulls = palloc(2 * sizeof(bool)); + + // postgres starts counting from 1 + values[0] = Int64GetDatum(result_tuples[funcctx->call_cntr].from_vid); + nulls[0] = false; + values[1] = Float8GetDatum(result_tuples[funcctx->call_cntr].cost); + nulls[1] = false; + + tuple = heap_form_tuple(tuple_desc, values, nulls); + result = HeapTupleGetDatum(tuple); + SRF_RETURN_NEXT(funcctx, result); + } else { + SRF_RETURN_DONE(funcctx); + } +} + diff --git a/src/metrics/centrality_driver.cpp b/src/metrics/betweennessCentrality_driver.cpp similarity index 90% rename from src/metrics/centrality_driver.cpp rename to src/metrics/betweennessCentrality_driver.cpp index d8c5f11377..792e9cbf0c 100644 --- a/src/metrics/centrality_driver.cpp +++ b/src/metrics/betweennessCentrality_driver.cpp @@ -1,5 +1,5 @@ /*PGR-GNU***************************************************************** -File: centrality_driver.cpp +File: betweennessCentrality_driver.cpp Generated with Template by: Copyright (c) 2015 pgRouting developers @@ -27,21 +27,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. ********************************************************************PGR-GNU*/ -#include "drivers/metrics/centrality_driver.h" +#include "drivers/metrics/betweennessCentrality_driver.h" #include #include #include #include -//TODO: Right now this is doing the floyd warshall, creating the centrality algorithm is pending -#include "metrics/centrality.hpp" +#include "metrics/betweennessCentrality.hpp" #include "cpp_common/pgdata_getters.hpp" #include "cpp_common/pgr_assert.hpp" void -pgr_do_centrality( +pgr_do_betweennesscentrality( char *edges_sql, bool directed, @@ -74,12 +73,12 @@ pgr_do_centrality( log << "Processing Directed graph\n"; pgrouting::DirectedGraph digraph; digraph.insert_edges(edges); - pgr_centrality(digraph, *return_count, return_tuples); + pgr_betweennesscentrality(digraph, *return_count, return_tuples); } else { log << "Processing Undirected graph\n"; pgrouting::UndirectedGraph undigraph; undigraph.insert_edges(edges); - pgr_centrality(undigraph, *return_count, return_tuples); + pgr_betweennesscentrality(undigraph, *return_count, return_tuples); }