type fix

quantumlib · Mar 12, 2024 · 1f05663 · 1f05663
1 parent f5d53cb
commit 1f05663
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 7 deletions.
diff --git a/doc/python_api_reference_vDev.md b/doc/python_api_reference_vDev.md
@@ -1281,8 +1281,8 @@ def count_determined_measurements(
 def detecting_regions(
     self,
     *,
-    included_targets: Iterable[Iterable[float] | str | stim.DemTarget] | None = None,
-    included_ticks: None | Iterable[int] = None,
+    targets: Optional[Iterable[stim.DemTarget | str | Iterable[float]]] = None,
+    ticks: Optional[Iterable[int]] = None,
 ) -> Dict[stim.DemTarget, Dict[int, stim.PauliString]]:
     """Records where detectors and observables are sensitive to errors over time.
 

diff --git a/doc/stim.pyi b/doc/stim.pyi
@@ -719,8 +719,8 @@ class Circuit:
     def detecting_regions(
         self,
         *,
-        included_targets: Iterable[Iterable[float] | str | stim.DemTarget] | None = None,
-        included_ticks: None | Iterable[int] = None,
+        targets: Optional[Iterable[stim.DemTarget | str | Iterable[float]]] = None,
+        ticks: Optional[Iterable[int]] = None,
     ) -> Dict[stim.DemTarget, Dict[int, stim.PauliString]]:
         """Records where detectors and observables are sensitive to errors over time.
 

diff --git a/glue/python/src/stim/__init__.pyi b/glue/python/src/stim/__init__.pyi
@@ -719,8 +719,8 @@ class Circuit:
     def detecting_regions(
         self,
         *,
-        included_targets: Iterable[Iterable[float] | str | stim.DemTarget] | None = None,
-        included_ticks: None | Iterable[int] = None,
+        targets: Optional[Iterable[stim.DemTarget | str | Iterable[float]]] = None,
+        ticks: Optional[Iterable[int]] = None,
     ) -> Dict[stim.DemTarget, Dict[int, stim.PauliString]]:
         """Records where detectors and observables are sensitive to errors over time.
 

diff --git a/src/stim/circuit/circuit.pybind.cc b/src/stim/circuit/circuit.pybind.cc
@@ -2149,7 +2149,7 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
         pybind11::arg("ticks") = pybind11::none(),
         pybind11::arg("ignore_anticommutation_errors") = false,
         clean_doc_string(R"DOC(
-            @signature def detecting_regions(self, *, included_targets: Iterable[Iterable[float] | str | stim.DemTarget] | None = None, included_ticks: None | Iterable[int] = None) -> Dict[stim.DemTarget, Dict[int, stim.PauliString]]:
+            @signature def detecting_regions(self, *, targets: Optional[Iterable[stim.DemTarget | str | Iterable[float]]] = None, ticks: Optional[Iterable[int]] = None) -> Dict[stim.DemTarget, Dict[int, stim.PauliString]]:
             Records where detectors and observables are sensitive to errors over time.
 
             The result of this method is a nested dictionary, mapping detectors/observables

diff --git a/src/stim/circuit/circuit_pybind_test.py b/src/stim/circuit/circuit_pybind_test.py
@@ -1714,3 +1714,13 @@ def test_detecting_regions():
         1: stim.PauliString("X_"),
         2: stim.PauliString("XX"),
     }}
+
+
+def test_detecting_region_filters():
+    c = stim.Circuit.generated("repetition_code:memory", distance=3, rounds=3)
+    assert len(c.detecting_regions(targets=["D"])) == c.num_detectors
+    assert len(c.detecting_regions(targets=["L"])) == c.num_observables
+    assert len(c.detecting_regions()) == c.num_observables + c.num_detectors
+    assert len(c.detecting_regions(targets=["D0"])) == 1
+    assert len(c.detecting_regions(targets=["D0", "L0"])) == 2
+    assert len(c.detecting_regions(targets=[stim.target_relative_detector_id(0), "D0"])) == 1