Merge pull request #1 from quantumlib/main

Add UNIT_SWEEP as an alias for UnitSweep (quantumlib#6518)
senecameeks · Mar 22, 2024 · d2cf0db · d2cf0db
2 parents a99a93e + edda3a5
commit d2cf0db
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/cirq-core/cirq/__init__.py b/cirq-core/cirq/__init__.py
@@ -509,6 +509,7 @@
     to_sweeps,
     Result,
     UnitSweep,
+    UNIT_SWEEP,
     Zip,
     ZipLongest,
 )

diff --git a/cirq-core/cirq/protocols/json_test_data/spec.py b/cirq-core/cirq/protocols/json_test_data/spec.py
@@ -109,6 +109,7 @@
         'StateVectorStepResult',
         'StepResultBase',
         'UnitSweep',
+        'UNIT_SWEEP',
         'NamedTopology',
         # protocols:
         'HasJSONNamespace',

diff --git a/cirq-core/cirq/study/__init__.py b/cirq-core/cirq/study/__init__.py
@@ -36,6 +36,7 @@
     Points,
     Product,
     Sweep,
+    UNIT_SWEEP,
     UnitSweep,
     Zip,
     ZipLongest,

diff --git a/cirq-core/cirq/study/sweeps.py b/cirq-core/cirq/study/sweeps.py
@@ -205,6 +205,10 @@ def _json_dict_(self) -> Dict[str, Any]:
 UnitSweep = _Unit()
 document(UnitSweep, """The singleton sweep with no parameters.""")
 
+# Alternate name to designate as a constant.
+UNIT_SWEEP = UnitSweep
+document(UNIT_SWEEP, """The singleton sweep with no parameters.""")
+
 
 class Product(Sweep):
     """Cartesian product of one or more sweeps.

diff --git a/cirq-core/cirq/study/sweeps_test.py b/cirq-core/cirq/study/sweeps_test.py
@@ -232,6 +232,9 @@ def test_equality():
 
     et.add_equality_group(cirq.UnitSweep, cirq.UnitSweep)
 
+    # Test singleton
+    assert cirq.UNIT_SWEEP is cirq.UnitSweep
+
     # Simple sweeps with the same key are equal to themselves, but different
     # from each other even if they happen to contain the same points.
     et.make_equality_group(lambda: cirq.Linspace('a', 0, 10, 11))