cirq-core 1.7.0.dev20250915211227__py3-none-any.whl → 1.7.0.dev20250917023732__py3-none-any.whl

cirq/testing/consistent_qasm_test.py

@@ -32,10 +32,10 @@ class Fixed(cirq.Operation):
         return self.unitary
 
     @property
-    def qubits(self):
-        return cirq.LineQubit.range(self.unitary.shape[0].bit_length() - 1)
+    def qubits(self) -> tuple[cirq.Qid, ...]:
+        return tuple(cirq.LineQubit.range(self.unitary.shape[0].bit_length() - 1))
 
-    def with_qubits(self, *new_qubits):
+    def with_qubits(self, *new_qubits) -> Fixed:
         raise NotImplementedError()
 
     def _qasm_(self, args: cirq.QasmArgs):

cirq/transformers/eject_z.py

@@ -119,6 +119,7 @@ def eject_z(
             return []
 
         # Try to move the tracked phases over the operation via protocols.phase_by(op)
+        phased_op: cirq.Operation | None
         phased_op = op
         for i, p in enumerate([qubit_phase[q] for q in op.qubits]):
             if not single_qubit_decompositions.is_negligible_turn(p, atol):

cirq/transformers/gauge_compiling/__init__.py

@@ -42,3 +42,8 @@ from cirq.transformers.gauge_compiling.sqrt_iswap_gauge import (
 from cirq.transformers.gauge_compiling.cphase_gauge import (
     CPhaseGaugeTransformer as CPhaseGaugeTransformer,
 )
+
+
+from cirq.transformers.gauge_compiling.idle_moments_gauge import (
+    IdleMomentsGauge as IdleMomentsGauge,
+)

cirq/transformers/gauge_compiling/idle_moments_gauge.py

@@ -0,0 +1,222 @@
+# Copyright 2025 The Cirq Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import functools
+from typing import Hashable, Iterator, Sequence, TYPE_CHECKING
+
+import attrs
+import numpy as np
+
+import cirq.circuits as circuits
+import cirq.ops as ops
+import cirq.protocols as protocols
+import cirq.transformers.transformer_api as transformer_api
+
+if TYPE_CHECKING:
+    import cirq
+
+_PAULIS: tuple[cirq.Gate, ...] = (ops.I, ops.X, ops.Y, ops.Z)  # type: ignore[has-type]
+_CLIFFORDS = tuple(ops.SingleQubitCliffordGate.all_single_qubit_cliffords)
+_INV_CLIFFORDS = tuple(c**-1 for c in ops.SingleQubitCliffordGate.all_single_qubit_cliffords)
+
+_NAME_TO_GATES = {'pauli': _PAULIS, 'clifford': _CLIFFORDS, 'inv_clifford': _INV_CLIFFORDS}
+
+
+def _gauges_arg_converter(gauges: str | Sequence[cirq.Gate] = 'clifford') -> tuple[cirq.Gate, ...]:
+    if isinstance(gauges, str):
+        if gauges not in _NAME_TO_GATES:
+            valid_names = tuple(_NAME_TO_GATES.keys())
+            raise ValueError(f"{gauges} is not a valid gauge name, valid names are {valid_names}")
+        return _NAME_TO_GATES[gauges]
+    return tuple(gauges)
+
+
+def _repr_fn(gauges: tuple[cirq.Gate, ...]) -> str:
+    if gauges is _PAULIS or gauges == _PAULIS:
+        return '"pauli"'
+    if gauges is _CLIFFORDS or gauges == _CLIFFORDS:
+        return '"clifford"'
+    if gauges is _INV_CLIFFORDS or gauges == _INV_CLIFFORDS:
+        return '"inv_clifford"'
+    return repr(gauges)
+
+
+def _get_structure(
+    active: list[tuple[int, bool]],
+    min_length: int,
+    n: int,
+    gauge_beginning: bool,
+    gauge_ending: bool,
+) -> Iterator[tuple[int, int]]:
+    if gauge_beginning:
+        stop, is_mergable = active[0]
+        if min_length <= stop:
+            if is_mergable:
+                yield (0, stop)
+            else:
+                yield (0, stop - 1)
+
+    for i in range(len(active) - 1):
+        left_pos, left_is_mergable = active[i]
+        right_pos, right_is_mergable = active[i + 1]
+        if right_pos - left_pos - 1 >= min_length:
+            yield (left_pos + 1 - left_is_mergable, right_pos - 1 + right_is_mergable)
+
+    if gauge_ending:
+        stop, is_mergable = active[-1]
+        if min_length <= n - stop - 1:
+            if is_mergable:
+                yield (stop, n - 1)
+            else:
+                yield (stop + 1, n - 1)
+
+
+def _merge(g1: cirq.Gate, g2: cirq.Gate, q: cirq.Qid, tags: Sequence[Hashable]) -> cirq.Operation:
+    u1 = protocols.unitary(g1)
+    u2 = protocols.unitary(g2)
+    return ops.PhasedXZGate.from_matrix(u2 @ u1)(q).with_tags(*tags)
+
+
+@transformer_api.transformer
+@attrs.frozen
+class IdleMomentsGauge:
+    r"""A transformer that inserts identity-preserving "gauge" gates around idle qubit moments.
+
+    This transformer identifies sequences of consecutive idle moments on a single qubit
+    that meet a `min_length` threshold. For each such sequence, it inserts a randomly
+    selected gate `G` from `gauges` at the start of the idle period and its inverse `G^-1`
+    at the end. This ensures the logical circuit behavior remains unchanged ($G \cdot G^{-1} = I$).
+
+    The primary goal is to introduce specific structure into idle periods, which is
+    useful for experiments.
+
+    Attributes:
+        min_length: Minimum number of consecutive idle moments for a gauge to be applied (>= 1).
+
+        gauges: A sequence of `cirq.Gate` objects to randomly select from.
+            Can be a custom tuple or a string alias:
+            - `"pauli"`: Uses single-qubit Pauli gates (I, X, Y, Z).
+            - `"clifford"`: Uses all 24 single-qubit Clifford gates.
+
+        gauge_beginning: If `True`, applies a gauge to idle moments at the circuit's start,
+            before any other qubit operation. Defaults to `False`.
+
+        gauge_ending: If `True`, applies a gauge to idle moments at the circuit's end,
+            after the last qubit operation. Defaults to `False`.
+    """
+
+    min_length: int = attrs.field(
+        validator=(attrs.validators.instance_of(int), attrs.validators.ge(1))
+    )
+    gauges: tuple[cirq.Gate, ...] = attrs.field(
+        default='clifford', converter=_gauges_arg_converter, repr=_repr_fn
+    )
+    gauge_beginning: bool = False
+    gauge_ending: bool = False
+
+    @functools.cached_property
+    def gauges_inverse(self) -> tuple[cirq.Gate, ...]:
+        if self.gauges is _PAULIS:
+            return _PAULIS
+        if self.gauges is _CLIFFORDS:
+            return _INV_CLIFFORDS
+        if self.gauges is _INV_CLIFFORDS:
+            return _CLIFFORDS
+        return tuple(g**-1 for g in self.gauges)
+
+    def __call__(
+        self,
+        circuit: cirq.AbstractCircuit,
+        *,
+        context: transformer_api.TransformerContext | None = None,
+        rng_or_seed: np.random.Generator | int | None = None,
+    ):
+        """Apply the IdleMomentGauge transformer.
+
+        Args:
+            circuit: The circuit to process.
+            context: The TransformerContext.
+            rng_or_seed: The source of randomness.
+
+        Returns:
+            A transformed circuit.
+
+        Raises:
+            ValueError: if the TransformerContext has deep=True.
+        """
+        rng = (
+            rng_or_seed
+            if isinstance(rng_or_seed, np.random.Generator)
+            else np.random.default_rng(rng_or_seed)
+        )
+        context = (
+            context
+            if isinstance(context, transformer_api.TransformerContext)
+            else transformer_api.TransformerContext(deep=False)
+        )
+        if context.deep:
+            raise ValueError("IdleMomentsGauge doesn't support deep TransformerContext")
+
+        tags_to_ignore = frozenset(context.tags_to_ignore)
+        all_qubits = circuit.all_qubits()
+
+        active_moments: dict[cirq.Qid, list[tuple[int, bool]]] = {q: [] for q in all_qubits}
+        for m_id, moment in enumerate(circuit):
+            if not tags_to_ignore.isdisjoint(moment.tags):
+                for q in all_qubits:
+                    active_moments[q].append((m_id, False))
+            else:
+                for op in moment:
+                    is_mergable = (
+                        len(op.qubits) == 1
+                        and tags_to_ignore.isdisjoint(op.tags)
+                        and op.gate is not None
+                    )
+                    for q in op.qubits:
+                        active_moments[q].append((m_id, is_mergable))
+
+        single_qubit_moments = [{q: op for op in m if len(op.qubits) == 1} for m in circuit]
+        non_single_qubit_moments = [[op for op in m if len(op.qubits) != 1] for m in circuit]
+
+        for q, active in active_moments.items():
+            for s, e in _get_structure(
+                active, self.min_length, len(circuit), self.gauge_beginning, self.gauge_ending
+            ):
+                gate_index = rng.choice(len(self.gauges))
+                gate = self.gauges[gate_index]
+                gate_inv = self.gauges_inverse[gate_index]
+
+                if existing_op := single_qubit_moments[s].get(q, None):
+                    existing_gate = existing_op.gate
+                    assert existing_gate is not None
+                    single_qubit_moments[s][q] = _merge(existing_gate, gate, q, existing_op.tags)
+                else:
+                    single_qubit_moments[s][q] = gate(q)
+
+                if existing_op := single_qubit_moments[e].get(q, None):
+                    existing_gate = existing_op.gate
+                    assert existing_gate is not None
+                    single_qubit_moments[e][q] = _merge(
+                        gate_inv, existing_gate, q, existing_op.tags
+                    )
+                else:
+                    single_qubit_moments[e][q] = gate_inv(q)
+
+        return circuits.Circuit.from_moments(
+            *(
+                [op for op in sq.values()] + nsq
+                for sq, nsq in zip(single_qubit_moments, non_single_qubit_moments, strict=True)
+            )
+        )

cirq/transformers/gauge_compiling/idle_moments_gauge_test.py

@@ -0,0 +1,193 @@
+# Copyright 2025 The Cirq Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import numpy as np
+import pytest
+
+import cirq
+from cirq.transformers import gauge_compiling
+
+
+class _MockRng(np.random.Generator):
+
+    def __init__(self, vals):
+        self._n_calls = 0
+        self._res = tuple(vals)
+
+    def choice(self, seq):
+        ret = self._res[self._n_calls]
+        self._n_calls += 1
+        return ret
+
+
+def test_add_gauge_merges_gates():
+    tr = gauge_compiling.IdleMomentsGauge(2, gauges='pauli')
+
+    circuit = cirq.Circuit.from_moments([], [], [], cirq.X(cirq.q(0)), [], [], cirq.X(cirq.q(0)))
+    transformed_circuit = tr(circuit, rng_or_seed=_MockRng([3]))
+
+    assert transformed_circuit == cirq.Circuit.from_moments(
+        [],
+        [],
+        [],
+        cirq.PhasedXZGate(axis_phase_exponent=0.5, x_exponent=1, z_exponent=0)(cirq.q(0)),
+        [],
+        [],
+        cirq.PhasedXZGate(axis_phase_exponent=0.5, x_exponent=1, z_exponent=0)(cirq.q(0)),
+    )
+
+
+def test_add_gauge_respects_ignore_tag():
+    tr = gauge_compiling.IdleMomentsGauge(2, gauges='pauli')
+
+    circuit = cirq.Circuit.from_moments(
+        cirq.X(cirq.q(0)), [], [], cirq.X(cirq.q(0)).with_tags('ignore')
+    )
+    transformed_circuit = tr(
+        circuit,
+        context=cirq.TransformerContext(tags_to_ignore=("ignore",)),
+        rng_or_seed=_MockRng([3]),
+    )
+    assert transformed_circuit == cirq.Circuit.from_moments(
+        cirq.PhasedXZGate(axis_phase_exponent=0.5, x_exponent=1, z_exponent=0)(cirq.q(0)),
+        [],
+        cirq.Z(cirq.q(0)),
+        cirq.X(cirq.q(0)).with_tags('ignore'),
+    )
+
+
+def test_add_gauge_respects_ignore_moment():
+    tr = gauge_compiling.IdleMomentsGauge(2, gauges='pauli')
+
+    circuit = cirq.Circuit.from_moments(
+        cirq.X(cirq.q(0)), [], [], cirq.Moment(cirq.X(cirq.q(0))).with_tags('ignore')
+    )
+    transformed_circuit = tr(
+        circuit,
+        context=cirq.TransformerContext(tags_to_ignore=("ignore",)),
+        rng_or_seed=_MockRng([3]),
+    )
+    assert transformed_circuit == cirq.Circuit.from_moments(
+        cirq.PhasedXZGate(axis_phase_exponent=0.5, x_exponent=1, z_exponent=0)(cirq.q(0)),
+        [],
+        cirq.Z(cirq.q(0)),
+        cirq.Moment(cirq.X(cirq.q(0))).with_tags('ignore'),
+    )
+
+
+def test_add_gauge_on_prefix():
+    tr = gauge_compiling.IdleMomentsGauge(3, gauges='clifford', gauge_beginning=True)
+
+    circuit = cirq.Circuit.from_moments([], [], [], cirq.CNOT(cirq.q(0), cirq.q(1)))
+    transformed_circuit = tr(circuit, rng_or_seed=_MockRng([20, 15]))
+    assert transformed_circuit == cirq.Circuit.from_moments(
+        [
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[20](cirq.q(0)),
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[15](cirq.q(1)),
+        ],
+        [],
+        [
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[20](cirq.q(0)) ** -1,
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[15](cirq.q(1)) ** -1,
+        ],
+        cirq.CNOT(cirq.q(0), cirq.q(1)),
+    )
+
+
+def test_add_gauge_on_prefix_with_merge():
+    tr = gauge_compiling.IdleMomentsGauge(3, gauges=[cirq.Y], gauge_beginning=True)
+
+    circuit = cirq.Circuit.from_moments([], [], [], cirq.X(cirq.q(0)))
+    transformed_circuit = tr(circuit, rng_or_seed=_MockRng([0]))
+    assert transformed_circuit == cirq.Circuit.from_moments(
+        [cirq.Y(cirq.q(0))],
+        [],
+        [],
+        cirq.PhasedXZGate(axis_phase_exponent=0, x_exponent=0, z_exponent=1)(cirq.q(0)),
+    )
+
+
+def test_add_gauge_on_suffix():
+    tr = gauge_compiling.IdleMomentsGauge(3, gauges='inv_clifford', gauge_ending=True)
+
+    circuit = cirq.Circuit.from_moments(cirq.CNOT(cirq.q(0), cirq.q(1)), [], [], [])
+    transformed_circuit = tr(circuit, rng_or_seed=_MockRng([20, 15]))
+    assert transformed_circuit == cirq.Circuit.from_moments(
+        cirq.CNOT(cirq.q(0), cirq.q(1)),
+        [
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[20](cirq.q(0)) ** -1,
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[15](cirq.q(1)) ** -1,
+        ],
+        [],
+        [
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[20](cirq.q(0)),
+            cirq.SingleQubitCliffordGate.all_single_qubit_cliffords[15](cirq.q(1)),
+        ],
+    )
+
+
+def test_add_gauge_on_suffix_with_merge():
+    tr = gauge_compiling.IdleMomentsGauge(3, gauges=[cirq.Y], gauge_ending=True)
+
+    circuit = cirq.Circuit.from_moments(cirq.X(cirq.q(0)), [], [], [])
+    transformed_circuit = tr(circuit, rng_or_seed=_MockRng([0]))
+    assert transformed_circuit == cirq.Circuit.from_moments(
+        cirq.PhasedXZGate(axis_phase_exponent=0, x_exponent=0, z_exponent=1)(cirq.q(0)),
+        [],
+        [],
+        cirq.Y(cirq.q(0)),
+    )
+
+
+def test_add_gauge_respects_min_length():
+    tr = gauge_compiling.IdleMomentsGauge(2, gauges=[cirq.X])
+
+    circuit = cirq.Circuit.from_moments(cirq.X(cirq.q(0)), [], cirq.X(cirq.q(0)))
+    transformed_circuit = tr(circuit)
+    assert transformed_circuit == circuit
+
+
+def test_context_with_deep_raises():
+    tr = gauge_compiling.IdleMomentsGauge(2, gauges=[cirq.X])
+
+    circuit = cirq.Circuit.from_moments(cirq.X(cirq.q(0)), [], cirq.X(cirq.q(0)))
+    with pytest.raises(
+        ValueError, match="IdleMomentsGauge doesn't support deep TransformerContext"
+    ):
+        _ = tr(circuit, context=cirq.TransformerContext(deep=True))
+
+
+def test_gauge_with_invalid_name_raises():
+    with pytest.raises(ValueError, match='valid gauge'):
+        _ = gauge_compiling.IdleMomentsGauge(2, gauges='invalid')
+
+
+def test_repr():
+    assert repr(gauge_compiling.IdleMomentsGauge(3, gauges='pauli')) == (
+        'IdleMomentsGauge(min_length=3, gauges="pauli", '
+        'gauge_beginning=False, gauge_ending=False)'
+    )
+    assert repr(gauge_compiling.IdleMomentsGauge(4, gauges='clifford')) == (
+        'IdleMomentsGauge(min_length=4, gauges="clifford", '
+        'gauge_beginning=False, gauge_ending=False)'
+    )
+    assert repr(gauge_compiling.IdleMomentsGauge(5, gauges='inv_clifford')) == (
+        'IdleMomentsGauge(min_length=5, gauges="inv_clifford", '
+        'gauge_beginning=False, gauge_ending=False)'
+    )
+    assert repr(gauge_compiling.IdleMomentsGauge(6, gauges=[cirq.X])) == (
+        'IdleMomentsGauge(min_length=6, gauges=(cirq.X,), '
+        'gauge_beginning=False, gauge_ending=False)'
+    )

{cirq_core-1.7.0.dev20250915211227.dist-info → cirq_core-1.7.0.dev20250917023732.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cirq-core
-Version: 1.7.0.dev20250915211227
+Version: 1.7.0.dev20250917023732
 Summary: A framework for creating, editing, and invoking Noisy Intermediate Scale Quantum (NISQ) circuits.
 Home-page: http://github.com/quantumlib/cirq
 Author: The Cirq Developers