Improve CMake strucutre

Now the library can be easily installed and used in other projects.

Author: jvgomez

CMakeLists.txt

@@ -1,40 +1,127 @@
 cmake_minimum_required (VERSION 2.6) 
 project (FMM) 
 
-# Set a default build type for single-configuration
+# set a default build type for single-configuration
 # CMake generators if no build type is set.
-IF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE)
-   SET(CMAKE_BUILD_TYPE Release)
-ENDIF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE)
+if(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release)
+endif(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE)
+
+set(BUILD_EXAMPLES true CACHE STRING "True (default) to build examples")
+if(BUILD_EXAMPLES)
+    message(STATUS "Examples are being built (NOT installed).")
+endif(BUILD_EXAMPLES)
 
 # Select flags.
-SET(CMAKE_CXX_FLAGS "-std=c++11")
-SET(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O3 -g")
-SET(CMAKE_CXX_FLAGS_RELEASE "-Ofast -fno-finite-math-only")
-SET(CMAKE_CXX_FLAGS_DEBUG  "-Wall -Wno-unused-local-typedefs -g")
+set(CMAKE_CXX_FLAGS "-std=c++11")
+set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O3 -g")
+set(CMAKE_CXX_FLAGS_RELEASE "-Ofast -fno-finite-math-only")
+set(CMAKE_CXX_FLAGS_DEBUG  "-Wall -Wno-unused-local-typedefs -g")
+
+# Finding Boost
+find_package(Boost REQUIRED COMPONENTS system filesystem program_options)
+if(Boost_FOUND)
+    include_directories(${Boost_INCLUDE_DIRS})
+else()
+    message(FATAL_ERROR "Boost NOT FOUND. Please install it following the instructions on the README file.")
+endif()
+
+# Finding CImg
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
+find_package(CImg)
+if(CImg_FOUND)
+    include_directories(${CIMG_INCLUDE_DIRS})
+else()
+    message(FATAL_ERROR "CImg NOT FOUND. Please install it following the instructions on the README file.")
+endif()
 
 # Self-made includes
-include_directories (${FMM_SOURCE_DIR}/console)
-include_directories (${FMM_SOURCE_DIR}/ndgridmap)
-include_directories (${FMM_SOURCE_DIR}/fmm)
-include_directories (${FMM_SOURCE_DIR}/fmm/fmdata) 
-include_directories (${FMM_SOURCE_DIR}/fm2)
-include_directories (${FMM_SOURCE_DIR}/io)
-include_directories (${FMM_SOURCE_DIR}/gradientdescent)
+include_directories (
+    ${Boost_INCLUDE_DIRS}
+    ${CImg_INCLUDE_DIRS}
+    console
+    ndgridmap
+    fmm
+    fmm/fmdata
+    fm2
+    io
+    gradientdescent
+    thirdparty
+)
+
+# Create main library
+add_library(fastmarching SHARED
+    console/console.cpp
+    ndgridmap/cell.cpp
+    fmm/fmdata/fmcell.cpp
+)
+
+# Linking 
+target_link_libraries(fastmarching
+    ${Boost_LIBRARIES}
+    ${CImg_SYSTEM_LIBS}
+)
+
+# Add benchmarking capabilities
+add_executable (fmmbenchmark benchmark/fmm_benchmark.cpp)  
+
+target_link_libraries (fmmbenchmark fastmarching)
+
+# Create main example
+if(BUILD_EXAMPLES)
+    add_executable(fmm main.cpp)
+    target_link_libraries(fmm fastmarching)
+    add_subdirectory(examples)
+endif(BUILD_EXAMPLES)
+
+# Install section
+# We are not using CMakePackageConfigHelpers because CIMG variables are lists
+# and those functions do not manage them properly.
+configure_file(
+    cmake/FMConfig.cmake.in
+    ${CMAKE_BINARY_DIR}/FMConfig.cmake
+)
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FMConfig.cmake
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/lib/cmake/FM
+)
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FMConfig.cmake
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/lib/cmake/FM
+)
+
+install(TARGETS fastmarching
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
+)
+
+install(TARGETS fmmbenchmark
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
+)
 
+install(DIRECTORY scripts DESTINATION ${CMAKE_INSTALL_PREFIX}/share/FM)
 
-# Third party internal includes
-include_directories (${FMM_SOURCE_DIR}/thirdparty) 
+install(DIRECTORY benchmark/cfg DESTINATION ${CMAKE_INSTALL_PREFIX}/share/FM)
 
+install(DIRECTORY ${CMAKE_SOURCE_DIR} DESTINATION ${CMAKE_INSTALL_PREFIX}/include
+    FILES_MATCHING
+        PATTERN "*.hpp"
+        PATTERN "*.h"
+    REGEX "/build$" EXCLUDE
+    REGEX ".git$" EXCLUDE
+    REGEX "/examples$" EXCLUDE
+    REGEX "/doc$" EXCLUDE
+    REGEX "/data$" EXCLUDE
+    REGEX "/cfg$" EXCLUDE
+    REGEX "/cmake$" EXCLUDE
+    REGEX "/scripts$" EXCLUDE
+)
 
-# External dependencies
-include_directories (~/boost_1_55_0)
 
-add_executable (fmm main.cpp
-                    console/console.cpp
-                    ndgridmap/cell.cpp
-                    fmm/fmdata/fmcell.cpp
-                    ) 
+# Uninstall target
+configure_file(
+    "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
+    IMMEDIATE @ONLY)
 
-# Linking CImg dependencies.
-target_link_libraries (fmm X11 pthread ) 
+add_custom_target(uninstall
+    COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)

README.md

@@ -1,7 +1,7 @@
 N-Dimensional Fast Marching Method V1.0
 
 **Authors:**
- - [Javier V. Gomez](http://jvgomez.github.io) javvgomez _at_ gmail.com 
+ - [Javier V. Gomez](http://jvgomez.github.io) javvgomez _at_ gmail.com
  - Jose Pardeiro jose.pardeiro _at_ gmail.com
  - Pablo Gely
 
@@ -62,30 +62,26 @@ Go into the HTML folder and open index.html
 
 This code uses C\++11 so a compiler g++ 4.8 or equivalent is required. With GCC 4.7 some runtime problems can occur.
 
-### Linking CImg dependencies.
-If you want to compile code that uses the CImg library, you will need to add the following line to the CMakeLists.txt
+Additional dependencies: Boost, imagemafick and CImg.
 
-    target_link_libraries (fmm X11 pthread)
-
-The code provides a copy of the CImg library. This will take care of loading and savig images. Depending on the extension used, you will need to install another libraries as said in the main page of CImg: http://cimg.sourceforge.net/
-
-The example code uses png, therefore examples of libraries to be installed are libpng, Magick++, ImageMagick, etc.
-
-### Boost dependencies
-When using Ubuntu, you should install Boost libraries (tested with 1.55+):
-
-    sudo apt-get install libboost-all-dev
+    $ sudo apt-get install imagemagick libboost-all-dev cimg-dev
 
 ## Building the code
 To build the code:
 
     $ cd build
     $ cmake .. -DCMAKE_BUILD_TYPE=Release (Release, RelWithDebInf or Debug, Release by default)
-    $ make
+    $ make -j8 (or the number of cores you want to use during compilation)
+    $ sudo make install (only if you want to install the library)
     $ ./fmm -map1 ../data/testimg.png -map2 ../data/map.png -vel ../data/velocities.png
 
 This main shows most of the utilities implemented so far.
 
+To uninstall:
+
+    $ sudo make uninstall
+
+
 ## Folder structure
 
 Although there are a lot of folders, they are quite simple. It is organized this way because I'm focusing on an upload to Biicode (www.biicode.com)
@@ -105,34 +101,50 @@ Although there are a lot of folders, they are quite simple. It is organized this
 + scripts: matlab scripts to parse outputs and automatic benchmarking bash script.
 + thirdparty: others' software included.
 
+### Installation
+Default installation folder is` /usr/local` for Linux distributions (or equivalent on other OS). Libraries are installed in subfolder `lib`, together with CMake modules. All the includes are installed under `include` subfolder. Additionally, in the `share` subfolder the helper scripts and some samples of benchmark configurations files are installed. Finally, the benchmark binary is installed in `bin`.
+
+In order to change the default installation folder you can do:
+
+	$ cmake ../.. -DCMAKE_INSTALL_PREFIX=<your folder>
+
+
+In this case, you will have to adapt your environment variables so that the libraries and CMake modules are found.
+
+
 ## KNOWN ISSUES
 
 - Gradient Descent for FM2* could fail if very narrow passages are in the way of the path.
 - It seems that UFMM can fail in maps with random (or similar) velocity changes.
 
 ## TODO
 
-At the top of each file there are specific TODO comments. Here are some others:
+At the top of each file there are specific TODO comments. Here are some others.
 
-- Mix SFMM and UFMM (researchy TODO).
+### Code TODOs
+- Remove relative file dependencies (#include "../../fmm", filename = "../../data", CMakeLists.txt deps, etc).
 - MapLoader, GridWriter... get a naming convention. MapReader or GridSaver for instance.
-- Improve untidy queue implementation with hash maps (specially remove element in increase_priority()).
-- Upload as a unique biicode block.
 - printRunInfo implementation missing for most of the solvers.
 - Unify GridWriter and GridPlotter functions parameter order: (grid, name)
-- Review and update nDGridMap.pdf
 - Fix Doxygen warnings.
 - Convert all scripts to python (or similar) so that they keep completely open source.
-- Improve the way FM2 and its versions deal with the grid when running multiple times on the same grid. Concretely, avoid recomputation of velocities map.
 - Reimplement FM2Dir from scratch. Currently in data/alpha folder.
-- Restructure the folder and the CMake files in order to properly have examples and that stuff.
 - Substitute arg parsing with boost_options.
-- Remove relative file dependencies (#include "../../fmm", filename = "../../data", CMakeLists.txt deps, etc).
 - Implement a grid copy constructor and assignment operator, etc.
 - Most of the unsigned int should be replaced by size_t to be type-correct.
 - Use smart pointers (specially for grid).
 - Create a testing framework.
 - BenchmarkCFG::configure, parse ctorParams_ with a variadic templated function, something like:` parseParams<int, bool>(param1, param2)`, `parseParams<string,double,bool>(p1,p2,p3)`.
-- For most methods, neighbors for same cell are computed many times. Store them like FMT to save some computation time.
 - GridPlotter code can be refactorized so that the same code is not repeated many times.
 - Review template template parameters, perhaps it can be simplified (specially for benchmark): `template <grid_t>` to `template <nDGridMap <cell_t, ndims>>` so we can use cell_t without doing `template <grid_t, cell_t>` (redundant).
+- Unify names: one thing is Fast Methods, other Fast Marching, etc.
+
+### Algorithmic TODOs
+- Improve untidy queue implementation with hash maps (specially remove element in increase_priority()).
+- Mix SFMM and UFMM (researchy TODO).
+- Improve the way FM2 and its versions deal with the grid when running multiple times on the same grid. Concretely, avoid recomputation of velocities map.
+- For most methods, neighbors for same cell are computed many times. Store them like FMT to save some computation time.
+
+### Documentation TODOs
+- Review and update nDGridMap.pdf
+- Link thesis and papers.

benchmark/CMakeLists.txt

@@ -1,6 +1,7 @@
 #### v0.7 (trunk) ChangeLog
 - Benchmarking can save only a grid per solver or grid for all runs with option savegrid=1 or `savegrid=2`
 - Benchmarking CFG files now accept .grid textfiles under the option `text=<path_to_text_grid>`
+- Added install and uninstall CMake targets.
 
 #### v0.6 ChangeLog
 - solveEikonal made more stable, but a bit less efficient.

changelog.md

@@ -0,0 +1,13 @@
+set(FM_FOUND 1)
+
+set(FM_INCLUDE_DIRS
+    @Boost_INCLUDE_DIRS@
+    @CImg_INCLUDE_DIRS@
+    @CMAKE_INSTALL_PREFIX@/include
+)
+
+set(FM_LIBRARIES
+    @CMAKE_INSTALL_PREFIX@/lib/${CMAKE_SHARED_LIBRARY_PREFIX}fastmarching${CMAKE_SHARED_LIBRARY_SUFFIX}
+    @CImg_SYSTEM_LIBS@
+    @Boost_LIBRARIES@
+)