GSoC 2022: Nitish Chauhan Week 3

configuration.conf

@@ -44,6 +44,7 @@ traversal           | Y | Y | Y
 coloring            | Y | Y | Y
 planar              | Y | Y | Y
 dominator           | Y | Y | Y
+circuits            | N | N | N
 #----------------------
 # SQL only directories
 #----------------------

doc/circuits/CMakeLists.txt

@@ -1,4 +1,4 @@
-#[[
+
 SET(LOCAL_FILES
     pgr_hawickCircuits.rst
     )
@@ -9,4 +9,3 @@ foreach (f ${LOCAL_FILES})
 endforeach()
 
 set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
-]]

include/c_types/circuits_rt.h

@@ -42,7 +42,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  * return type for circuit
  * ***********************************************************************/
 struct circuits_rt {
-    int seq;
+    // int seq;
     int64_t *circuit;
     int circuit_size;
 };

include/circuits/hawickcircuits.hpp

@@ -0,0 +1,77 @@
+/*PGR-GNU*****************************************************************
+
+Copyright (c) 2022 pgRouting developers
+Mail: project@pgrouting.org
+
+Copyright (c) 2022 Nitish Chauhan
+Mail: nitishchauhan0022 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*/
+
+#ifndef INCLUDE_CIRCUITS_HAWICKCIRCUITS_HPP_
+#define INCLUDE_CIRCUITS_HAWICKCIRCUITS_HPP_
+#pragma once
+
+#include <boost/graph/adjacency_list.hpp>
+#include <boost/graph/graph_traits.hpp>
+#include <boost/graph/hawick_circuits.hpp>
+#include <boost/property_map/property_map.hpp>
+
+#include <iostream>
+#include <iterator>
+#include <vector>
+
+#include "cpp_common/basePath_SSEC.hpp"
+#include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/pgr_assert.h"
+#include "c_types/circuits_rt.h"
+
+struct circuit_detector {
+    std::vector<circuits_rt> results;
+    template <typename Path, typename Graph>
+    void cycle(Path const &p, Graph const &g) {
+        if (p.empty())
+            return;
+        // Iterate over path printing each vertex that forms the circuit.
+        typename Path::const_iterator i = p.begin(), before_end = p.end();
+
+        int64_t *circuit = nullptr;
+        size_t adj_siz = static_cast<size_t>(before_end - i);
+        circuit = pgr_alloc(adj_siz, circuit);
+        int number = 0;
+        for (; i != before_end; ++i) {
+            circuit[number++] = i;
+        }
+        results.push_back({circuit, adj_siz});
+    }
+
+    std::vector<circuits_rt> result() {
+        return results;
+    }
+};
+
+template <typename G>
+std::vector<circuits_rt> pgr_hawickCircuits(G &graph) {
+    circuit_detector visitor;
+    boost::hawick_circuits(graph, visitor);
+
+    return visitor.result();
+}
+
+#endif  // INCLUDE_CIRCUITS_HAWICKCIRCUITS_HPP_

include/drivers/circuits/hawickcircuits_driver.h

@@ -50,11 +50,11 @@ do_hawickCircuits(
         Edge_t  *,        // data_edges
         size_t,           // total_tuples
         circuits_rt **,   // return_tuples
-        size_t *,         //return_count
+        size_t *,         // return_count
 
         char **,          // log_msg
         char **,          // notice_msg
-        char **);         //err_msg
+        char **);         // err_msg
 
 
 #ifdef __cplusplus

sql/circuits/CMakeLists.txt

@@ -1,4 +1,3 @@
-#[[
 SET(LOCAL_FILES
     _hawickCircuits.sql
     hawickCircuits.sql
@@ -13,5 +12,4 @@ foreach (f ${LOCAL_FILES})
     list(APPEND PACKAGE_SQL_FILES  ${CMAKE_CURRENT_BINARY_DIR}/${f})
 endforeach()
 
-set(PROJECT_SQL_FILES ${PROJECT_SQL_FILES} ${PACKAGE_SQL_FILES} PARENT_SCOPE)
-]]
+set(PROJECT_SQL_FILES ${PROJECT_SQL_FILES} ${PACKAGE_SQL_FILES} PARENT_SCOPE)

src/circuits/CMakeLists.txt

@@ -1,5 +1,4 @@
-#[[ADD_LIBRARY(hawick_circuits OBJECT
+ADD_LIBRARY(hawick_circuits OBJECT
     hawickCircuits.c
     hawickCircuits_driver.cpp
-    )
-]]
+    )