✨ Add function to detect if non-operational status is due to wire kink

bindings/pyfiction/include/pyfiction/algorithms/simulation/sidb/is_operational.hpp

@@ -13,7 +13,7 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 
-#include <string>
+#include <optional>
 
 namespace pyfiction
 {
@@ -32,6 +32,14 @@ void is_operational(pybind11::module& m)
 
     m.def("operational_input_patterns", &fiction::operational_input_patterns<Lyt, py_tt>, "lyt"_a, "spec"_a,
           "params"_a = fiction::is_operational_params{}, DOC(fiction_operational_input_patterns));
+
+    m.def("is_non_operational_due_to_kinks", &fiction::is_non_operational_due_to_kinks<Lyt, py_tt>, "lyt"_a, "spec"_a,
+          "params"_a = fiction::is_operational_params{}, "input_bdl_wire"_a = std::nullopt,
+          "output_bdl_wire"_a = std::nullopt, DOC(fiction_is_non_operational_due_to_kinks));
+
+    m.def("non_operational_input_patterns_due_to_kinks",
+          &fiction::non_operational_input_patterns_due_to_kinks<Lyt, py_tt>, "lyt"_a, "spec"_a,
+          "params"_a = fiction::is_operational_params{}, DOC(fiction_non_operational_input_patterns_due_to_kinks));
 }
 
 }  // namespace detail

bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

@@ -6801,12 +6801,19 @@ Parameter ``current_input_index``:
     `true` if any output wire contains a kink (i.e., an unexpected
     charge state), `false` otherwise.)doc";
 
-static const char *__doc_fiction_detail_is_operational_impl_determine_operational_input_patterns =
-R"doc(Determines the input combinations yielding the correct output.
+static const char *__doc_fiction_detail_is_operational_impl_determine_non_operational_input_patterns_and_op_status_due_kinks =
+R"doc(Determines the input combinations yielding the wrong output and the
+information if non-operational status is due to kinks. `True`
+indicates that the layout is non-operational due to kinks, `false`
+otherwise.
 
 Returns:
-    All inputs (e.g. 2-input Boolean function: 00 ^= 0; 10 ^= 2) for
-    which the correct output is computed.)doc";
+    Set of pairs where the first element is a the the input paattern
+    (e.g. 2-input Boolean function: 00 ^= 0; 10 ^= 2) for which the
+    wrong output is computed. The second entry indicates the
+    information if the non-operational status is due to kinks. `True`
+    indicates that the layout is non-operational due to kinks, `false`
+    otherwise.)doc";
 
 static const char *__doc_fiction_detail_is_operational_impl_encodes_bit_one =
 R"doc(This function returns `true` if `1` is encoded in the charge state of
@@ -6848,6 +6855,13 @@ R"doc(Returns the total number of simulator invocations.
 
 static const char *__doc_fiction_detail_is_operational_impl_input_bdl_wires = R"doc(Input BDL wires.)doc";
 
+static const char *__doc_fiction_detail_is_operational_impl_is_non_operational_due_to_kinks =
+R"doc(Returns whether the layout is non-operational due to kinks.
+
+Returns:
+    `true` if the layout is non-operational due to kinks, `false`
+    otherwise.)doc";
+
 static const char *__doc_fiction_detail_is_operational_impl_is_operational_impl =
 R"doc(Constructor to initialize the algorithm with a layout and parameters.
 
@@ -6882,6 +6896,8 @@ Parameter ``output_wires``:
 
 static const char *__doc_fiction_detail_is_operational_impl_layout = R"doc(SiDB cell-level layout.)doc";
 
+static const char *__doc_fiction_detail_is_operational_impl_non_operational_due_to_kinks = R"doc(Indicates whether the layout is non-operational due to kinks.)doc";
+
 static const char *__doc_fiction_detail_is_operational_impl_output_bdl_pairs = R"doc(Output BDL pairs.)doc";
 
 static const char *__doc_fiction_detail_is_operational_impl_output_bdl_wires = R"doc(Output BDL wires.)doc";
@@ -13663,6 +13679,36 @@ Parameter ``defect``:
 Returns:
     `true` iff `defect` has a neutral charge value.)doc";
 
+static const char *__doc_fiction_is_non_operational_due_to_kinks =
+R"doc(Determines if the layout is non-operational due to kinks.
+
+Template parameter ``Lyt``:
+    SiDB cell-level layout type.
+
+Template parameter ``TT``:
+    The type of the truth table specifying the layout behavior.
+
+Parameter ``lyt``:
+    The SiDB cell-level layout to be checked.
+
+Parameter ``spec``:
+    Expected Boolean function of the layout given as a multi-output
+    truth table.
+
+Parameter ``params``:
+    Parameters for the `is_operational` algorithm.
+
+Parameter ``input_bdl_wire``:
+    Optional BDL input wires of lyt.
+
+Parameter ``output_bdl_wire``:
+    Optional BDL output wires of lyt.
+
+Returns:
+    Bool that indicates whether the layout is non-operational due to
+    kinks. `true` if the layout is not usable due to kinks, `false`
+    otherwise.)doc";
+
 static const char *__doc_fiction_is_operational =
 R"doc(Determine the operational status of an SiDB layout.
 
@@ -13693,9 +13739,6 @@ Parameter ``input_bdl_wire``:
 Parameter ``output_bdl_wire``:
     Optional BDL output wires of lyt.
 
-Parameter ``input_bdl_wire_direction``:
-    Optional BDL input wire directions of lyt.
-
 Returns:
     A pair containing the operational status of the gate layout
     (either `OPERATIONAL` or `NON_OPERATIONAL`) and the number of
@@ -14086,6 +14129,29 @@ Parameter ``file``:
 Parameter ``rfun``:
     The actual parsing function.)doc";
 
+static const char *__doc_fiction_non_operational_input_patterns_due_to_kinks =
+R"doc(This function determines the input combinations for which the SiDB-
+based logic, represented by the provided layout (`lyt`) and truth
+table specifications (`spec`), are non-operational due to kinks.
+
+Template parameter ``Lyt``:
+    Type of the cell-level layout.
+
+Template parameter ``TT``:
+    Type of the truth table.
+
+Parameter ``lyt``:
+    The SiDB layout.
+
+Parameter ``spec``:
+    Vector of truth table specifications.
+
+Parameter ``params``:
+    Parameters to simulate if a input combination is operational.
+
+Returns:
+    The non-operational input combinations due to kinks.)doc";
+
 static const char *__doc_fiction_normalize_layout_coordinates =
 R"doc(A new layout is constructed and returned that is equivalent to the
 given cell-level layout. However, its coordinates are normalized,

bindings/pyfiction/test/algorithms/simulation/sidb/test_is_operational.py

@@ -56,6 +56,29 @@ def test_and_gate_kinks(self):
 
         self.assertEqual(op_status, operational_status.NON_OPERATIONAL)
 
+
+    def test_and_gate_non_operational_due_to_kinks(self):
+
+        lyt = read_sqd_layout_100(dir_path + "/../../../resources/AND_mu_032_kinks.sqd")
+
+        params = is_operational_params()
+        params.simulation_parameters = sidb_simulation_parameters(2, -0.32)
+
+        result = is_non_operational_due_to_kinks(lyt, [create_and_tt()], params)
+
+        self.assertTrue(result)
+
+    def test_and_gate_non_operational_input_patterns_due_to_kinks(self):
+
+        lyt = read_sqd_layout_100(dir_path + "/../../../resources/AND_mu_032_kinks.sqd")
+
+        params = is_operational_params()
+        params.simulation_parameters = sidb_simulation_parameters(2, -0.32)
+
+        non_operational_pattern_kinks = non_operational_input_patterns_due_to_kinks(lyt, [create_and_tt()], params)
+
+        self.assertEqual(non_operational_pattern_kinks, {1, 2})
+
     def test_and_gate_111_lattice_11_input_pattern(self):
         lyt = read_sqd_layout_111(dir_path + "/../../../resources/AND_mu_032_111_surface.sqd")
 

docs/algorithms/sidb_simulation.rst

@@ -235,6 +235,8 @@ Operational Domain Computation
            :members:
         .. doxygenfunction:: fiction::is_operational
         .. doxygenfunction:: fiction::operational_input_patterns
+        .. doxygenfunction:: fiction::is_non_operational_due_to_kinks
+        .. doxygenfunction:: fiction::non_operational_input_patterns_due_to_kinks
 
         **Header:** ``fiction/algorithms/simulation/sidb/operational_domain.hpp``
 
@@ -274,6 +276,8 @@ Operational Domain Computation
             :members:
         .. autofunction:: mnt.pyfiction.is_operational
         .. autofunction:: mnt.pyfiction.operational_input_patterns
+        .. autofunction:: mnt.pyfiction.is_non_operational_due_to_kinks
+        .. autofunction:: mnt.pyfiction.non_operational_input_patterns_due_to_kinks
 
         .. autoclass:: mnt.pyfiction.sweep_parameter
             :members: