cirq.ops.GateOperation

An application of a gate to a sequence of qubits.

Inherits From: Operation

cirq.ops.GateOperation(
    gate: "cirq.Gate",
    qubits: Sequence['cirq.Qid']
) -> None

gate The gate applied by the operation.
qubits The qubits targeted by the operation.
tags Returns a tuple of the operation's tags.
untagged Returns the underlying operation without any tags.

Methods

controlled_by

View source

controlled_by(
    control_values: Optional[Sequence[Union[int, Collection[int]]]] = None,
    *control_qubits
) -> "cirq.Operation"

Returns a controlled version of this operation. If no control_qubits are specified, returns self.

Args
control_qubits Qubits to control the operation by. Required.
control_values For which control qubit values to apply the operation. A sequence of the same length as control_qubits 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 operation is applied. If unspecified, control values default to 1.

transform_qubits

View source

transform_qubits(
    func: Callable[['cirq.Qid'], 'cirq.Qid']
) -> cirq.ops.raw_types.TSelf

Returns the same operation, but with different qubits.

Args
func The function to use to turn each current qubit into a desired new qubit.

Returns
The receiving operation but with qubits transformed by the given function.

validate_args

View source

validate_args(
    qubits: Sequence['cirq.Qid']
)

Raises an exception if the qubits don't match this operation's qid shape.

Call this method from a subclass's with_qubits method.

Args
qubits The new qids for the operation.

Raises
ValueError The operation had qids that don't match it's qid shape.

with_gate

View source

with_gate(
    new_gate: "cirq.Gate"
) -> "cirq.Operation"

with_probability

View source

with_probability(
    probability: "cirq.TParamVal"
) -> "cirq.Operation"

with_qubits

View source

with_qubits(
    *new_qubits
) -> cirq.ops.gate_operation.TSelf

Returns the same operation, but applied to different qubits.

Args
new_qubits The new qubits to apply the operation to. The order must exactly match the order of qubits returned from the operation's qubits property.

with_tags

View source

with_tags(
    *new_tags
) -> "cirq.TaggedOperation"

Creates a new TaggedOperation, with this op and the specified tags.

This method can be used to attach meta-data to specific operations without affecting their functionality. The intended usage is to attach classes intended for this purpose or strings to mark operations for specific usage that will be recognized by consumers. Specific examples include ignoring this operation in optimization passes, hardware-specific functionality, or circuit diagram customizability.

Tags can be a list of any type of object that is useful to identify this operation as long as the type is hashable. If you wish the resulting operation to be eventually serialized into JSON, you should also restrict the operation to be JSON serializable.

Args
new_tags The tags to wrap this operation in.

__eq__

View source

__eq__(
    other: _SupportsValueEquality
) -> bool

__mul__

View source

__mul__(
    other: Any
) -> Any

__ne__

View source

__ne__(
    other: _SupportsValueEquality
) -> bool

__pow__

View source

__pow__(
    exponent: Any
) -> "cirq.Operation"

Raise gate to a power, then reapply to the same qubits.

Only works if the gate implements cirq.ExtrapolatableEffect. For extrapolatable gate G this means the following two are equivalent:

(G ** 1.5)(qubit)  or  G(qubit) ** 1.5

Args
exponent The amount to scale the gate's effect by.

Returns
A new operation on the same qubits with the scaled gate.

__rmul__

View source

__rmul__(
    other: Any
) -> Any