Merge pull request #19 from kaajo/templated

Templated munkres

Author: saebyn

CMakeLists.txt

@@ -10,6 +10,7 @@ set (CMAKE_CXX_FLAGS_DEBUG   "${CMAKE_CXX_FLAGS} -O0 -ggdb3 -DDEBUG")
 set (CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS} -O3")
 
 include_directories (${PROJECT_SOURCE_DIR}/src)
+include_directories (${PROJECT_SOURCE_DIR}/src/adapters)
 
 # Sources.
 set (
@@ -23,16 +24,19 @@ set (
     ${PROJECT_SOURCE_DIR}/src/matrix.h
     ${PROJECT_SOURCE_DIR}/src/matrix.cpp
     ${PROJECT_SOURCE_DIR}/src/munkres.h
+
 )
 
+add_subdirectory(${PROJECT_SOURCE_DIR}/src/adapters)
+
 # Library.
 add_library (
     munkres STATIC
     ${MunkresCppLib_SOURCES}
 )
 
 install (TARGETS munkres                DESTINATION lib     PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
-install (FILES ${MunkresCppLib_HEADERS} DESTINATION include PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
+install (FILES ${MunkresCppLib_HEADERS} DESTINATION include/munkres PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
 
 
 # Binary example
@@ -42,8 +46,7 @@ target_link_libraries (munkres.bin munkres)
 add_custom_target (example)
 add_dependencies  (example munkres.bin)
 
-
-option (MUNKRESCPP_DEVEL_MODE "Configure project in development mode." OFF)
+option(MUNKRESCPP_DEVEL_MODE "Configure project in development mode." OFF)
 if (MUNKRESCPP_DEVEL_MODE)
     # Enable the ExternalProject_Add directive.
     # Which used for getting external tools for the Project.
@@ -68,6 +71,9 @@ if (MUNKRESCPP_DEVEL_MODE)
         benchmarks
     )
 
+    # celero needs curses library
+    #find_package(Curses)
+    #include_directories(${CURSES_INCLUDE_DIR})
 
     # Static code analyse.
     set (CppCheck_REPORT ${PROJECT_BINARY_DIR}/cppcheck.report)
@@ -77,4 +83,4 @@ if (MUNKRESCPP_DEVEL_MODE)
     )
     add_custom_target  (cppcheck DEPENDS ${CppCheck_REPORT})
     set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CppCheck_REPORT})
-endif ()
+endif (MUNKRESCPP_DEVEL_MODE)

examples/main.cpp

@@ -26,6 +26,7 @@
 #include <ctime>
 
 #include "munkres.h"
+#include "adapters/boostmatrixadapter.h"
 
 int
 main(int argc, char *argv[]) {
@@ -35,8 +36,8 @@ main(int argc, char *argv[]) {
 	if ( argc == 3 ) {
 		nrows = atoi(argv[1]);
 		ncols = atoi(argv[2]);
-	}
-	
+    }
+
 	Matrix<double> matrix(nrows, ncols);
 
 	srandom(time(nullptr)); // Seed random number generator.
@@ -59,7 +60,7 @@ main(int argc, char *argv[]) {
 	std::cout << std::endl;
 
 	// Apply Munkres algorithm to matrix.
-	Munkres m;
+    Munkres<double> m;
 	m.solve(matrix);
 
 	// Display solved matrix.

src/adapters/CMakeLists.txt

@@ -0,0 +1,47 @@
+set (
+    MunkresAdapters_HEADERS
+    ${PROJECT_SOURCE_DIR}/src/adapters/adapter.h
+    )
+
+set (
+    MunkresCppLib_SOURCES
+    ${MunkresCppLib_SOURCES}
+    ${PROJECT_SOURCE_DIR}/src/adapters/adapter.cpp
+    )
+
+option(STD_ADAPTERS "Build 2D array, std::array and std::vector adapters" OFF)
+if(STD_ADAPTERS)
+    set (MunkresCppLib_HEADERS
+    ${MunkresCppLib_HEADERS}
+    ${PROJECT_SOURCE_DIR}/src/adapters/std2dvectoradapter.h
+    ${PROJECT_SOURCE_DIR}/src/adapters/std2darrayadapter.h
+    )
+
+    set (
+    MunkresCppLib_SOURCES
+    ${MunkresCppLib_SOURCES}
+    ${PROJECT_SOURCE_DIR}/src/adapters/std2dvectordapter.cpp
+    ${PROJECT_SOURCE_DIR}/src/adapters/std2darrayadapter.cpp
+    )
+endif(STD_ADAPTERS)
+
+option(BOOST_MATRIX_ADAPTER "Build boost::numeric::ublas::matrix adapter" OFF)
+if(BOOST_MATRIX_ADAPTER)
+    find_package (Boost REQUIRED)
+    set (MunkresCppLib_HEADERS ${MunkresCppLib_HEADERS}
+    ${PROJECT_SOURCE_DIR}/src/adapters/boostmatrixadapter.h
+    )
+    
+    set (
+    MunkresCppLib_SOURCES
+    ${MunkresCppLib_SOURCES}
+    ${PROJECT_SOURCE_DIR}/src/adapters/boostmatrixadapter.cpp
+    )
+endif(BOOST_MATRIX_ADAPTER)
+
+#propagate upward edited sources
+set(MunkresCppLib_SOURCES ${MunkresCppLib_SOURCES} PARENT_SCOPE)
+
+#install all selected adapters
+install (FILES ${MunkresAdapters_HEADERS}  DESTINATION include/munkres/adapters PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
+

src/adapters/adapter.cpp

@@ -0,0 +1,19 @@
+/*
+ *   Copyright (c) 2015 Miroslav Krajicek
+ *
+ *   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+ */
+
+#include "adapter.h"

src/adapters/std_2d_vector.h renamed to src/adapters/adapter.h

@@ -1,5 +1,5 @@
 /*
- *   Copyright (c) 2007 John Weaver
+ *   Copyright (c) 2015 Miroslav Krajicek
  *
  *   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
@@ -16,25 +16,25 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  */
 
-#if !defined(_MUNKRES_ADAPTERS_STD_2D_VECTOR_H_)
-#define _MUNKRES_ADAPTERS_STD_2D_VECTOR_H_
+#ifndef _ADAPTER_H_
+#define _ADAPTER_H_
 
 #include "matrix.h"
-#include <vector>
-
-
-// Set of functions for two-dimensional std::vector.
-template <typename T>
-Matrix <T> convert_std_2d_vector_to_munkres_matrix (const std::vector <std::vector <T> > & vector);
-
-template <typename T>
-void fill_std_2d_vector_from_munkres_matrix (std::vector <std::vector <T> > & vector, const Matrix <T> & matrix);
-
-void solve(std::vector <std::vector <double> > &m);
-
-#ifndef USE_EXPORT_KEYWORD
-#include "std_2d_vector.cpp"
-//#define export /*export*/
-#endif
-
-#endif /* !defined(_MUNKRES_ADAPTERS_STD_2D_VECTOR_H_) */
+#include "munkres.h"
+
+template<typename Data, class Container > class Adapter
+{
+public:
+    virtual Matrix<Data> convertToMatrix(const Container &con) const = 0;
+    virtual void convertFromMatrix(Container &con, const Matrix<Data> &matrix) const = 0;
+    virtual void solve(Container &con)
+    {
+        auto matrix = convertToMatrix(con);
+        m_munkres.solve(matrix);
+        convertFromMatrix(con, matrix);
+    }
+protected:
+    Munkres<Data> m_munkres;
+};
+
+#endif /* _ADAPTER_H_ */

src/adapters/boost_matrix.cpp

@@ -1,5 +1,5 @@
 /*
- *   Copyright (c) 2007 John Weaver
+ *   Copyright (c) 2015 Miroslav Krajicek
  *
  *   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
@@ -16,25 +16,8 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  */
 
-#if !defined(_MUNKRES_ADAPTERS_BOOST_MATRIX_H_)
-#define _MUNKRES_ADAPTERS_BOOST_MATRIX_H_
+#include "boostmatrixadapter.h"
 
-#include "matrix.h"
-#include <boost/numeric/ublas/matrix.hpp>
-
-
-// Set of functions for boost matrix.
-template <typename T>
-Matrix <T> convert_boost_matrix_to_munkres_matrix (const boost::numeric::ublas::matrix <T> &);
-
-template <typename T>
-void fill_boost_matrix_from_munkres_matrix (boost::numeric::ublas::matrix <T> & boost_matrix, const Matrix <T> &);
-
-void solve(boost::numeric::ublas::matrix <double> &);
-
-#ifndef USE_EXPORT_KEYWORD
-#include "boost_matrix.cpp"
-//#define export /*export*/
-#endif
-
-#endif /* !defined(_MUNKRES_ADAPTERS_BOOST_MATRIX_H_) */
+template class BoostMatrixAdapter<double>;
+template class BoostMatrixAdapter<float>;
+template class BoostMatrixAdapter<int>;

src/adapters/boost_matrix.h renamed to src/adapters/boostmatrixadapter.cpp

@@ -0,0 +1,53 @@
+/*
+ *   Copyright (c) 2015 Miroslav Krajicek
+ *
+ *   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+ */
+
+#ifndef _BOOSTMATRIXADAPTER_H_
+#define _BOOSTMATRIXADAPTER_H_
+
+#include "adapter.h"
+#include <boost/numeric/ublas/matrix.hpp>
+
+template<typename Data> class BoostMatrixAdapter : public Adapter<Data,boost::numeric::ublas::matrix<Data> >
+{
+public:
+    virtual Matrix<Data> convertToMatrix(const boost::numeric::ublas::matrix<Data> &boost_matrix) const override
+    {
+        const auto rows = boost_matrix.size1 ();
+          const auto columns = boost_matrix.size2 ();
+          Matrix <Data> matrix (rows, columns);
+          for (int i = 0; i < rows; ++i) {
+            for (int j = 0; j < columns; ++j) {
+              matrix (i, j) = boost_matrix (i, j);
+            }
+          }
+          return matrix;
+    }
+
+    virtual void convertFromMatrix(boost::numeric::ublas::matrix<Data> &boost_matrix,const Matrix<Data> &matrix) const override
+    {
+        const auto rows = matrix.rows();
+          const auto columns = matrix.columns();
+          for (int i = 0; i < rows; ++i) {
+            for (int j = 0; j < columns; ++j) {
+              boost_matrix (i, j) = matrix (i, j);
+            }
+          }
+    }
+};
+
+#endif /* _BOOSTMATRIXADAPTER_H_ */