Build scripts was significantly improvement: added separate targets for unit tests, microbenchmarks and examples; added install target; replace strong warning options from main target into tests. Reflect changes into README and travis-ci build script.

Author: Gluttton

.travis.yml

@@ -21,7 +21,7 @@ before_script:
     - cmake -DCMAKE_BUILD_TYPE=Debug ${BUILD_DIR}/..
 script:
     - cd ${BUILD_DIR}
-    - make
+    - make && make tests
     - cd ${BUILD_DIR}/tests && ./munkrestest > /dev/null
 after_success:
     - cd ${BUILD_DIR}

CMakeLists.txt

@@ -4,108 +4,48 @@ project                 (munkres-cpp)
 set (munkres-cpp_VERSION_MAJOR 0)
 set (munkres-cpp_VERSION_MINOR 1)
 
-
-# Getting external tools which used by the Project.
-
-# Enable the ExternalProject_Add directive.
-include (ExternalProject)
-
-# Framework for writing tests.
-ExternalProject_Add (
-    googletest 
-    GIT_REPOSITORY "https://github.com/google/googletest.git"
-    UPDATE_COMMAND cd ${PROJECT_BINARY_DIR}/googletest && mv googletest gtest && mv gtest/googletest .
-    CMAKE_ARGS "-DCMAKE_BUILD_TYPE=Release"
-    SOURCE_DIR "${PROJECT_BINARY_DIR}/googletest/googletest"
-    BINARY_DIR "${PROJECT_BINARY_DIR}/googletest/googletest"
-    INSTALL_COMMAND ""
-    TEST_COMMAND ""
-)
-set (GTEST_ROOT "${PROJECT_BINARY_DIR}/googletest/googletest")
-set (GTEST_FOUND true)
-set (GTEST_INCLUDE_DIRS "${PROJECT_BINARY_DIR}/googletest/googletest/include")
-set (GTEST_LIBRARIES "${PROJECT_BINARY_DIR}/googletest/googletest/libgtest.a")
-set (GTEST_MAIN_LIBRARIES "${PROJECT_BINARY_DIR}/googletest/googletest/libgtest_main.a")
-set (GTEST_BOTH_LIBRARIES ${GTEST_LIBRARIES} ${GTEST_MAIN_LIBRARIES})
-
-# Microbenchmarking tools.
-# Google Benchmark.
-ExternalProject_Add (
-    benchmark
-    GIT_REPOSITORY "https://github.com/google/benchmark.git"
-    CMAKE_ARGS "-DBENCHMARK_ENABLE_TESTING=OFF;-DCMAKE_BUILD_TYPE=Release"
-    SOURCE_DIR "${PROJECT_BINARY_DIR}/benchmark"
-    BINARY_DIR "${PROJECT_BINARY_DIR}/benchmark"
-    INSTALL_COMMAND ""
-    TEST_COMMAND ""
-)
-set (GBENCHMARK_FOUND true)
-set (GBENCHMARK_INCLUDE_DIR "${PROJECT_BINARY_DIR}/benchmark/include")
-set (GBENCHMARK_LIBRARY "${PROJECT_BINARY_DIR}/benchmark/src/libbenchmark.a")
-
-# Celero.
-ExternalProject_Add (
-    Celero
-    GIT_REPOSITORY "https://github.com/DigitalInBlue/Celero.git"
-    CMAKE_ARGS "-DCELERO_ENABLE_EXPERIMENTS=OFF;-DCMAKE_BUILD_TYPE=Release"
-    SOURCE_DIR "${PROJECT_BINARY_DIR}/Celero"
-    BINARY_DIR "${PROJECT_BINARY_DIR}/CeleroBuild"
-    INSTALL_COMMAND ""
-    TEST_COMMAND ""
-)
-set (CELERO_FOUND true)
-set (CELERO_INCLUDE_DIR "${PROJECT_BINARY_DIR}/Celero/include")
-set (CELERO_LIBRARY "${PROJECT_BINARY_DIR}/CeleroBuild/libcelero.so")
-
-# Hayai.
-ExternalProject_Add (
-    hayai
-    GIT_REPOSITORY "https://github.com/nickbruun/hayai.git"
-    SOURCE_DIR "${PROJECT_BINARY_DIR}/hayai"
-    BUILD_COMMAND ""
-    INSTALL_COMMAND ""
-    TEST_COMMAND ""
-)
-set (HAYAI_FOUND true)
-set (HAYAI_INCLUDE_DIR "${PROJECT_BINARY_DIR}/hayai/src")
-
-
 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wmissing-include-dirs -Wundef -Wfloat-equal -Wunsafe-loop-optimizations")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wdouble-promotion -Winit-self -Wvector-operation-performance -Wnoexcept -Weffc++ -Wstrict-null-sentinel")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Woverloaded-virtual -Wsign-promo")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wvla -Winvalid-pch -Winline -Wredundant-decls")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wlogical-op -Wcast-align")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wcast-qual -Wpointer-arith -Wtrampolines")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wold-style-cast")
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wzero-as-null-pointer-constant")
 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)
 
+# Sources.
+set (
+    MunkresCppLib_SOURCES
+    ${PROJECT_SOURCE_DIR}/src/munkres.cpp
+)
+
+# Headers.
+set (
+    MunkresCppLib_HEADERS
+    ${PROJECT_SOURCE_DIR}/src/matrix.h
+    ${PROJECT_SOURCE_DIR}/src/matrix.cpp
+    ${PROJECT_SOURCE_DIR}/src/munkres.h
+)
 
 # Library.
-set (MunkresCppLib_SOURCES ${PROJECT_SOURCE_DIR}/src/munkres.cpp)
-add_library (munkres SHARED STATIC ${MunkresCppLib_SOURCES})
+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)
 
 
 # Binary example
 set (MunkresCppBin_SOURCES ${PROJECT_SOURCE_DIR}/examples/main.cpp)
-add_executable (munkres.bin ${MunkresCppBin_SOURCES})
+add_executable (munkres.bin EXCLUDE_FROM_ALL ${MunkresCppBin_SOURCES})
 target_link_libraries (munkres.bin munkres)
+add_custom_target (example)
+add_dependencies  (example munkres.bin)
 
 
-# Static code analyse.
-set (CppCheck_REPORT ${PROJECT_BINARY_DIR}/cppcheck.report)
-add_custom_command (
-    OUTPUT  ${CppCheck_REPORT}
-    COMMAND cppcheck ${MunkresCppLib_SOURCES} ${MunkresCppBin_SOURCES} -I${PROJECT_SOURCE_DIR}/src -I${PROJECT_SOURCE_DIR} --enable=all --force --inconclusive > cppcheck.report 2>&1
-)
-add_custom_target  (cppcheck DEPENDS ${CppCheck_REPORT})
-set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CppCheck_REPORT})
+# Enable the ExternalProject_Add directive.
+# Which used for getting external tools for the Project.
+include (ExternalProject)
 
 
 # Testing
@@ -115,3 +55,23 @@ add_subdirectory (tests)
 # Benchmarking
 add_subdirectory (benchmarks)
 
+
+# Custom target to build everything.
+add_custom_target  (full)
+add_dependencies (
+    full
+    munkres
+    example
+    tests
+    benchmarks
+)
+
+
+# Static code analyse.
+set (CppCheck_REPORT ${PROJECT_BINARY_DIR}/cppcheck.report)
+add_custom_command (
+    OUTPUT  ${CppCheck_REPORT}
+    COMMAND cppcheck ${MunkresCppLib_SOURCES} ${MunkresCppBin_SOURCES} -I${PROJECT_SOURCE_DIR}/src -I${PROJECT_SOURCE_DIR} --enable=all --force --inconclusive > cppcheck.report 2>&1
+)
+add_custom_target  (cppcheck DEPENDS ${CppCheck_REPORT})
+set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CppCheck_REPORT})

README.md

@@ -17,98 +17,124 @@ Licensed under the GPLv2. See the file COPYING for details.
 
 
 
-Usage
------
+Requires
+--------
 
-```$ git clone https://github.com/saebyn/munkres-cpp.git```  
-
-Requires:  
+For using:  
  - C++ compiler with C++11 support.  
 
-To usage code it's just required add ```src/munrkes.cpp``` file into your project.  
+
+For development:  
+ - [GCC](https://gcc.gnu.org/) (tested on 4.6.3, 4.8);  
+ - [GNU Make](https://www.gnu.org/software/make/);  
+ - [CMake](http://www.cmake.org/) (2.8.12);  
+ - the test suite requires the [Google C++ Test Framework](http://code.google.com/p/googletest/);  
+ - microbenchmaring requires [Benchmark](https://github.com/google/benchmark), [Celero](https://github.com/DigitalInBlue/Celero), [Hayai](https://github.com/nickbruun/hayai) and [gprof](http://www.gnu.org/software/binutils/);  
+ - code coverage requires [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) and lcov;  
+ - static code analyzis required [cppcheck](https://github.com/danmar/cppcheck).  
+
+
+
+Portability
+-----------
+
+The project is developing under GNU/Linux OS with gcc compiler and usualy not tested under other OS and compilers.
+But in the project not used OS or compiler specific features (types, attributes, etc) so it's expected that the project will be normally work under other platforms.
+
+
+
+Usage
+-----
+
+To use the project the following steps are required:  
+  - download: ```$ git clone https://github.com/saebyn/munkres-cpp.git && cd munkres-cpp```  
+  - build: ```$ mkdir build && cd build $$ cmake .. && make```  
+  - install: ``` $ make install```  
 
 
 
 Example
 -------
 
-TBD.
+TBD
 
 
 
 Development
 -----------
 
-Requires:  
- - [GCC](https://gcc.gnu.org/) (tested on 4.6.3, 4.8);  
- - [GNU Make](https://www.gnu.org/software/make/);  
- - [CMake](http://www.cmake.org/) (2.8.12);  
- - the test suite requires the [Google C++ Test Framework](http://code.google.com/p/googletest/);  
- - microbenchmaring requires [Benchmark](https://github.com/google/benchmark), [Celero](https://github.com/DigitalInBlue/Celero), [Hayai](https://github.com/nickbruun/hayai) and [gprof](http://www.gnu.org/software/binutils/);  
- - code coverage requires [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) and lcov;  
- - static code analyzis required [cppcheck](https://github.com/danmar/cppcheck).  
-
-```
-$ git clone https://github.com/saebyn/munkres-cpp.git  
-$ cd munkres-cpp  
-$ mkdir build && cd build
-$ cmake -DCMAKE_BUILD_TYPE={Debug, Release, etc}
-$ make
-```
-etc...  
+For development purpose in the project implemented a variety of build targets.
+All of them help to continuously check correctness of algorithm implementation, performance, memory management, etc.
 
-Lunch unit tests:  
+Launch of unit tests.
+The project contains unit tests to build and launch it performs the following steps:
 ```
+$ git clone https://github.com/saebyn/munkres-cpp.git
+$ cd munkres-cpp
 $ mkdir build && cd build
 $ cmake -DCMAKE_BUILD_TYPE=Debug ..
-$ make
+$ make tests
 $ tests/munkrestest
 ```
 
-Lunck code coverage analyze:  
+
+Lunch code coverage analyze.
+To get correct report unit tests must be compiled in debug mode.
 ```
-$ <build and lunch unit tests>  
+$ <build and lunch unit tests>
 $ make coverage
 $ firefox coverage/index.html &
 ```
 
-Lunch memory profiler:  
+
+Lunch memory profiler.
+As far unit tests call all functions which implement algorithm this is appropriate way to check memory management by using valgrind during performing unit tests.
 ```
-$ mkdir build && cd build
-$ cmake -DCMAKE_BUILD_TYPE=Debug ..
-$ make
+$ <build unit tests>
 $ valgrind tests/munkrestest
 ```
 
-Lunch microbenchmark tests:  
+
+Lunch microbenchmarks.
+Buildning microbenchmarks:
 ```
+$ git clone https://github.com/saebyn/munkres-cpp.git
+$ cd munkres-cpp
 $ mkdir build && cd build
 $ cmake -DCMAKE_BUILD_TYPE=Release ..
-$ make
+$ make benchmarks
+```
+To get comparable results it's required to generate data set wich will be used for all benchmarks:
+```
 $ benchmarks/tools/generator/matrixgenerator.bin {dim_1 dim_2 ... dim_n}
+```
+Where every ```dim_x``` parameter generate square matrix dith ```dim_x``` dimension.
+To launch microbenchmark performs any following command:
+```
 $ benchmarks/tests/munkresbenchmark_celero.bin
 $ benchmarks/tests/munkresbenchmark_google.bin
 $ benchmarks/tests/munkresbenchmark_hayai.bin
 $ benchmarks/tests/munkresbenchmark_rdtsc.bin
 ```
 
-Lunch static code analyze tests:  
-```
-$ make cppcheck
-```
 
-Lunch performance analyze:  
+Lunch performance analyze.
 ```
-$ mkdir build && cd build
-$ cmake -DCMAKE_BUILD_TYPE=Release ..
-$ make
-$ benchmarks/tools/generator/matrixgenerator.bin {dim_1 dim_2 ... dim_n}
+$ <build microbenchmarks and generate data set>
 $ benchmarks/tests/munkresbenchmark_gprof.bin
 $ gprof benchmarks/tests/munkresbenchmark_gprof.bin gmon.out -p -b
-```  
+```
+
+
+Lunch static code analyze.
+```
+$ make cppcheck
+```
+
+
+Lunch code formatter:
+TBD
 
-Lunch code formatter:  
-TBD  
 
 
 Bug reporting and work to be done