Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

qiskit.extensions.UnitaryGate

class UnitaryGate(data, label=None)

GitHub

Class for representing unitary gates

Create a gate from a numeric unitary matrix.

Parameters

  • data (matrix or Operator) – unitary operator.
  • label (str) – unitary name for backend [Default: None].

Raises

ExtensionError – if input data is not an N-qubit unitary operator.

__init__

__init__(data, label=None)

Create a gate from a numeric unitary matrix.

Parameters

  • data (matrix or Operator) – unitary operator.
  • label (str) – unitary name for backend [Default: None].

Raises

ExtensionError – if input data is not an N-qubit unitary operator.


Methods

__init__(data[, label])Create a gate from a numeric unitary matrix.
add_decomposition(decomposition)Add a decomposition of the instruction to the SessionEquivalenceLibrary.
adjoint()Return the adjoint of the unitary.
assemble()Assemble a QasmQobjInstruction
broadcast_arguments(qargs, cargs)Validation and handling of the arguments and its relationship.
c_if(classical, val)Add classical condition on register classical and value val.
conjugate()Return the conjugate of the unitary.
control([num_ctrl_qubits, label, ctrl_state])Return controlled version of gate
copy([name])Copy of the instruction.
inverse()Return the adjoint of the unitary.
is_parameterized()Return True .IFF.
mirror()DEPRECATED: use instruction.reverse_ops().
power(exponent)Creates a unitary gate as gate^exponent.
qasm()The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate.
repeat(n)Creates an instruction with gate repeated n amount of times.
reverse_ops()For a composite instruction, reverse the order of sub-instructions.
to_matrix()Return matrix for the unitary.
transpose()Return the transpose of the unitary.
validate_parameter(parameter)Unitary gate parameter has to be an ndarray.

Attributes

decompositionsGet the decompositions of the instruction from the SessionEquivalenceLibrary.
definitionReturn definition in terms of other basic gates.
durationGet the duration.
labelReturn gate label
paramsreturn instruction params.
unitGet the time unit of duration.

add_decomposition

add_decomposition(decomposition)

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

adjoint

adjoint()

Return the adjoint of the unitary.

assemble

assemble()

Assemble a QasmQobjInstruction

Return type

Instruction

broadcast_arguments

broadcast_arguments(qargs, cargs)

Validation and handling of the arguments and its relationship.

For example, cx([q[0],q[1]], q[2]) means cx(q[0], q[2]); cx(q[1], q[2]). This method yields the arguments in the right grouping. In the given example:

in: [[q[0],q[1]], q[2]],[]
outs: [q[0], q[2]], []
      [q[1], q[2]], []

The general broadcasting rules are:

  • If len(qargs) == 1:

    [q[0], q[1]] -> [q[0]],[q[1]]
  • If len(qargs) == 2:

    [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]]
    [[q[0]], [r[0], r[1]]]       -> [q[0], r[0]], [q[0], r[1]]
    [[q[0], q[1]], [r[0]]]       -> [q[0], r[0]], [q[1], r[0]]
  • If len(qargs) >= 3:

    [q[0], q[1]], [r[0], r[1]],  ...] -> [q[0], r[0], ...], [q[1], r[1], ...]

Parameters

  • qargs (List) – List of quantum bit arguments.
  • cargs (List) – List of classical bit arguments.

Return type

Tuple[List, List]

Returns

A tuple with single arguments.

Raises

CircuitError – If the input is not valid. For example, the number of arguments does not match the gate expectation.

c_if

c_if(classical, val)

Add classical condition on register classical and value val.

conjugate

conjugate()

Return the conjugate of the unitary.

control

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

Return controlled version of gate

Parameters

  • num_ctrl_qubits (int) – number of controls to add to gate (default=1)
  • label (str) – optional gate label
  • ctrl_state (int or str or None) – The control state in decimal or as a bit string (e.g. ‘1011’). If None, use 2**num_ctrl_qubits-1.

Returns

controlled version of gate.

Return type

UnitaryGate

Raises

  • QiskitError – Invalid ctrl_state.
  • ExtensionError – Non-unitary controlled unitary.

copy

copy(name=None)

Copy of the instruction.

Parameters

name (str) – name to be given to the copied circuit, if None then the name stays the same.

Returns

a copy of the current instruction, with the name

updated if it was provided

Return type

qiskit.circuit.Instruction

decompositions

Get the decompositions of the instruction from the SessionEquivalenceLibrary.

definition

Return definition in terms of other basic gates.

duration

Get the duration.

inverse

inverse()

Return the adjoint of the unitary.

is_parameterized

is_parameterized()

Return True .IFF. instruction is parameterized else False

label

Return gate label

Return type

str

mirror

mirror()

DEPRECATED: use instruction.reverse_ops().

Returns

a new instruction with sub-instructions

reversed.

Return type

qiskit.circuit.Instruction

params

return instruction params.

power

power(exponent)

Creates a unitary gate as gate^exponent.

Parameters

exponent (float) – Gate^exponent

Returns

To which to_matrix is self.to_matrix^exponent.

Return type

qiskit.extensions.UnitaryGate

Raises

CircuitError – If Gate is not unitary

qasm

qasm()

The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it.

repeat

repeat(n)

Creates an instruction with gate repeated n amount of times.

Parameters

n (int) – Number of times to repeat the instruction

Returns

Containing the definition.

Return type

qiskit.circuit.Instruction

Raises

CircuitError – If n < 1.

reverse_ops

reverse_ops()

For a composite instruction, reverse the order of sub-instructions.

This is done by recursively reversing all sub-instructions. It does not invert any gate.

Returns

a new instruction with

sub-instructions reversed.

Return type

qiskit.circuit.Instruction

to_matrix

to_matrix()

Return matrix for the unitary.

transpose

transpose()

Return the transpose of the unitary.

unit

Get the time unit of duration.

validate_parameter

validate_parameter(parameter)

Unitary gate parameter has to be an ndarray.

Was this page helpful?
Report a bug or request content on GitHub.