Update README.md

CMakeLists.txt

@@ -1,10 +1,23 @@
 cmake_minimum_required(VERSION 3.20)
 
-project(mdlp)
+project(fimdlp 
+    LANGUAGES CXX
+    DESCRIPTION "Discretization algorithm based on the paper by Fayyad & Irani Multi-Interval Discretization of Continuous-Valued Attributes for Classification Learning."
+    HOMEPAGE_URL "https://github.com/rmontanana/mdlp"
+    VERSION 2.0.1
+)
 set(CMAKE_CXX_STANDARD 17)
 cmake_policy(SET CMP0135 NEW)
 
-find_package(Torch REQUIRED)
+find_package(Torch CONFIG REQUIRED)
+
+# Options
+# -------
+option(ENABLE_TESTING OFF)
+option(ENABLE_SAMPLE  OFF)
+option(COVERAGE       OFF)
+
+add_subdirectory(config)
 
 set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -fno-elide-constructors")
 set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3")
@@ -13,22 +26,54 @@ if (NOT ${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
 endif()
 
 if (ENABLE_TESTING)
-    MESSAGE("Debug mode")
+    message("Debug mode")
     enable_testing()
     set(CODE_COVERAGE ON)
-    SET(GCC_COVERAGE_LINK_FLAGS " ${GCC_COVERAGE_LINK_FLAGS} -lgcov --coverage")
+    set(GCC_COVERAGE_LINK_FLAGS "${GCC_COVERAGE_LINK_FLAGS} -lgcov --coverage")
     add_subdirectory(tests)
-else(ENABLE_TESTING)
-    MESSAGE("Release mode")
-endif(ENABLE_TESTING)
+else()
+    message("Release mode")
+endif()
 
-
-add_subdirectory(sample)
+if (ENABLE_SAMPLE)
+    message("Building sample")
+    add_subdirectory(sample)
+endif()
 
 include_directories(
     ${TORCH_INCLUDE_DIRS}
-    ${mdlp_SOURCE_DIR}/src
+    ${fimdlp_SOURCE_DIR}/src
+    ${CMAKE_BINARY_DIR}/configured_files/include
 )
 
-add_library(mdlp src/CPPFImdlp.cpp src/Metrics.cpp src/BinDisc.cpp src/Discretizer.cpp)
-target_link_libraries(mdlp "${TORCH_LIBRARIES}")
+add_library(fimdlp src/CPPFImdlp.cpp src/Metrics.cpp src/BinDisc.cpp src/Discretizer.cpp)
+target_link_libraries(fimdlp "${TORCH_LIBRARIES}")
+
+# Installation
+# ------------
+include(CMakePackageConfigHelpers)
+write_basic_package_version_file(
+    "${CMAKE_CURRENT_BINARY_DIR}/fimdlpConfigVersion.cmake"
+    VERSION ${PROJECT_VERSION}
+    COMPATIBILITY AnyNewerVersion
+)
+
+install(TARGETS fimdlp
+        EXPORT fimdlpTargets
+        ARCHIVE DESTINATION lib
+        LIBRARY DESTINATION lib
+        CONFIGURATIONS Release)
+
+install(DIRECTORY src/ DESTINATION include/fimdlp FILES_MATCHING CONFIGURATIONS Release PATTERN "*.h")
+install(FILES ${CMAKE_BINARY_DIR}/configured_files/include/config.h DESTINATION include/fimdlp CONFIGURATIONS Release)
+
+install(EXPORT fimdlpTargets
+        FILE fimdlpTargets.cmake
+        NAMESPACE fimdlp::
+        DESTINATION lib/cmake/fimdlp)
+
+configure_file(fimdlpConfig.cmake.in "${CMAKE_CURRENT_BINARY_DIR}/fimdlpConfig.cmake" @ONLY)
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/fimdlpConfig.cmake"
+              "${CMAKE_CURRENT_BINARY_DIR}/fimdlpConfigVersion.cmake"
+        DESTINATION lib/cmake/fimdlp)
+

Makefile

@@ -6,13 +6,16 @@ lcov := lcov
 build: 
 	@if [ -d build_release ]; then rm -fr build_release; fi
 	@mkdir build_release
-	@cmake -B build_release -S . -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF
+	@cmake -B build_release -S . -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF -DENABLE_SAMPLE=ON
 	@cmake --build build_release -j 8
 
+install:
+	@cmake --build build_release --target install -j 8		
+
 test:
 	@if [ -d build_debug ]; then rm -fr build_debug; fi
 	@mkdir build_debug
-	@cmake -B build_debug -S . -DCMAKE_BUILD_TYPE=Debug -DENABLE_TESTING=ON
+	@cmake -B build_debug -S . -DCMAKE_BUILD_TYPE=Debug -DENABLE_TESTING=ON -DENABLE_SAMPLE=ON
 	@cmake --build build_debug -j 8
 	@cd build_debug/tests && ctest --output-on-failure -j 8
 	@cd build_debug/tests && $(lcov) --capture --directory ../ --demangle-cpp --ignore-errors source,source --ignore-errors mismatch --output-file coverage.info >/dev/null 2>&1; \

README.md

@@ -2,6 +2,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rmontanana_mdlp&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=rmontanana_mdlp)
 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=rmontanana_mdlp&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=rmontanana_mdlp)
 [![Coverage Badge](https://img.shields.io/badge/Coverage-100,0%25-green)](html/index.html)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14245443.svg)](https://doi.org/10.5281/zenodo.14245443)
 
 # <img src="logo.png" alt="logo" width="50"/> mdlp
 

config/CMakeLists.txt

@@ -0,0 +1,4 @@
+configure_file(
+  "config.h.in"
+  "${CMAKE_BINARY_DIR}/configured_files/include/config.h" ESCAPE_QUOTES
+)

config/config.h.in

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <string>
+#include <string_view>
+
+#define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR @
+#define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR @
+#define PROJECT_VERSION_PATCH @PROJECT_VERSION_PATCH @
+
+static constexpr std::string_view project_mdlp_name = "@PROJECT_NAME@";
+static constexpr std::string_view project_mdlp_version = "@PROJECT_VERSION@";
+static constexpr std::string_view project_mdlp_description = "@PROJECT_DESCRIPTION@";
+static constexpr std::string_view git_mdlp_sha = "@GIT_SHA@";

fimdlpConfig.cmake.in

@@ -0,0 +1,2 @@
+@PACKAGE_INIT@
+include("${CMAKE_CURRENT_LIST_DIR}/fimdlpTargets.cmake")

sample/CMakeLists.txt

@@ -3,9 +3,10 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_BUILD_TYPE Debug)
 
 include_directories(
-    ${mdlp_SOURCE_DIR}/src
-    ${mdlp_SOURCE_DIR}/tests/lib/Files
+    ${fimdlp_SOURCE_DIR}/src
+    ${fimdlp_SOURCE_DIR}/tests/lib/Files
+    ${CMAKE_BINARY_DIR}/configured_files/include
 )
 
 add_executable(sample sample.cpp )
-target_link_libraries(sample mdlp "${TORCH_LIBRARIES}")
+target_link_libraries(sample fimdlp "${TORCH_LIBRARIES}")

sonar-project.properties

@@ -3,7 +3,7 @@ sonar.organization=rmontanana
 
 # This is the name and version displayed in the SonarCloud UI.
 sonar.projectName=mdlp
-sonar.projectVersion=2.0.0
+sonar.projectVersion=2.0.1
 # sonar.test.exclusions=tests/**
 # sonar.tests=tests/
 # sonar.coverage.exclusions=tests/**,sample/**

src/Discretizer.h

@@ -11,6 +11,7 @@
 #include <algorithm>
 #include "typesFImdlp.h"
 #include <torch/torch.h>
+#include "config.h"
 
 namespace mdlp {
     enum class bound_dir_t {
@@ -29,7 +30,7 @@ namespace mdlp {
         void fit_t(const torch::Tensor& X_, const torch::Tensor& y_);
         torch::Tensor transform_t(const torch::Tensor& X_);
         torch::Tensor fit_transform_t(const torch::Tensor& X_, const torch::Tensor& y_);
-        static inline std::string version() { return "1.2.3"; };
+        static inline std::string version() { return { project_mdlp_version.begin(), project_mdlp_version.end() }; };
     protected:
         labels_t discretizedData = labels_t();
         cutPoints_t cutPoints; // At least two cutpoints must be provided, the first and the last will be ignored in transform

src/typesFImdlp.h

@@ -1,3 +1,9 @@
+// ****************************************************************
+// SPDX - FileCopyrightText: Copyright 2024 Ricardo Montañana Gómez
+// SPDX - FileType: SOURCE
+// SPDX - License - Identifier: MIT
+// ****************************************************************
+
 #ifndef TYPES_H
 #define TYPES_H
 

tests/CMakeLists.txt

@@ -10,28 +10,29 @@ FetchContent_MakeAvailable(googletest)
 
 include_directories(
         ${TORCH_INCLUDE_DIRS}
-        ${mdlp_SOURCE_DIR}/src
-        ${mdlp_SOURCE_DIR}/tests/lib/Files
+        ${fimdlp_SOURCE_DIR}/src
+        ${fimdlp_SOURCE_DIR}/tests/lib/Files    
+        ${CMAKE_BINARY_DIR}/configured_files/include
 )
 
-add_executable(Metrics_unittest ${mdlp_SOURCE_DIR}/src/Metrics.cpp Metrics_unittest.cpp)
+add_executable(Metrics_unittest ${fimdlp_SOURCE_DIR}/src/Metrics.cpp Metrics_unittest.cpp)
 target_link_libraries(Metrics_unittest GTest::gtest_main)
 target_compile_options(Metrics_unittest PRIVATE --coverage)
 target_link_options(Metrics_unittest PRIVATE --coverage)
 
 add_executable(FImdlp_unittest FImdlp_unittest.cpp
-${mdlp_SOURCE_DIR}/src/CPPFImdlp.cpp ${mdlp_SOURCE_DIR}/src/Metrics.cpp  ${mdlp_SOURCE_DIR}/src/Discretizer.cpp)
+${fimdlp_SOURCE_DIR}/src/CPPFImdlp.cpp ${fimdlp_SOURCE_DIR}/src/Metrics.cpp  ${fimdlp_SOURCE_DIR}/src/Discretizer.cpp)
 target_link_libraries(FImdlp_unittest GTest::gtest_main "${TORCH_LIBRARIES}")
 target_compile_options(FImdlp_unittest PRIVATE --coverage)
 target_link_options(FImdlp_unittest PRIVATE --coverage)
 
-add_executable(BinDisc_unittest BinDisc_unittest.cpp ${mdlp_SOURCE_DIR}/src/BinDisc.cpp  ${mdlp_SOURCE_DIR}/src/Discretizer.cpp)
+add_executable(BinDisc_unittest BinDisc_unittest.cpp ${fimdlp_SOURCE_DIR}/src/BinDisc.cpp  ${fimdlp_SOURCE_DIR}/src/Discretizer.cpp)
 target_link_libraries(BinDisc_unittest GTest::gtest_main "${TORCH_LIBRARIES}")
 target_compile_options(BinDisc_unittest PRIVATE --coverage)
 target_link_options(BinDisc_unittest PRIVATE --coverage)
 
 add_executable(Discretizer_unittest Discretizer_unittest.cpp
-${mdlp_SOURCE_DIR}/src/BinDisc.cpp ${mdlp_SOURCE_DIR}/src/CPPFImdlp.cpp ${mdlp_SOURCE_DIR}/src/Metrics.cpp ${mdlp_SOURCE_DIR}/src/Discretizer.cpp )
+${fimdlp_SOURCE_DIR}/src/BinDisc.cpp ${fimdlp_SOURCE_DIR}/src/CPPFImdlp.cpp ${fimdlp_SOURCE_DIR}/src/Metrics.cpp ${fimdlp_SOURCE_DIR}/src/Discretizer.cpp )
 target_link_libraries(Discretizer_unittest GTest::gtest_main "${TORCH_LIBRARIES}")
 target_compile_options(Discretizer_unittest PRIVATE --coverage)
 target_link_options(Discretizer_unittest PRIVATE --coverage)

tests/Discretizer_unittest.cpp

@@ -33,7 +33,7 @@ namespace mdlp {
         auto version = disc->version();
         delete disc;
         std::cout << "Version computed: " << version;
-        EXPECT_EQ("1.2.3", version);
+        EXPECT_EQ("2.0.1", version);
     }
     TEST(Discretizer, BinIrisUniform)
     {