✨ Multithreading support for gold

bindings/pyfiction/include/pyfiction/algorithms/physical_design/graph_oriented_layout_design.hpp

@@ -70,8 +70,8 @@ inline void graph_oriented_layout_design(pybind11::module& m)
                        DOC(fiction_graph_oriented_layout_design_params_return_first))
         .def_readwrite("planar", &fiction::graph_oriented_layout_design_params::planar,
                        DOC(fiction_graph_oriented_layout_design_params_planar))
-
-        ;
+        .def_readwrite("enable_multithreading", &fiction::graph_oriented_layout_design_params::enable_multithreading,
+                       DOC(fiction_graph_oriented_layout_design_params_enable_multithreading));
 
     py::class_<fiction::graph_oriented_layout_design_stats>(m, "graph_oriented_layout_design_stats",
                                                             DOC(fiction_graph_oriented_layout_design_stats))

bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

@@ -6094,8 +6094,6 @@ static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_max_pl
 
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_ntk = R"doc(The network to be placed and routed.)doc";
 
-static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_evaluated_paths = R"doc(Count evaluated paths in the search space graphs.)doc";
-
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_search_space_graphs = R"doc(Number of search space graphs.)doc";
 
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_search_space_graphs_high_efficiency = R"doc(In high-efficiency mode, only 2 search space graphs are used)doc";
@@ -6200,6 +6198,14 @@ static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_start
 
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_timeout = R"doc(Timeout limit (in ms).)doc";
 
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_timeout_limit_reached = R"doc(Timeout limit reached.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_update_stats =
+R"doc(This function updates statistical metrics.
+
+Parameter ``best_lyt``:
+    The new best layout found.)doc";
+
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_valid_layout =
 R"doc(Validates the given layout based on the nodes in the network and their
 mappings in the node dictionary. It checks if the placement of nodes
@@ -11160,6 +11166,28 @@ wider exploration increases the chance of finding optimal layouts but
 also extends runtime. When a solution is found in any graph, its cost
 is used to prune the remaining graphs.)doc";
 
+static const char *__doc_fiction_graph_oriented_layout_design_params_enable_multithreading =
+R"doc(BETA feature: Flag to enable or disable multithreading during the
+execution of the layout design algorithm.
+
+When set to `true`, the algorithm will utilize multiple threads to
+process different search space graphs in parallel, improving
+performance by distributing the workload across available CPU cores.
+If set to `false`, the algorithm will run sequentially on a single
+thread.
+
+Only recommended for `HIGH_EFFORT` and `HIGHEST_EFFORT` modes and
+complex networks (> 100 nodes).
+
+Enabling multithreading can significantly speed up the algorithm,
+especially when using multiple search space graphs and dealing with
+complex networks, by concurrently expanding them. However, it may
+introduce additional overhead for thread synchronization and can
+increase memory usage. It is therefore not recommended for small input
+networks.
+
+Default value: `false`)doc";
+
 static const char *__doc_fiction_graph_oriented_layout_design_params_mode = R"doc(The effort mode used. Defaults to HIGH_EFFORT.)doc";
 
 static const char *__doc_fiction_graph_oriented_layout_design_params_num_vertex_expansions =

bindings/pyfiction/test/algorithms/physical_design/test_graph_oriented_layout_design.py

@@ -56,6 +56,7 @@ def test_graph_oriented_layout_design_with_different_parameters(self):
         params.num_vertex_expansions = 5
         params.planar = False
         params.cost = gold_cost_objective.WIRES
+        params.enable_multithreading = False
 
         layout = graph_oriented_layout_design(network, params)
 
@@ -76,5 +77,17 @@ def custom_cost_objective(layout):
 
         self.assertNotEqual(equivalence_checking(network, layout), eq_type.NO)
 
+    def test_graph_oriented_layout_design_with_multithreading(self):
+        network = read_technology_network(dir_path + "/../../resources/mux21.v")
+
+        params = graph_oriented_layout_design_params()
+        params.return_first = True
+        params.mode = gold_effort_mode.HIGH_EFFORT
+        params.enable_multithreading = True
+
+        layout = graph_oriented_layout_design(network, params)
+
+        self.assertNotEqual(equivalence_checking(network, layout), eq_type.NO)
+
 if __name__ == '__main__':
     unittest.main()

cli/cmd/physical_design/gold.hpp

@@ -63,6 +63,7 @@ class gold_command : public command
         add_flag("--return_first,-r", ps.return_first,
                  "Terminate on the first found layout; reduces runtime but might sacrifice result quality");
         add_flag("--planar,-p", ps.planar, "Enable planar layout generation");
+        add_flag("--multithreading,-m", ps.enable_multithreading, "Enable multithreading (beta feature)");
         add_flag("--verbose,-v", ps.verbose, "Be verbose");
     }