💥 Introducing ClusterComplete: Exact SiDB Logic Simulation with well over 50 DBs

.github/workflows/codeql-analysis.yml

@@ -100,6 +100,15 @@ jobs:
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
+      - name: Setup ALGLIB
+        run: |
+          git clone https://github.com/S-Dafarra/alglib-cmake.git
+          cd alglib-cmake
+          mkdir build && cd build
+          cmake ..
+          make
+          sudo make install
+
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v3

.github/workflows/coverage.yml

@@ -83,6 +83,15 @@ jobs:
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
+      - name: Setup ALGLIB
+        run: |
+          git clone https://github.com/S-Dafarra/alglib-cmake.git
+          cd alglib-cmake
+          mkdir build && cd build
+          cmake ..
+          make
+          sudo make install
+
       - name: Create Build Environment
         run: cmake -E make_directory ${{github.workspace}}/build
 

.github/workflows/macos.yml

@@ -105,6 +105,15 @@ jobs:
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
+      - name: Setup ALGLIB
+        run: |
+          git clone https://github.com/S-Dafarra/alglib-cmake.git
+          cd alglib-cmake
+          mkdir build && cd build
+          cmake ..
+          make -j4
+          sudo make install
+
       - name: Create Build Environment
         run: cmake -E make_directory ${{github.workspace}}/build
 
@@ -121,6 +130,7 @@ jobs:
           -DFICTION_BENCHMARK=OFF
           -DFICTION_EXPERIMENTS=ON
           -DFICTION_Z3=ON
+          -DFICTION_ALGLIB=ON
           -DFICTION_PROGRESS_BARS=OFF
           -DFICTION_WARNINGS_AS_ERRORS=OFF
           -DMOCKTURTLE_EXAMPLES=OFF

.github/workflows/ubuntu.yml

@@ -112,6 +112,15 @@ jobs:
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
+      - name: Setup ALGLIB
+        run: |
+          git clone https://github.com/S-Dafarra/alglib-cmake.git
+          cd alglib-cmake
+          mkdir build && cd build
+          cmake ..
+          make -j4
+          sudo make install
+
       - name: Create Build Environment
         run: cmake -E make_directory ${{github.workspace}}/build
 
@@ -128,6 +137,7 @@ jobs:
           -DFICTION_BENCHMARK=OFF
           -DFICTION_EXPERIMENTS=ON
           -DFICTION_Z3=ON
+          -DFICTION_ALGLIB=ON
           -DFICTION_ENABLE_MUGEN=ON
           -DFICTION_PROGRESS_BARS=OFF
           -DFICTION_WARNINGS_AS_ERRORS=OFF

.github/workflows/windows.yml

@@ -76,6 +76,17 @@ jobs:
           architecture: x64
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      #
+      #      - name: Setup ALGLIB
+      #        run: |
+      #          git clone https://github.com/S-Dafarra/alglib-cmake.git
+      #          cp alglib-cmake ${{github.workspace}}/libs/
+      #          cd ${{github.workspace}}/libs/alglib-cmake
+      #          (Get-Content CMakeLists.txt) -replace '/Ox', '' | Set-Content CMakeLists.txt
+      #          mkdir build && cd build
+      #          cmake .. -G "${{matrix.env}}" -A x64 -T ${{matrix.toolset}}
+      #          cmake --build . --target ALL_BUILD --config ${{matrix.build_type}} -j4
+      #          cmake --build . --target INSTALL --config ${{matrix.build_type}}
 
       - name: Create Build Environment
         run: cmake -E make_directory ${{github.workspace}}\build
@@ -92,6 +103,7 @@ jobs:
           -DFICTION_BENCHMARK=OFF
           -DFICTION_EXPERIMENTS=ON
           -DFICTION_Z3=ON
+          #          -DFICTION_ALGLIB=ON
           -DFICTION_WARNINGS_AS_ERRORS=OFF
           -DMOCKTURTLE_EXAMPLES=OFF
 

Dockerfile

@@ -10,6 +10,16 @@ RUN apt-get -y update && apt-get -y upgrade && apt-get -y install \
 # Setup Z3
 RUN pip3 install z3-solver==4.10.0
 
+# Setup ALGLIB
+RUN git clone https://github.com/S-Dafarra/alglib-cmake.git && \
+    cd alglib-cmake && \
+    mkdir build && \
+    cd build && \
+    cmake .. && \
+    make && \
+    make install && \
+    cd ../..
+
 # Clone fiction's repository including submodules
 # RUN git clone --recursive https://github.com/cda-tum/fiction.git
 COPY . fiction/
@@ -23,6 +33,7 @@ RUN cmake -S fiction -B fiction/build \
     -DFICTION_TEST=OFF \
     -DFICTION_EXPERIMENTS=OFF \
     -DFICTION_Z3=ON \
+    -DFICTION_ALGLIB=ON \
     -DFICTION_ENABLE_MUGEN=OFF \
     -DFICTION_PROGRESS_BARS=ON \
     -DFICTION_WARNINGS_AS_ERRORS=OFF \

cli/cmd/simulation/clustercomplete.hpp

@@ -0,0 +1,202 @@
+//
+// Created by Willem Lambooy on 07/03/2024.
+//
+
+#ifndef FICTION_CMD_CLUSTERCOMPLETE_HPP
+#define FICTION_CMD_CLUSTERCOMPLETE_HPP
+
+#if (FICTION_ALGLIB_ENABLED)
+
+#include <fiction/algorithms/simulation/sidb/clustercomplete.hpp>
+#include <fiction/algorithms/simulation/sidb/minimum_energy.hpp>
+#include <fiction/algorithms/simulation/sidb/sidb_simulation_result.hpp>
+#include <fiction/traits.hpp>
+#include <fiction/types.hpp>
+#include <fiction/utils/name_utils.hpp>
+
+#include <alice/alice.hpp>
+#include <nlohmann/json.hpp>
+
+#include <any>
+#include <cstdint>
+#include <iostream>
+#include <limits>
+#include <memory>
+#include <string>
+#include <type_traits>
+#include <variant>
+
+namespace alice
+{
+/**
+ *
+ */
+class clustercomplete_command : public command
+{
+  public:
+    /**
+     * Standard constructor. Adds descriptive information, options, and flags.
+     *
+     * @param e alice::environment that specifies stores etc.
+     */
+    explicit clustercomplete_command(const environment::ptr& e) :
+            command(
+                e,
+                "ClusterComplete is a proof of concept of the more general idea of state space pruning in a cluster "
+                "hierarchy. In the application on SiDB layouts, it is able to simulate SiDB logic in base 3 for well "
+                "over 50 DBs, thereby redefining what was thought to be possible in the exact SiDB simulation domain.")
+    {
+        add_option("--epsilon_r,-e", physical_params.epsilon_r, "Electric permittivity of the substrate (unit-less)",
+                   true);
+        add_option("--lambda_tf,-l", physical_params.lambda_tf, "Thomas-Fermi screening distance (unit: nm)", true);
+        add_option("--mu_minus,-m", physical_params.mu_minus, "Energy transition level (0/-) (unit: eV)", true);
+        add_option("--witness_partitioning_limit,-w", params.validity_witness_partitioning_max_cluster_size_gss,
+                   "The limit on the cluster size before Ground State Space omits the check for which it solves the "
+                   "validity witness partitioning NP-complete sub-problem; values above 15 severely impact the runtime",
+                   true);
+    }
+
+  protected:
+    /**
+     * Function to perform the simulation call.
+     */
+    void execute() override
+    {
+        // reset sim result
+        sim_result = {};
+        min_energy = std::numeric_limits<double>::infinity();
+
+        if (physical_params.epsilon_r <= 0)
+        {
+            env->out() << "[e] epsilon_r must be positive" << std::endl;
+            reset_params();
+            return;
+        }
+        if (physical_params.lambda_tf <= 0)
+        {
+            env->out() << "[e] lambda_tf must be positive" << std::endl;
+            reset_params();
+            return;
+        }
+
+        auto& s = store<fiction::cell_layout_t>();
+
+        // error case: empty cell layout store
+        if (s.empty())
+        {
+            env->out() << "[w] no cell layout in store" << std::endl;
+            reset_params();
+            return;
+        }
+
+        const auto get_name = [](auto&& lyt_ptr) -> std::string { return fiction::get_name(*lyt_ptr); };
+
+        const auto clustercomplete = [this, &get_name](auto&& lyt_ptr)
+        {
+            using Lyt = typename std::decay_t<decltype(lyt_ptr)>::element_type;
+
+            if constexpr (fiction::has_sidb_technology_v<Lyt>)
+            {
+                if constexpr (fiction::is_charge_distribution_surface_v<Lyt>)
+                {
+                    env->out() << fmt::format(
+                                      "[w] {} already possesses a charge distribution; no simulation is conducted",
+                                      get_name(lyt_ptr))
+                               << std::endl;
+                }
+                else
+                {
+                    params.physical_parameters = physical_params;
+
+                    sim_result = fiction::clustercomplete(*lyt_ptr, params);
+
+                    if (sim_result.charge_distributions.empty())
+                    {
+                        env->out() << fmt::format("[e] ground state of {} could not be determined", get_name(lyt_ptr))
+                                   << std::endl;
+                    }
+                    else
+                    {
+                        const auto min_energy_distr = fiction::minimum_energy_distribution(
+                            sim_result.charge_distributions.cbegin(), sim_result.charge_distributions.cend());
+
+                        min_energy = min_energy_distr->get_system_energy();
+
+                        store<fiction::cell_layout_t>().extend() =
+                            std::make_shared<fiction::cds_sidb_cell_clk_lyt>(*min_energy_distr);
+                    }
+                }
+            }
+            else
+            {
+                env->out() << fmt::format("[e] {} is not an SiDB layout", get_name(lyt_ptr)) << std::endl;
+            }
+        };
+
+        std::visit(clustercomplete, s.current());
+
+        reset_params();
+    }
+
+  private:
+    /**
+     * Physical parameters for the simulation.
+     */
+    fiction::sidb_simulation_parameters physical_params{2, -0.32, 5.6, 5.0};
+    /**
+     * ClusterComplete parameters.
+     */
+    fiction::clustercomplete_params params{};
+    /**
+     * Simulation result.
+     */
+    fiction::sidb_simulation_result<fiction::sidb_cell_clk_lyt> sim_result{};
+    /**
+     * Minimum energy.
+     */
+    double min_energy{std::numeric_limits<double>::infinity()};
+    /**
+     * Logs the resulting information in a log file.
+     *
+     * @return JSON object containing details about the simulation.
+     */
+    [[nodiscard]] nlohmann::json log() const override
+    {
+        try
+        {
+            return nlohmann::json{{"Algorithm name", sim_result.algorithm_name},
+                                  {"Simulation runtime", sim_result.simulation_runtime.count()},
+                                  {{"Simulation parameters",
+                                    {"Physical parameters",
+                                     {{"base", sim_result.physical_parameters.base},
+                                      {"epsilon_r", sim_result.physical_parameters.epsilon_r},
+                                      {"lambda_tf", sim_result.physical_parameters.lambda_tf},
+                                      {"mu_minus", sim_result.physical_parameters.mu_minus}}},
+                                    {"validity witness partitioning limit",
+                                     std::any_cast<uint64_t>(sim_result.additional_simulation_parameters.at(
+                                         "validity_witness_partitioning_limit"))}}},
+                                  {"Ground state energy (eV)", min_energy},
+                                  {"Number of stable states", sim_result.charge_distributions.size()}};
+        }
+        catch (...)
+        {
+            return nlohmann::json{};
+        }
+    }
+    /**
+     * Resets the parameters to their default values.
+     */
+    void reset_params()
+    {
+        physical_params = fiction::sidb_simulation_parameters{3, -0.32, 5.6, 5.0};
+        params          = {};
+    }
+};
+
+ALICE_ADD_COMMAND(clustercomplete, "Simulation")
+
+}  // namespace alice
+
+#endif  // FICTION_ALGLIB_ENABLED
+
+#endif  // FICTION_CMD_CLUSTERCOMPLETE_HPP

cli/commands.hpp

@@ -50,6 +50,7 @@
 
 // physical simulation commands
 #ifdef FICTION_SIMULATION_FLOW
+#include "cmd/simulation/clustercomplete.hpp"
 #include "cmd/simulation/opdom.hpp"
 #include "cmd/simulation/quickexact.hpp"
 #include "cmd/simulation/quicksim.hpp"

docs/Doxyfile

@@ -2384,8 +2384,9 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = "FICTION_Z3_SOLVER=1," \
-                         MUGEN=1
+PREDEFINED             = FICTION_Z3_SOLVER=1, \
+                         MUGEN=1, \
+                         FICTION_ALGLIB_ENABLED=1
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

docs/algorithms/sidb_simulation.rst

@@ -47,6 +47,14 @@ Exhaustive Ground State Simulation
    :members:
 .. doxygenfunction:: fiction::quickexact
 
+.. _clustercomplete:
+
+**Header:** ``fiction/algorithms/simulation/sidb/clustercomplete.hpp``
+
+.. doxygenstruct:: fiction::clustercomplete_params
+   :members:
+.. doxygenfunction:: fiction::clustercomplete
+
 **Header:** ``fiction/algorithms/simulation/sidb/exhaustive_ground_state_simulation.hpp``
 
 .. doxygenfunction:: fiction::exhaustive_ground_state_simulation
@@ -60,7 +68,6 @@ Engine Selectors
 .. doxygenenum:: fiction::sidb_simulation_engine
 .. doxygenenum:: fiction::exhaustive_sidb_simulation_engine
 
-
 Energy Calculation
 ##################
 
@@ -119,6 +126,18 @@ Maximum Defect Influence Distance
 .. doxygenfunction:: fiction::maximum_defect_influence_position_and_distance
 
 
+Ground State Space Construction
+###############################
+
+.. _ground_state_space:
+
+**Header:** ``fiction/algorithms/simulation/sidb/ground_state_space.hpp``
+
+.. doxygenstruct:: fiction::ground_state_space_result
+   :members:
+.. doxygenfunction:: fiction::ground_state_space
+
+
 Time-to-Solution (TTS) Statistics
 #################################