✨ SiDB Operational Domain Computation

.clang-format

@@ -55,7 +55,7 @@ IncludeCategories:
     Priority: 2
   - Regex: '<fiction\/[a-zA-Z0-9_]+.+>$'
     Priority: 3
-  - Regex: '<(alice|lorina|mockturtle|kitty|bill|nlohmann|fmt|z3|phmap|tinyxml2|units)(\/[a-zA-Z0-9_])*.+>$'
+  - Regex: '<(alice|lorina|mockturtle|kitty|bill|nlohmann|fmt|z3|phmap|btree|tinyxml2|units)(\/[a-zA-Z0-9_])*.+>$'
     Priority: 4
   - Regex: '<z3[a-zA-Z0-9_\+]+.+>$'
     Priority: 5

docs/algorithms/iterators.rst

@@ -14,3 +14,12 @@ Gray Code Iterator
 
 .. doxygenclass:: fiction::gray_code_iterator
    :members:
+
+
+BDL Input Iterator
+------------------
+
+**Header:** ``fiction/algorithms/iter/bdl_input_iterator.hpp``
+
+.. doxygenclass:: fiction::bdl_input_iterator
+   :members:

docs/algorithms/sidb_simulation.rst

@@ -40,7 +40,6 @@ Exhaustive Ground State Simulation
 
 **Header:** ``fiction/algorithms/simulation/sidb/quickexact.hpp``
 
-.. doxygenenum:: fiction::automatic_base_number_detection
 .. doxygenstruct:: fiction::quickexact_params
    :members:
 .. doxygenfunction:: fiction::quickexact
@@ -50,6 +49,15 @@ Exhaustive Ground State Simulation
 .. doxygenfunction:: fiction::exhaustive_ground_state_simulation
 
 
+Engine Selectors
+################
+
+**Header:** ``fiction/algorithms/simulation/sidb/sidb_simulation_engine.hpp``
+
+.. doxygenenum:: fiction::sidb_simulation_engine
+.. doxygenenum:: fiction::exhaustive_sidb_simulation_engine
+
+
 Energy Calculation
 ##################
 
@@ -76,8 +84,6 @@ Temperature Behavior
 
 **Header:** ``fiction/algorithms/simulation/sidb/critical_temperature.hpp``
 
-.. doxygenenum:: fiction::critical_temperature_mode
-.. doxygenenum:: fiction::simulation_engine
 .. doxygenstruct:: fiction::critical_temperature_params
    :members:
 .. doxygenfunction:: fiction::critical_temperature
@@ -108,7 +114,6 @@ Time-to-Solution (TTS) Statistics
 
 **Header:** ``fiction/algorithms/simulation/sidb/time_to_solution.hpp``
 
-.. doxygenenum:: fiction::exhaustive_algorithm
 .. doxygenstruct:: fiction::time_to_solution_params
    :members:
 .. doxygenfunction:: fiction::sim_acc_tts
@@ -119,7 +124,41 @@ Random SiDB Layout Generator
 
 **Header:** ``fiction/algorithms/simulation/sidb/random_sidb_layout_generator.hpp``
 
-.. doxygenenum:: fiction::positive_charges
 .. doxygenstruct:: fiction::generate_random_sidb_layout_params
 .. doxygenfunction:: fiction::generate_random_sidb_layout
 .. doxygenfunction:: fiction::generate_multiple_random_sidb_layouts
+
+
+Operational Domain Computation
+##############################
+
+**Header:** ``fiction/algorithms/simulation/sidb/operational_domain.hpp``
+
+.. doxygenstruct:: fiction::operational_domain
+   :members:
+
+.. doxygenstruct:: fiction::operational_domain_params
+   :members:
+.. doxygenstruct:: fiction::operational_domain_stats
+   :members:
+
+.. doxygenfunction:: fiction::operational_domain_grid_search
+.. doxygenfunction:: fiction::operational_domain_random_sampling
+.. doxygenfunction:: fiction::operational_domain_flood_fill
+.. doxygenfunction:: fiction::operational_domain_contour_tracing
+
+
+Utility Functions
+#################
+
+
+Binary-dot Logic (BDL) Pair Detection
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Header:** ``fiction/algorithms/simulation/sidb/detect_bdl_pairs.hpp``
+
+.. doxygenstruct:: fiction::bdl_pair
+   :members:
+.. doxygenstruct:: fiction::detect_bdl_pairs_params
+   :members:
+.. doxygenfunction:: fiction::detect_bdl_pairs

docs/index.rst

@@ -62,6 +62,7 @@ Let there be a *fiction*
    io/input.rst
    io/visualization.rst
    io/physical_simulation.rst
+   io/utility.rst
 
 .. toctree::
    :maxdepth: 2

docs/io/physical_simulation.rst

@@ -77,3 +77,13 @@ SiQAD
 .. doxygenfunction:: fiction::read_sqd_layout(Lyt& lyt, const std::string_view& filename)
 
 .. doxygenclass:: fiction::sqd_parsing_error
+
+SiDB Operational Domain
+#######################
+
+**Header:** ``fiction/io/write_operational_domain.hpp``
+
+.. doxygenstruct:: fiction::write_operational_domain_params
+   :members:
+.. doxygenfunction:: fiction::write_operational_domain(const operational_domain& opdom, std::ostream& os, const write_operational_domain_params& params = {})
+.. doxygenfunction:: fiction::write_operational_domain(const operational_domain& opdom, const std::string_view& filename, const write_operational_domain_params& params = {})

docs/io/utility.rst

@@ -0,0 +1,9 @@
+Utility
+-------
+
+Utility code for I/O.
+
+
+**Header:** ``fiction/io/csv_writer.hpp``
+
+.. doxygenclass:: fiction::csv_writer

docs/utils/utils.rst

@@ -180,3 +180,11 @@ Hashing
 This header defines implementations for ``std::hash`` for several data types.
 
 .. doxygenfunction:: fiction::hash_combine
+
+
+`phmap`
+-------
+
+**Header:** ``fiction/utils/phmap_utils.hpp``
+
+.. doxygentypedef:: fiction::locked_parallel_flat_hash_map

experiments/random_sidb_layout_generation/random_sidb_layout_generation.cpp

@@ -96,8 +96,9 @@ int main(int argc, const char* argv[])  // NOLINT
     // specifies whether positively charged SiDBs are allowed ("ALLOWED") or forbidden ("FORBIDDEN")
     const std::string charges_str = options["--positive_charges"];
     // specifies whether positively charged SiDBs are allowed ("ALLOWED") or forbidden ("FORBIDDEN")
-    const positive_charges charges =
-        (charges_str == "ALLOWED") ? positive_charges::ALLOWED : positive_charges::FORBIDDEN;
+    const generate_random_sidb_layout_params<sidb_cell_clk_lyt>::positive_charges charges =
+        (charges_str == "ALLOWED") ? generate_random_sidb_layout_params<sidb_cell_clk_lyt>::positive_charges::ALLOWED :
+                                     generate_random_sidb_layout_params<sidb_cell_clk_lyt>::positive_charges::FORBIDDEN;
     // sets the number of SiDBs for the first bunch of layouts
     const uint64_t lower_limit = std::stoull(options["--lower"]);
     // sets the number of SiDBs for the last bunch of layouts
@@ -118,8 +119,6 @@ int main(int argc, const char* argv[])  // NOLINT
     std::cout << "step: " << step << std::endl;
 
     // generates random SiDB layouts as .sqd file
-    using cell_level_layout = cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>;
-
     try
     {
         std::filesystem::path folder_path(EXPERIMENTS_PATH);
@@ -165,11 +164,11 @@ int main(int argc, const char* argv[])  // NOLINT
                     std::cout << "Folder already exists." << std::endl;
                 }
 
-                const generate_random_sidb_layout_params<cell_level_layout> params{
+                const generate_random_sidb_layout_params<sidb_cell_clk_lyt> params{
                     {{nw_x, nw_y}, {se_x, se_y}}, number_of_placed_sidbs, charges, 2,
                     static_cast<uint64_t>(10E6),  number_of_layouts};
                 const auto unique_lyts =
-                    generate_multiple_random_sidb_layouts<cell_level_layout>(cell_level_layout{}, params);
+                    generate_multiple_random_sidb_layouts<sidb_cell_clk_lyt>(sidb_cell_clk_lyt{}, params);
                 for (auto i = 0u; i < unique_lyts.size(); i++)
                 {
                     write_sqd_layout(unique_lyts[i], fmt::format("{}/layout_{}.sqd", dir_path_sqd.string(), i));

include/fiction/algorithms/iter/aspect_ratio_iterator.hpp

@@ -5,9 +5,9 @@
 #ifndef FICTION_ASPECT_RATIO_ITERATOR_HPP
 #define FICTION_ASPECT_RATIO_ITERATOR_HPP
 
-#include <algorithm>
 #include <cmath>
 #include <cstdint>
+#include <iterator>
 #include <vector>
 
 namespace fiction
@@ -75,47 +75,47 @@ class aspect_ratio_iterator
         return result;
     }
 
-    AspectRatio operator*() const
+    [[nodiscard]] AspectRatio operator*() const
     {
         return *it;
     }
 
-    bool operator==(const uint64_t m) const noexcept
+    [[nodiscard]] bool operator==(const uint64_t m) const noexcept
     {
         return num == m;
     }
 
-    bool operator==(const aspect_ratio_iterator& other) const
+    [[nodiscard]] bool operator==(const aspect_ratio_iterator& other) const
     {
         return (num == other.num) && (*it == *(other.it));
     }
 
-    bool operator!=(const uint64_t m) const noexcept
+    [[nodiscard]] bool operator!=(const uint64_t m) const noexcept
     {
         return num != m;
     }
 
-    bool operator!=(const aspect_ratio_iterator& other) const
+    [[nodiscard]] bool operator!=(const aspect_ratio_iterator& other) const
     {
         return !(*this == other);
     }
 
-    bool operator<(const uint64_t m) const noexcept
+    [[nodiscard]] bool operator<(const uint64_t m) const noexcept
     {
         return num < m;
     }
 
-    bool operator<(const aspect_ratio_iterator& other) const
+    [[nodiscard]] bool operator<(const aspect_ratio_iterator& other) const
     {
         return (num < other.num) || (num == other.num && *it < *(other.it));
     }
 
-    bool operator<=(const uint64_t m) const noexcept
+    [[nodiscard]] bool operator<=(const uint64_t m) const noexcept
     {
         return num <= m;
     }
 
-    bool operator<=(const aspect_ratio_iterator& other) const
+    [[nodiscard]] bool operator<=(const aspect_ratio_iterator& other) const
     {
         return (num <= other.num) || (num == other.num && *it <= *(other.it));
     }