cirq.ops.MatrixGate

See Stable See Nightly

View source on GitHub

A unitary qubit or qudit gate defined entirely by its matrix.

Inherits From: Gate

View aliases

Main aliases

cirq.MatrixGate, cirq.ops.matrix_gates.MatrixGate

cirq.ops.MatrixGate(
    matrix: np.ndarray,
    *,
    name: str = None,
    qid_shape: Optional[Iterable[int]] = None,
    unitary_check_rtol: float = 1e-05,
    unitary_check_atol: float = 1e-08
) -> None

Used in the notebooks

Used in the tutorials
Introduction

Args
matrix	The matrix that defines the gate.
name	The optional name of the gate to be displayed.
qid_shape	The shape of state tensor that the matrix applies to. If not specified, this value is inferred by assuming that the matrix is supposed to apply to qubits.
unitary_check_rtol	The relative tolerance for checking whether the supplied matrix is unitary. See cirq.is_unitary.
unitary_check_atol	The absolute tolerance for checking whether the supplied matrix is unitary. See cirq.is_unitary.

Raises
ValueError	If the matrix is not a square numpy array, if the matrix does not match the qid_shape, if qid_shape is not supplied and the matrix dimension is not a power of 2, or if the matrix not unitary (to the supplied precisions).

Methods

controlled

View source

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

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.

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.

Throws:

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

with_probability

View source

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

wrap_in_linear_combination

View source

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

__add__

View source

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

__call__

View source

__call__(
    *args, **kwargs
)

Call self as a function.

__eq__

View source

__eq__(
    other
)

Return self==value.

__mul__

View source

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

__ne__

View source

__ne__(
    other
)

Return self!=value.

__neg__

View source

__neg__() -> 'cirq.LinearCombinationOfGates'

__pow__

View source

__pow__(
    exponent: Any
) -> 'MatrixGate'

__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'