General update: cleaning up the README and fixes #339, #367 (#529)

* Implemented type trait to permit compilation of non-extractable types such as pointers: Fixes #339. Added /bigobj for MSVC compiler.

* Harmonised test naming scheme

* Added commented out test in ConectivityTest

* Improved getNodeSet and getAdjList : Fixes #367

* Moved some functionality out of Graph_impl to lighten the file.

* Correctly formatted header gaurds

* Added an example and links to more in the README file.

* Improved README by reordering and decluttering to make it clearer. Removed implementation and description of algorithms, redirecting the reader to the website and Deoxygen docs.

* Amended the capitalisation of WelshPowell

* Forced renaming of WelshPowell, git was case-insensitive :(

* Fixed shadow template parameter

Author: brghash

CMakeLists.txt

@@ -19,7 +19,9 @@ if(DEBUG)
 	)
 endif(DEBUG)
 
-if (NOT MSVC)
+if (MSVC)
+	add_compile_options(/bigobj)
+else ()
 	option(SANITIZE "Enable Sanitize" OFF)
 	if(SANITIZE)
 		add_compile_options(

README.md

@@ -72,4 +72,4 @@ const BronKerboschResult<T> Graph<T>::bron_kerbosch() const {
 }
 
 }  // namespace CXXGraph
-#endif
+#endif  // __CXXGRAPH_BRONKERBOSCH_IMPL_H__

include/CXXGraph/Graph/Algorithm/BronKerbosch_impl.hpp

@@ -0,0 +1,73 @@
+/***********************************************************/
+/***      ______  ____  ______                 _         ***/
+/***     / ___\ \/ /\ \/ / ___|_ __ __ _ _ __ | |__	     ***/
+/***    | |    \  /  \  / |  _| '__/ _` | '_ \| '_ \	    ***/
+/***    | |___ /  \  /  \ |_| | | | (_| | |_) | | | |    ***/
+/***     \____/_/\_\/_/\_\____|_|  \__,_| .__/|_| |_|    ***/
+/***                                    |_|			     ***/
+/***********************************************************/
+/***     Header-Only C++ Library for Graph			     ***/
+/***	 Representation and Algorithms				     ***/
+/***********************************************************/
+/***     Author: ZigRazor ***/
+/***	 E-Mail: zigrazor@gmail.com 				     ***/
+/***********************************************************/
+/***	 Collaboration: ----------- 				     ***/
+/***********************************************************/
+/***	 License: MPL v2.0 ***/
+/***********************************************************/
+
+#ifndef __CXXGRAPH_EULERIAN_PATH_IMPL_H__
+#define __CXXGRAPH_EULERIAN_PATH_IMPL_H__
+
+#pragma once
+
+#include "CXXGraph/Graph/Graph_decl.h"
+
+namespace CXXGraph {
+
+template <typename T>
+std::shared_ptr<std::vector<Node<T>>> Graph<T>::eulerianPath() const {
+  const auto nodeSet = Graph<T>::getNodeSet();
+
+  std::shared_ptr<std::vector<Node<T>>> eulerPath =
+      std::make_shared<std::vector<Node<T>>>();
+
+  // unused
+  // bool undirected = this->isUndirectedGraph();
+
+  std::vector<shared<const Node<T>>> currentPath;
+  // The starting node is the only node which has more outgoing than ingoing
+  // links
+  auto firstNodeIt = std::max_element(nodeSet.begin(), nodeSet.end(),
+                                      [this](auto n1, auto n2) {
+                                        return cachedAdjListOut->at(n1).size() <
+                                               cachedAdjListOut->at(n2).size();
+                                      });
+  auto currentNode = *(firstNodeIt);
+  currentPath.push_back(currentNode);
+
+  while (currentPath.size() > 0) {
+    auto &edges = cachedAdjListOut->at(currentNode);
+    // we keep removing the edges that
+    // have been traversed from the adjacency list
+    if (edges.size()) {
+      auto firstEdge = edges.back().second;
+
+      shared<const Node<T>> nextNodeId;
+      nextNodeId = firstEdge->getOtherNode(currentNode);
+
+      currentPath.push_back(nextNodeId);
+      currentNode = nextNodeId;
+      edges.pop_back();
+    } else {
+      eulerPath->push_back(*currentNode);
+      currentNode = currentPath.back();
+      currentPath.pop_back();
+    }
+  }
+  return eulerPath;
+}
+}  // namespace CXXGraph
+
+#endif  // __CXXGRAPH_EULERIAN_PATH_IMPL_H__

include/CXXGraph/Graph/Algorithm/EulerianPath_impl.hpp

@@ -35,6 +35,7 @@
 #include "CXXGraph/Graph/Algorithm/DepthFirstSearch_impl.hpp"
 #include "CXXGraph/Graph/Algorithm/Dial_impl.hpp"
 #include "CXXGraph/Graph/Algorithm/Dijkstra_impl.hpp"
+#include "CXXGraph/Graph/Algorithm/EulerianPath_impl.hpp"
 #include "CXXGraph/Graph/Algorithm/FloydWarshall_impl.hpp"
 #include "CXXGraph/Graph/Algorithm/FordFulkerson_impl.hpp"
 #include "CXXGraph/Graph/Algorithm/HopcroftKarp_impl.hpp"
@@ -45,7 +46,7 @@
 #include "CXXGraph/Graph/Algorithm/Tarjan_impl.hpp"
 #include "CXXGraph/Graph/Algorithm/TopologicalSort_impl.hpp"
 #include "CXXGraph/Graph/Algorithm/TransitiveReduction_impl.hpp"
-#include "CXXGraph/Graph/Algorithm/welshPowellColoring_impl.hpp"
+#include "CXXGraph/Graph/Algorithm/WelshPowellColoring_impl.hpp"
 
 // IO Operation
 #include "CXXGraph/Graph/IO/IOUtility_impl.hpp"

…h/Algorithm/welshPowellColoring_impl.hpp …h/Algorithm/WelshPowellColoring_impl.hppinclude/CXXGraph/Graph/Algorithm/welshPowellColoring_impl.hpp renamed to include/CXXGraph/Graph/Algorithm/WelshPowellColoring_impl.hpp include/CXXGraph/Graph/Algorithm/welshPowellColoring_impl.hpp renamed to include/CXXGraph/Graph/Algorithm/WelshPowellColoring_impl.hpp

@@ -111,6 +111,15 @@ class Graph {
       std::unordered_map<std::string, T> &nodeFeatMap,
       std::unordered_map<CXXGraph::id_t, double> &edgeWeightMap);
 
+  // Type trait used to compile allow compilation when T is not extractable
+  template <typename U, typename = void>
+  struct is_istream_extractable : std::false_type {};
+
+  template <typename U>
+  struct is_istream_extractable<
+      U, std::void_t<decltype(std::declval<std::istream &>() >>
+                              std::declval<U &>())>> : std::true_type {};
+
 #ifdef WITH_COMPRESSION
   int compressFile(const std::string &inputFile,
                    const std::string &outputFile) const;