cirq.Rx

A gate with matrix \(e^{-i X t/2}\) that rotates around the X axis of the Bloch sphere by \(t\).

Inherits From: XPowGate, EigenGate, Gate

cirq.Rx(
    *, rads: cirq.TParamVal
)

Used in the notebooks

Used in the tutorials

The unitary matrix of cirq.Rx(rads=t) is:

\[ e^{-i X t /2} = \begin{bmatrix} \cos(t/2) & -i \sin(t/2) \\ -i \sin(t/2) & \cos(t/2) \end{bmatrix} \]

This gate corresponds to the traditionally defined rotation matrices about the Pauli X axis.

rads Radians to rotate about the X axis of the Bloch sphere.

dimension

exponent

global_shift

phase_exponent

Methods

controlled

View source

controlled(
    num_controls: Optional[int] = None,
    control_values: Optional[Union[cv.AbstractControlValues, Sequence[Union[int, Collection[int]]]]
        ] = None,
    control_qid_shape: Optional[Tuple[int, ...]] = None
) -> cirq.Gate

Returns a controlled XPowGate, using a CXPowGate where possible.

The controlled method of the Gate class, of which this class is a child, returns a ControlledGate. This method overrides this behavior to return a CXPowGate or a ControlledGate of a CXPowGate, when this is possible.

The conditions for the override to occur are:

  • The global_shift of the XPowGate is 0.
  • The control_values and control_qid_shape are compatible with the CXPowGate:
    • The last value of control_qid_shape is a qubit.
    • The last value of control_values corresponds to the control being satisfied if that last qubit is 1 and not satisfied if the last qubit is 0.

If these conditions are met, then the returned object is a CXPowGate or, in the case that there is more than one controlled qudit, a ControlledGate with the Gate being a CXPowGate. In the latter case the ControlledGate is controlled by one less qudit than specified in control_values and control_qid_shape (since one of these, the last qubit, is used as the control for the CXPowGate).

If the above conditions are not met, a ControlledGate of this gate will be returned.

Args
num_controls Total number of control qubits.
control_values Which control computational basis state to apply the sub gate. A sequence of length num_controls where each entry is an integer (or set of integers) corresponding to the computational basis state (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.

Returns
A cirq.ControlledGate (or cirq.CXPowGate if possible) representing self controlled by the given control values and qubits.

in_su2

View source

in_su2() -> 'Rx'

Returns an equal-up-global-phase gate from the group SU2.

num_qubits

View source

num_qubits() -> int

The number of qubits this gate acts on.

on

View source

on(
    *qubits
) -> 'Operation'

Returns an application of this gate to the given qubits.

Args
*qubits The collection of qubits to potentially apply the gate to.

Returns: a cirq.Operation which is this gate applied to the given qubits.

on_each

View source

on_each(
    *targets
) -> List['cirq.Operation']

Returns a list of operations applying the gate to all targets.

Args
*targets The qubits to apply this gate to. For single-qubit gates this can be provided as varargs or a combination of nested iterables. For multi-qubit gates this must be provided as an Iterable[Sequence[Qid]], where each sequence has num_qubits qubits.

Returns
Operations applying this gate to the target qubits.

Raises
ValueError If targets are not instances of Qid or Iterable[Qid]. If the gate qubit number is incompatible.
TypeError If a single target is supplied and it is not iterable.

validate_args

View source

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.

Raises
ValueError The gate can't be applied to the qubits.

with_canonical_global_phase

View source

with_canonical_global_phase() -> 'XPowGate'

Returns an equal-up-global-phase standardized form of the gate.

with_probability

View source

with_probability(
    probability: 'cirq.TParamVal'
) -> 'cirq.Gate'

Creates a probabilistic channel with this gate.

Args
probability floating point value between 0 and 1, giving the probability this gate is applied.

Returns
cirq.RandomGateChannel that applies self with probability probability and the identity with probability 1-p.

wrap_in_linear_combination

View source

wrap_in_linear_combination(
    coefficient: Union[complex, float, int] = 1
) -> 'cirq.LinearCombinationOfGates'

Returns a LinearCombinationOfGates with this gate.

Args
coefficient number coefficient to use in the resulting cirq.LinearCombinationOfGates object.

Returns
cirq.LinearCombinationOfGates containing self with a coefficient of coefficient.

__add__

View source

__add__(
    other: Union['Gate', 'cirq.LinearCombinationOfGates']
) -> 'cirq.LinearCombinationOfGates'

__call__

View source

__call__(
    *qubits, **kwargs
)

Call self as a function.

__eq__

View source

__eq__(
    other: _SupportsValueEquality
) -> bool

__mul__

View source

__mul__(
    other: Union[complex, float, int]
) -> 'cirq.LinearCombinationOfGates'

__ne__

View source

__ne__(
    other: _SupportsValueEquality
) -> bool

__neg__

View source

__neg__() -> 'cirq.LinearCombinationOfGates'

__pow__

View source

__pow__(
    exponent: Union[float, sympy.Symbol]
) -> 'EigenGate'

__rmul__

View source

__rmul__(
    other: Union[complex, float, int]
) -> 'cirq.LinearCombinationOfGates'

__sub__

View source

__sub__(
    other: Union['Gate', 'cirq.LinearCombinationOfGates']
) -> 'cirq.LinearCombinationOfGates'

__truediv__

View source

__truediv__(
    other: Union[complex, float, int]
) -> 'cirq.LinearCombinationOfGates'