cirq.ops.MutablePauliString

Abstract base class for generic types.

cirq.ops.MutablePauliString(
    coefficient: Union[int, float, complex] = 1,
    *contents,
    pauli_int_dict: Optional[Dict[TKey, int]] = None
)

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def getitem(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

Methods

frozen

View source

frozen() -> "cirq.PauliString"

Returns a cirq.PauliString with the same contents.

For example, this is useful because cirq.PauliString is an operation whereas cirq.MutablePauliString is not.

get

View source

get(
    key: cirq.ops.pauli_string.TKey,
    default=None
)

inplace_after

View source

inplace_after(
    ops: "cirq.OP_TREE"
) -> "cirq.MutablePauliString"

Propagates the pauli string from before to after a Clifford effect.

If the old value of the MutablePauliString is $P$ and the Clifford operation is $C$, then the new value of the MutablePauliString is $C P C^\dagger$.

Args
ops A stabilizer operation or nested collection of stabilizer operations.

Returns
The mutable pauli string that was mutated.

inplace_before

View source

inplace_before(
    ops: "cirq.OP_TREE"
) -> "cirq.MutablePauliString"

Propagates the pauli string from after to before a Clifford effect.

If the old value of the MutablePauliString is $P$ and the Clifford operation is $C$, then the new value of the MutablePauliString is $C^\dagger P C$.

Args
ops A stabilizer operation or nested collection of stabilizer operations.

Returns
The mutable pauli string that was mutated.

inplace_left_multiply_by

View source

inplace_left_multiply_by(
    other: "cirq.PAULI_STRING_LIKE"
) -> "cirq.MutablePauliString"

Left-multiplies a pauli string into this pauli string.

Args
other A pauli string or cirq.PAULI_STRING_LIKE to left-multiply into self.

Returns
The self mutable pauli string that was mutated.

Raises
TypeError other was not a cirq.PAULI_STRING_LIKE. self was not mutated.

inplace_right_multiply_by

View source

inplace_right_multiply_by(
    other: "cirq.PAULI_STRING_LIKE"
) -> "cirq.MutablePauliString"

Right-multiplies a pauli string into this pauli string.

Args
other A pauli string or cirq.PAULI_STRING_LIKE to right-multiply into self.

Returns
The self mutable pauli string that was mutated.

Raises
TypeError other was not a cirq.PAULI_STRING_LIKE. self was not mutated.

items

View source

items() -> Iterator[Tuple[TKey, Union['cirq.Pauli', 'cirq.IdentityGate']]]

keys

View source

keys() -> AbstractSet[cirq.ops.pauli_string.TKey]

mutable_copy

View source

mutable_copy() -> "cirq.MutablePauliString"

Returns a new cirq.MutablePauliString with the same contents.

transform_qubits

View source

transform_qubits(
    func: Callable[[cirq.ops.pauli_string.TKey], cirq.ops.pauli_string.TKeyNew],
    *,
    inplace: bool = False
) -> "cirq.MutablePauliString[TKeyNew]"

Returns a mutable pauli string with transformed qubits.

Args
func The qubit transformation to apply.
inplace If false (the default), creates a new mutable pauli string to store the result. If true, overwrites this mutable pauli string's contents. Defaults to false for consistency with cirq.PauliString.transform_qubits in situations where the pauli string being used may or may not be mutable.

Returns
A transformed MutablePauliString. If inplace=True, returns self. If inplace=False, returns a new instance.

values

View source

values() -> Iterator[Union['cirq.Pauli', 'cirq.IdentityGate']]

__bool__

View source

__bool__() -> bool

__contains__

View source

__contains__(
    item: Any
) -> bool

__eq__

View source

__eq__(
    other: _SupportsValueEquality
) -> bool

__getitem__

View source

__getitem__(
    item: Any
) -> Union['cirq.Pauli', 'cirq.IdentityGate']

__iter__

View source

__iter__() -> Iterator[cirq.ops.pauli_string.TKey]

__len__

View source

__len__() -> int

__mul__

View source

__mul__(
    other: "cirq.PAULI_STRING_LIKE"
) -> "cirq.PauliString"

Multiplies two pauli-string-likes together.

The result is not mutable.

__ne__

View source

__ne__(
    other: _SupportsValueEquality
) -> bool

__neg__

View source

__neg__() -> "cirq.MutablePauliString"

__pos__

View source

__pos__() -> "cirq.MutablePauliString"

__rmul__

View source

__rmul__(
    other: "cirq.PAULI_STRING_LIKE"
) -> "cirq.PauliString"

Multiplies two pauli-string-likes together.

The result is not mutable.