UnitaryGate

class qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True, *, num_qubits=None)

Bases: Gate

Class quantum gates specified by a unitary matrix.

Example

We can create a unitary gate from a unitary matrix then add it to a quantum circuit. The matrix can also be directly applied to the quantum circuit, see QuantumCircuit.unitary().

from qiskit import QuantumCircuit
from qiskit.circuit.library import UnitaryGate
 
matrix = [[0, 0, 0, 1],
          [0, 0, 1, 0],
          [1, 0, 0, 0],
          [0, 1, 0, 0]]
gate = UnitaryGate(matrix)
 
circuit = QuantumCircuit(2)
circuit.append(gate, [0, 1])

Create a gate from a numeric unitary matrix.

Parameters

data (numpy.ndarray |Gate | BaseOperator) – Unitary operator.
label (str | None) – Unitary name for backend [Default: None].
check_input (bool) – If set to False this asserts the input is known to be unitary and the checking to validate this will be skipped. This should only ever be used if you know the input is unitary, setting this to False and passing in a non-unitary matrix will result unexpected behavior and errors.
num_qubits (int | None) – If given, the number of qubits in the matrix. If not given, it is inferred.

Raises

ValueError – If input data is not an N-qubit unitary operator.

Attributes

base_class

Get the base class of this instruction. This is guaranteed to be in the inheritance tree of self.

The “base class” of an instruction is the lowest class in its inheritance tree that the object should be considered entirely compatible with for _all_ circuit applications. This typically means that the subclass is defined purely to offer some sort of programmer convenience over the base class, and the base class is the “true” class for a behavioral perspective. In particular, you should not override base_class if you are defining a custom version of an instruction that will be implemented differently by hardware, such as an alternative measurement strategy, or a version of a parametrized gate with a particular set of parameters for the purposes of distinguishing it in a Target from the full parametrized gate.

This is often exactly equivalent to type(obj), except in the case of singleton instances of standard-library instructions. These singleton instances are special subclasses of their base class, and this property will return that base. For example:

>>> isinstance(XGate(), XGate)
True
>>> type(XGate()) is XGate
False
>>> XGate().base_class is XGate
True

In general, you should not rely on the precise class of an instruction; within a given circuit, it is expected that Instruction.name should be a more suitable discriminator in most situations.

condition

The classical condition on the instruction.

Deprecated since version 1.3.0

The property qiskit.circuit.instruction.Instruction.condition is deprecated as of qiskit 1.3.0. It will be removed in 2.0.0.

condition_bits

Get Clbits in condition.

Deprecated since version 1.3.0

The property qiskit.circuit.instruction.Instruction.condition_bits is deprecated as of qiskit 1.3.0. It will be removed in 2.0.0.

decompositions

Get the decompositions of the instruction from the SessionEquivalenceLibrary.

definition

Return definition in terms of other basic gates.

duration

Get the duration.

Deprecated since version 1.3.0

The property qiskit.circuit.instruction.Instruction.duration is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0.

label

Return instruction label

mutable

Is this instance is a mutable unique instance or not.

If this attribute is False the gate instance is a shared singleton and is not mutable.

name

Return the name.

num_clbits

Return the number of clbits.

num_qubits

Return the number of qubits.

params

The parameters of this Instruction. Ideally these will be gate angles.

unit

Get the time unit of duration.

Deprecated since version 1.3.0

The property qiskit.circuit.instruction.Instruction.unit is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0.

Methods

adjoint

adjoint()

GitHub

Return the adjoint of the unitary.

conjugate

conjugate()

GitHub

Return the conjugate of the unitary.

control

control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=None)

GitHub

Return controlled version of gate.

Parameters

num_ctrl_qubits (int) – Number of controls to add to gate (default is 1).
label (str | None) – Optional gate label.
ctrl_state (int |str | None) – The control state in decimal or as a bit string (e.g. "1011"). If None, use 2**num_ctrl_qubits - 1.
annotated (bool | None) – indicates whether the controlled gate should be implemented as an annotated gate. If None, this is handled as False.