![]() |
Represents the Pauli gates.
Inherits From: Gate
cirq.ops.Pauli(
index: int,
name: str
) -> None
This is an abstract class with no public subclasses. The only instances of private subclasses are the X, Y, or Z Pauli gates defined below.
Methods
by_index
@staticmethod
by_index( index: int ) -> "Pauli"
by_relative_index
@staticmethod
by_relative_index( p: "Pauli", relative_index: int ) -> "Pauli"
controlled
controlled(
num_controls: int = None,
control_values: Optional[Sequence[Union[int, Collection[int]]]] = None,
control_qid_shape: Optional[Tuple[int, ...]] = None
) -> "Gate"
Returns a controlled version of this gate. If no arguments are specified, defaults to a single qubit control.
num_controls: Total number of control qubits.
control_values: For which control qubit values to apply the sub
gate. A sequence of length num_controls
where each
entry is an integer (or set of integers) corresponding to the
qubit value (or set of possible values) where that control is
enabled. When all controls are enabled, the sub gate is
applied. If unspecified, control values default to 1.
control_qid_shape: The qid shape of the controls. A tuple of the
expected dimension of each control qid. Defaults to
(2,) * num_controls
. Specify this argument when using qudits.
num_qubits
num_qubits()
The number of qubits this gate acts on.
on
on(
*qubits
) -> "SingleQubitPauliStringGateOperation"
Returns an application of this gate to the given qubits.
Args | |
---|---|
*qubits
|
The collection of qubits to potentially apply the gate to. |
phased_pauli_product
phased_pauli_product(
other: Union['cirq.Pauli', 'identity.IdentityGate']
) -> Tuple[complex, Union['cirq.Pauli', 'identity.IdentityGate']]
relative_index
relative_index(
second: "Pauli"
) -> int
Relative index of self w.r.t. second in the (X, Y, Z) cycle.
third
third(
second: "Pauli"
) -> "Pauli"
validate_args
validate_args(
qubits: Sequence['cirq.Qid']
) -> None
Checks if this gate can be applied to the given qubits.
By default checks that:
- inputs are of type
Qid
- len(qubits) == num_qubits()
- qubit_i.dimension == qid_shape[i] for all qubits
Child classes can override. The child implementation should call
super().validate_args(qubits)
then do custom checks.
Args | |
---|---|
qubits
|
The sequence of qubits to potentially apply the gate to. |
Throws:
ValueError
: The gate can't be applied to the qubits.
with_probability
with_probability(
probability: "cirq.TParamVal"
) -> "cirq.Gate"
wrap_in_linear_combination
wrap_in_linear_combination(
coefficient: Union[complex, float, int] = 1
) -> "cirq.LinearCombinationOfGates"
__add__
__add__(
other: Union['Gate', 'cirq.LinearCombinationOfGates']
) -> "cirq.LinearCombinationOfGates"
__call__
__call__(
*args, **kwargs
)
Call self as a function.
__gt__
__gt__(
other
)
Return self>value.
__lt__
__lt__(
other
)
Return self<value.
__mul__
__mul__(
other: Union[complex, float, int]
) -> "cirq.LinearCombinationOfGates"
__neg__
__neg__() -> "cirq.LinearCombinationOfGates"
__pow__
__pow__(
power
)
__rmul__
__rmul__(
other: Union[complex, float, int]
) -> "cirq.LinearCombinationOfGates"
__sub__
__sub__(
other: Union['Gate', 'cirq.LinearCombinationOfGates']
) -> "cirq.LinearCombinationOfGates"
__truediv__
__truediv__(
other: Union[complex, float, int]
) -> "cirq.LinearCombinationOfGates"