cirq.ops.Gate

An operation type that can be applied to a collection of qubits.

Used in the notebooks

Used in the tutorials

Gates can be applied to qubits by calling their on() method with the qubits to be applied to supplied, or, alternatively, by simply calling the gate on the qubits. In other words calling MyGate.on(q1, q2) to create an Operation on q1 and q2 is equivalent to MyGate(q1,q2).

Gates operate on a certain number of qubits. All implementations of gate must implement the num_qubits method declaring how many qubits they act on. The gate feature classes SingleQubitGate and TwoQubitGate can be used to avoid writing this boilerplate.

Linear combinations of gates can be created by adding gates together and multiplying them by scalars.

Methods

controlled

View source

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

View source

The number of qubits this gate acts on.

on

View source

Returns an application of this gate to the given qubits.

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

validate_args

View source

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

View source

wrap_in_linear_combination

View source

__add__

View source

__call__

View source

Call self as a function.

__mul__

View source

__neg__

View source

__pow__

View source

__rmul__

View source

__sub__

View source

__truediv__

View source