🐍 Add a .pyi file for integration with type checking, documentation, and IDE auto-completion

bindings/mnt/pyfiction/__init__.py

@@ -34,9 +34,10 @@
     ## physical_design
     apply_qca_one_library,
     apply_topolinano_library,
-    # Technology
     area,
-    assess_physical_population_stability,
+    assess_physical_population_stability_100,
+    assess_physical_population_stability_111,
+    # Technology
     assess_physical_population_stability_params,
     automatic_base_number_detection,
     bdl_input_iterator_100,
@@ -71,7 +72,6 @@
     color_routing_params,
     compute_operational_ratio,
     compute_operational_ratio_params,
-    convert_layout_to_siqad_coordinates,
     convert_potential_to_distance,
     create_and3_tt,
     create_and_tt,
@@ -105,9 +105,7 @@
     critical_temperature_non_gate_based,
     critical_temperature_params,
     critical_temperature_stats,
-    cube_area,
     cube_coordinate,
-    cube_volume,
     defect_extent,
     dependent_cell_mode,
     design_sidb_gates,
@@ -152,9 +150,6 @@
     ## verfication
     gate_level_drv_params,
     gate_level_drvs,
-    generate_multiple_random_sidb_layouts,
-    generate_random_sidb_layout,
-    generate_random_sidb_layout_params,
     get_name,
     gold_cost_objective,
     gold_effort_mode,
@@ -197,9 +192,7 @@
     num_adjacent_coordinates,
     occupation_probability_gate_based,
     occupation_probability_non_gate_based,
-    offset_area,
     offset_coordinate,
-    offset_volume,
     operational_condition,
     operational_domain,
     operational_domain_contour_tracing,
@@ -219,7 +212,6 @@
     physically_valid_parameters_domain,
     place,
     population_stability_information,
-    positive_charges,
     post_layout_optimization,
     post_layout_optimization_params,
     post_layout_optimization_stats,
@@ -263,9 +255,7 @@
     sign_to_charge_state,
     ### logic
     simulate,
-    siqad_area,
     siqad_coordinate,
-    siqad_volume,
     sqd_parsing_error,
     squared_euclidean_distance,
     ## network_transformation
@@ -291,6 +281,7 @@
     undefined_cell_label_exception,
     unrecognized_cell_definition_exception,
     unsupported_character_exception,
+    volume,
     wiring_reduction,
     wiring_reduction_params,
     wiring_reduction_stats,
@@ -336,7 +327,8 @@
     "apply_topolinano_library",
     # Technology
     "area",
-    "assess_physical_population_stability",
+    "assess_physical_population_stability_100",
+    "assess_physical_population_stability_111",
     "assess_physical_population_stability_params",
     "automatic_base_number_detection",
     "bdl_input_iterator_100",
@@ -371,7 +363,6 @@
     "color_routing_params",
     "compute_operational_ratio",
     "compute_operational_ratio_params",
-    "convert_layout_to_siqad_coordinates",
     "convert_potential_to_distance",
     "create_and3_tt",
     "create_and_tt",
@@ -405,9 +396,7 @@
     "critical_temperature_non_gate_based",
     "critical_temperature_params",
     "critical_temperature_stats",
-    "cube_area",
     "cube_coordinate",
-    "cube_volume",
     "defect_extent",
     "dependent_cell_mode",
     "design_sidb_gates",
@@ -452,9 +441,6 @@
     ## verfication
     "gate_level_drv_params",
     "gate_level_drvs",
-    "generate_multiple_random_sidb_layouts",
-    "generate_random_sidb_layout",
-    "generate_random_sidb_layout_params",
     "get_name",
     "gold_cost_objective",
     "gold_effort_mode",
@@ -477,6 +463,7 @@
     "is_charged_defect_type",
     "is_crossable_wire",
     "is_fanout_substituted",
+    set_name,
     "is_ground_state",
     "is_kink_induced_non_operational",
     "is_negatively_charged_defect",
@@ -497,9 +484,7 @@
     "num_adjacent_coordinates",
     "occupation_probability_gate_based",
     "occupation_probability_non_gate_based",
-    "offset_area",
     "offset_coordinate",
-    "offset_volume",
     "operational_condition",
     "operational_domain",
     "operational_domain_contour_tracing",
@@ -519,7 +504,6 @@
     "physically_valid_parameters_domain",
     "place",
     "population_stability_information",
-    "positive_charges",
     "post_layout_optimization",
     "post_layout_optimization_params",
     "post_layout_optimization_stats",
@@ -541,7 +525,6 @@
     "route_path",
     # "write_location_and_ground_state",
     "sample_writing_mode",
-    "set_name",
     "shifted_cartesian_gate_layout",
     "shifted_cartesian_layout",
     "shifted_cartesian_obstruction_layout",
@@ -550,7 +533,6 @@
     "sidb_charge_state",
     "sidb_defect",
     "sidb_defect_type",
-    "sidb_lattice_mode",
     "sidb_layout",
     "sidb_nm_distance_100",
     "sidb_nm_distance_111",
@@ -563,9 +545,9 @@
     "sign_to_charge_state",
     ### logic
     "simulate",
-    "siqad_area",
+    "area",
     "siqad_coordinate",
-    "siqad_volume",
+    "volume",
     "sqd_parsing_error",
     "squared_euclidean_distance",
     ## network_transformation
@@ -614,4 +596,5 @@
     "write_sqd_sim_result",
     "yen_k_shortest_paths",
     "yen_k_shortest_paths_params",
+    "sidb_lattice_mode",
 ]

bindings/mnt/pyfiction/include/pyfiction/algorithms/network_transformation/technology_mapping.hpp

@@ -73,9 +73,7 @@ inline void technology_mapping(pybind11::module& m)
     py::class_<fiction::technology_mapping_stats>(m, "technology_mapping_stats", DOC(fiction_technology_mapping_stats))
         .def(py::init<>())
         .def("__repr__", [](const fiction::technology_mapping_stats& stats) { return stats.report(); })
-        .def("report", &fiction::technology_mapping_stats::report, DOC(fiction_technology_mapping_stats_report))
-        .def_readonly("mapper_stats", &fiction::technology_mapping_stats::mapper_stats,
-                      DOC(fiction_technology_mapping_stats_mapper_stats));
+        .def("report", &fiction::technology_mapping_stats::report, DOC(fiction_technology_mapping_stats_report));
 
     m.def("and_or_not", &fiction::and_or_not, DOC(fiction_and_or_not));
 

bindings/mnt/pyfiction/include/pyfiction/algorithms/path_finding/k_shortest_paths.hpp

@@ -60,7 +60,7 @@ inline void yen_k_shortest_paths(pybind11::module& m)
     py::class_<fiction::yen_k_shortest_paths_params>(m, "yen_k_shortest_paths_params",
                                                      DOC(fiction_yen_k_shortest_paths_params))
         .def(py::init<>())
-        .def_readwrite("a_star_params", &fiction::yen_k_shortest_paths_params::astar_params,
+        .def_readwrite("astar_params", &fiction::yen_k_shortest_paths_params::astar_params,
                        DOC(fiction_yen_k_shortest_paths_params_astar_params))
 
         ;

bindings/mnt/pyfiction/include/pyfiction/algorithms/physical_design/exact.hpp

@@ -13,7 +13,6 @@
 #include <fiction/algorithms/physical_design/exact.hpp>
 
 #include <pybind11/pybind11.h>
-#include <pybind11/stl.h>
 
 #include <sstream>
 
@@ -26,7 +25,6 @@ namespace pyfiction
 inline void exact(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::enum_<fiction::technology_constraints>(m, "technology_constraints", DOC(fiction_technology_constraints))
         .value("NONE", fiction::technology_constraints::NONE, DOC(fiction_technology_constraints_NONE))
@@ -39,6 +37,8 @@ inline void exact(pybind11::module& m)
         .def(py::init<>())
         .def_readwrite("scheme", &fiction::exact_physical_design_params::scheme,
                        DOC(fiction_exact_physical_design_params_scheme))
+        .def_readwrite("upper_bound_area", &fiction::exact_physical_design_params::upper_bound_area,
+                       DOC(fiction_exact_physical_design_params_upper_bound_area))
         .def_readwrite("upper_bound_x", &fiction::exact_physical_design_params::upper_bound_x,
                        DOC(fiction_exact_physical_design_params_upper_bound_x))
         .def_readwrite("upper_bound_y", &fiction::exact_physical_design_params::upper_bound_y,

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

@@ -25,7 +25,6 @@ namespace pyfiction
 inline void graph_oriented_layout_design(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::enum_<fiction::graph_oriented_layout_design_params::effort_mode>(
         m, "gold_effort_mode", DOC(fiction_graph_oriented_layout_design_params_effort_mode))

bindings/mnt/pyfiction/include/pyfiction/algorithms/physical_design/hexagonalization.hpp

@@ -12,28 +12,29 @@
 
 #include <pybind11/pybind11.h>
 
-namespace pyfiction
-{
+#include <sstream>
 
-namespace detail
+namespace pyfiction
 {
 
-template <typename Lyt>
-void hexagonalization(pybind11::module& m)
+inline void hexagonalization(pybind11::module& m)
 {
     namespace py = pybind11;
 
-    m.def(
-        "hexagonalization", [](const Lyt& lyt) -> py_hexagonal_gate_layout
-        { return fiction::hexagonalization<py_hexagonal_gate_layout, Lyt>(lyt); }, py::arg("layout"),
-        DOC(fiction_hexagonalization));
-}
-
-}  // namespace detail
-
-inline void hexagonalization(pybind11::module& m)
-{
-    detail::hexagonalization<py_cartesian_gate_layout>(m);
+    py::class_<fiction::hexagonalization_stats>(m, "hexagonalization_stats", DOC(fiction_hexagonalization_stats))
+        .def(py::init<>())
+        .def("__repr__",
+             [](const fiction::hexagonalization_stats& stats)
+             {
+                 std::stringstream stream{};
+                 stats.report(stream);
+                 return stream.str();
+             })
+        .def_readonly("time_total", &fiction::hexagonalization_stats::time_total,
+                      DOC(fiction_hexagonalization_stats_duration));
+
+    m.def("hexagonalization", &fiction::hexagonalization<py_hexagonal_gate_layout, py_cartesian_gate_layout>,
+          py::arg("layout"), py::arg("statistics") = nullptr, DOC(fiction_hexagonalization));
 }
 
 }  // namespace pyfiction

bindings/mnt/pyfiction/include/pyfiction/algorithms/physical_design/orthogonal.hpp

@@ -11,7 +11,6 @@
 #include <fiction/algorithms/physical_design/orthogonal.hpp>
 
 #include <pybind11/pybind11.h>
-#include <pybind11/stl.h>
 
 #include <sstream>
 
@@ -24,7 +23,6 @@ namespace pyfiction
 inline void orthogonal(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::class_<fiction::orthogonal_physical_design_params>(m, "orthogonal_params",
                                                            DOC(fiction_orthogonal_physical_design_params))

bindings/mnt/pyfiction/include/pyfiction/algorithms/physical_design/post_layout_optimization.hpp

@@ -21,7 +21,6 @@ namespace pyfiction
 inline void post_layout_optimization(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::class_<fiction::post_layout_optimization_params>(m, "post_layout_optimization_params",
                                                          DOC(fiction_post_layout_optimization_params))

bindings/mnt/pyfiction/include/pyfiction/algorithms/physical_design/wiring_reduction.hpp

@@ -21,7 +21,6 @@ namespace pyfiction
 inline void wiring_reduction(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::class_<fiction::wiring_reduction_params>(m, "wiring_reduction_params", DOC(fiction_wiring_reduction_params))
         .def(py::init<>())

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/logic_simulation.hpp

@@ -5,7 +5,6 @@
 #ifndef PYFICTION_LOGIC_SIMULATION_HPP
 #define PYFICTION_LOGIC_SIMULATION_HPP
 
-#include "pyfiction/documentation.hpp"
 #include "pyfiction/types.hpp"
 
 #include <fiction/utils/name_utils.hpp>
@@ -16,6 +15,7 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 
+#include <cassert>
 #include <string>
 #include <unordered_map>
 #include <vector>

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/sidb/assess_physical_population_stability.hpp

@@ -23,7 +23,6 @@ template <typename Lyt>
 void assess_physical_population_stability(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     m.def("assess_physical_population_stability", &fiction::assess_physical_population_stability<Lyt>, py::arg("lyt"),
           py::arg("params") = fiction::assess_physical_population_stability_params{},

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/sidb/compute_operational_ratio.hpp

@@ -24,7 +24,6 @@ template <typename Lyt>
 void compute_operational_ratio(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     m.def("compute_operational_ratio", &fiction::compute_operational_ratio<Lyt, py_tt>, py::arg("lyt"), py::arg("spec"),
           py::arg("pp"), py::arg("params") = fiction::operational_domain_params{},
@@ -36,7 +35,6 @@ void compute_operational_ratio(pybind11::module& m)
 inline void compute_operational_ratio(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::class_<fiction::compute_operational_ratio_params>(m, "compute_operational_ratio_params",
                                                           DOC(fiction_compute_operational_ratio_params))

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/sidb/detect_bdl_pairs.hpp

@@ -38,7 +38,6 @@ void detect_bdl_pairs(pybind11::module& m)
 inline void detect_bdl_pairs(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::class_<fiction::bdl_pair<fiction::offset::ucoord_t>>(m, "bdl_pair", DOC(fiction_bdl_pair))
         .def(py::init<>(), DOC(fiction_bdl_pair_bdl_pair))

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/sidb/detect_bdl_wires.hpp

@@ -24,7 +24,6 @@ template <typename Lyt>
 void detect_bdl_wires(pybind11::module& m, const std::string& lattice)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     using bdl_wire_t = fiction::bdl_wire<Lyt>;
 
@@ -52,7 +51,6 @@ void detect_bdl_wires(pybind11::module& m, const std::string& lattice)
 inline void detect_bdl_wires(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     // Enum for wire selection options
     py::enum_<fiction::bdl_wire_selection>(m, "bdl_wire_selection", DOC(fiction_bdl_wire_selection))