Initial commit

Author: fontanf

.github/workflows/build.yml

@@ -0,0 +1,53 @@
+name: Build
+
+on: [push]
+
+jobs:
+
+  build:
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8"]
+
+    env:
+      SUBSET_SUM_DATA: ${{ github.workspace }}/data
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Download data
+      run: |
+        python3 -m pip install -r requirements.txt
+        python3 -u scripts/download_data.py
+    - name: Build
+      run: |
+        cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+        cmake --build build --config Release --parallel
+        cmake --install build --config Release --prefix install
+    - name: Run unit tests
+      run: ctest --test-dir build/test --parallel
+    - name: Run tests
+      run: python3 -u scripts/run_tests.py test_results
+    - name: Checkout main branch
+      run: |
+        git remote set-branches origin '*'
+        git fetch --depth 1
+        git checkout main
+    - name: Build
+      run: |
+        cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+        cmake --build build --config Release --parallel
+        cmake --install build --config Release --prefix install
+    - name: Run tests
+      run: python3 -u scripts/run_tests.py test_results_ref
+    - name: Process tests
+      run: python3 -u ./build/_deps/optimizationtools-src/scripts/process_tests.py --ref test_results_ref --new test_results

CMakeLists.txt

@@ -0,0 +1,21 @@
+cmake_minimum_required(VERSION 3.15.0)
+
+project(SubsetSum LANGUAGES CXX)
+
+# Build options.
+option(SUBSETSUMSOLVER_BUILD_MAIN "Build main" ON)
+option(SUBSETSUMSOLVER_BUILD_TEST "Build the unit tests" ON)
+
+# Avoid FetchContent warning.
+cmake_policy(SET CMP0135 NEW)
+
+# Require C++11.
+set(CMAKE_CXX_STANDARD 11)
+
+# Enable output of compile commands during generation.
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# Add sub-directories.
+add_subdirectory(extern)
+add_subdirectory(src)
+add_subdirectory(test)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Florian Fontan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,93 @@
+# SubsetSumSolver
+
+A solver for the subset sum problem
+
+## Implemented algorithms
+
+* Dynamic programming
+  * Bellman
+    * Array `-a dynamic-programming-bellman-array`
+    * List (only optimal value) `-a dynamic-programming-bellman-list`
+    * Word RAM (only optimal value) `-a dynamic-programming-bellman-word-ram`
+    * Word RAM with recursive scheme `-a dynamic-programming-bellman-word-ram-rec`
+  * Balancing
+    * Array (only optimal value) `-a dynamic-programming-balancing-array`
+
+## Usage
+
+### Command line
+
+Compile:
+```shell
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build --config Release --parallel
+cmake --install build --config Release --prefix install
+```
+
+Download data:
+```shell
+python3 scripts/download_data.py
+```
+
+Solve:
+```shell
+./install/bin/subsetsumsolver  --verbosity-level 1  --input data/pthree/pthree_1000_1  --algorithm dynamic-programming-bellman-word-ram-rec
+```
+```
+====================================
+           KnapsackSolver           
+====================================
+
+Problem
+-------
+Subset sum problem
+
+Instance
+--------
+Number of items:  1000
+Capacity:         250000
+
+Algorithm
+---------
+Dynamic programming - Bellman - word RAM - recursive scheme
+
+Parameters
+----------
+Time limit:            inf
+Messages
+    Verbosity level:   1
+    Standard output:   1
+    File path:         
+    # streams:         0
+Logger
+    Has logger:        0
+    Standard error:    0
+    File path:         
+
+    Time (s)  Sol.       Value       Bound         Gap     Gap (%)                         Comment
+    --------  ----       -----       -----         ---     -------                         -------
+       0.000     1           0      250000      250000      100.00                                
+       0.033     1      250000      250000           0        0.00        algorithm end (solution)
+
+Final statistics
+----------------
+Value:                        250000
+Has solution:                 1
+Bound:                        250000
+Absolute optimality gap:      0
+Relative optimality gap (%):  0
+Time (s):                     0.0330949
+
+Solution
+--------
+Number of items:  484 / 1000 (48.4%)
+Weight:           250000 / 250000 (100%)
+Feasible:         1
+```
+
+Run tests:
+```
+export SUBSET_SUM_DATA=$(pwd)/data
+cd build/test
+ctest --parallel
+```

extern/CMakeLists.txt

@@ -0,0 +1,34 @@
+# Enable FetchContent.
+include(FetchContent)
+
+# Fetch boost.
+if(SUBSETSUMSOLVER_BUILD_MAIN OR SUBSETSUMSOLVER_BUILD_TEST)
+    set(BOOST_INCLUDE_LIBRARIES thread filesystem system program_options)
+    set(BOOST_ENABLE_CMAKE ON)
+    FetchContent_Declare(
+        Boost
+        URL https://github.com/boostorg/boost/releases/download/boost-1.84.0/boost-1.84.0.tar.xz
+        EXCLUDE_FROM_ALL)
+    FetchContent_MakeAvailable(Boost)
+endif()
+
+# Fetch googletest.
+if(SUBSETSUMSOLVER_BUILD_TEST)
+    FetchContent_Declare(
+        googletest
+        URL https://github.com/google/googletest/archive/03597a01ee50ed33e9dfd640b249b4be3799d395.zip)
+    # For Windows: Prevent overriding the parent project's compiler/linker settings
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    set(INSTALL_GTEST OFF)
+    FetchContent_MakeAvailable(googletest)
+endif()
+
+# Fetch fontanf/optimizationtools.
+set(OPTIMIZATIONTOOLS_BUILD_TEST OFF)
+FetchContent_Declare(
+    optimizationtools
+    GIT_REPOSITORY https://github.com/fontanf/optimizationtools.git
+    GIT_TAG 4037a1a03f97ea0c388baa4f3f74c3ba55baec08
+    #SOURCE_DIR "${PROJECT_SOURCE_DIR}/../optimizationtools/"
+    EXCLUDE_FROM_ALL)
+FetchContent_MakeAvailable(optimizationtools)

include/subsetsumsolver/algorithm_formatter.hpp

@@ -0,0 +1,63 @@
+#pragma once
+
+#include "subsetsumsolver/solution.hpp"
+
+namespace subsetsumsolver
+{
+
+class AlgorithmFormatter
+{
+
+public:
+
+    /** Constructor. */
+    AlgorithmFormatter(
+            const Parameters& parameters,
+            Output& output):
+        parameters_(parameters),
+        output_(output),
+        os_(parameters.create_os()) { }
+
+    /** Print the header. */
+    void start(
+            const std::string& algorithm_name);
+
+    /** Print the header. */
+    void print_header();
+
+    /** Print current state. */
+    void print(
+            const std::string& s);
+
+    /** Update the solution. */
+    void update_solution(
+            const Solution& solution_new,
+            const std::string& s);
+
+    /** Update the solution value. */
+    void update_value(
+            Weight value,
+            const std::string& s);
+
+    /** Update the bound. */
+    void update_bound(
+            Weight bound_new,
+            const std::string& s);
+
+    /** Method to call at the end of the algorithm. */
+    void end();
+
+private:
+
+    /** Parameters. */
+    const Parameters& parameters_;
+
+    /** Output. */
+    Output& output_;
+
+    /** Output stream. */
+    std::unique_ptr<optimizationtools::ComposeStream> os_;
+
+};
+
+}

include/subsetsumsolver/algorithms/dynamic_programming_balancing.hpp

@@ -0,0 +1,12 @@
+#pragma once
+
+#include "subsetsumsolver/solution.hpp"
+
+namespace subsetsumsolver
+{
+
+Output dynamic_programming_balancing_array(
+        const Instance& instance,
+        const Parameters& parameters = {});
+
+}

include/subsetsumsolver/algorithms/dynamic_programming_bellman.hpp

@@ -0,0 +1,56 @@
+#pragma once
+
+#include "subsetsumsolver/solution.hpp"
+
+namespace subsetsumsolver
+{
+
+struct DynamicProgrammingBellmanArrayOutput: public Output
+{
+    /** Constructor. */
+    DynamicProgrammingBellmanArrayOutput(const Instance& instance):
+        Output(instance)
+    { }
+
+    std::vector<ItemId> values;
+
+    bool is_reachable(Weight weight) const
+    {
+        return values[weight] != -1;
+    }
+};
+
+DynamicProgrammingBellmanArrayOutput dynamic_programming_bellman_array(
+        const Instance& instance,
+        const Parameters& parameters = {});
+
+Output dynamic_programming_bellman_list(
+        const Instance& instance,
+        const Parameters& parameters = {});
+
+struct DynamicProgrammingBellmanWordRamOutput: public Output
+{
+    /** Constructor. */
+    DynamicProgrammingBellmanWordRamOutput(const Instance& instance):
+        Output(instance)
+    { }
+
+    std::vector<uint64_t> values;
+
+    bool is_reachable(Weight weight) const
+    {
+        Weight word = weight / 64;
+        int bit = weight % 64;
+        return (values[word] >> bit);
+    }
+};
+
+DynamicProgrammingBellmanWordRamOutput dynamic_programming_bellman_word_ram(
+        const Instance& instance,
+        const Parameters& parameters = {});
+
+Output dynamic_programming_bellman_word_ram_rec(
+        const Instance& instance,
+        const Parameters& parameters = {});
+
+}