Shortcuts

# qiskit.circuit.library.CUGate¶

class CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)[source]

Controlled-U gate (4-parameter two-qubit gate).

This is a controlled version of the U gate (generic single qubit rotation), including a possible global phase $$e^{i\gamma}$$ of the U gate.

Circuit symbol:

q_0: ──────■──────
┌─────┴──────┐
q_1: ┤ U(ϴ,φ,λ,γ) ├
└────────────┘


Matrix representation:

\begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}CU(\theta, \phi, \lambda)\ q_0, q_1 = I \otimes |0\rangle\langle 0| + e^{i\gamma} U(\theta,\phi,\lambda) \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & e^{i\gamma}\cos(\th) & 0 & -e^{i(\gamma + \lambda)}\sin(\th) \\ 0 & 0 & 1 & 0 \\ 0 & e^{i(\gamma+\phi)}\sin(\th) & 0 & e^{i(\gamma+\phi+\lambda)}\cos(\th) \end{pmatrix}\end{split}\end{aligned}\end{align}

Note

In Qiskit’s convention, higher qubit indices are more significant (little endian convention). In many textbooks, controlled gates are presented with the assumption of more significant qubits as control, which in our case would be q_1. Thus a textbook matrix for this gate will be:

     ┌────────────┐
q_0: ┤ U(ϴ,φ,λ,γ) ├
└─────┬──────┘
q_1: ──────■───────

$\begin{split}CU(\theta, \phi, \lambda)\ q_1, q_0 = |0\rangle\langle 0| \otimes I + e^{i\gamma}|1\rangle\langle 1| \otimes U3(\theta,\phi,\lambda) = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & e^{i\gamma} \cos(\th) & -e^{i(\gamma + \lambda)}\sin(\th) \\ 0 & 0 & e^{i(\gamma + \phi)}\sin(\th) & e^{i(\gamma + \phi+\lambda)}\cos(\th) \end{pmatrix}\end{split}$

Create new CU gate.

__init__(theta, phi, lam, gamma, label=None, ctrl_state=None)[source]

Create new CU gate.

Methods

 __init__(theta, phi, lam, gamma[, label, …]) Create new CU gate. add_decomposition(decomposition) Add a decomposition of the instruction to the SessionEquivalenceLibrary. 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. control([num_ctrl_qubits, label, ctrl_state]) Return controlled version of gate. copy([name]) Copy of the instruction. Return inverted CU gate. Return True .IFF. DEPRECATED: use instruction.reverse_ops(). power(exponent) Creates a unitary gate as gate^exponent. Return a default OpenQASM string for the instruction. Creates an instruction with gate repeated n amount of times. For a composite instruction, reverse the order of sub-instructions. Return a numpy.array for the CU gate. validate_parameter(parameter) Gate parameters should be int, float, or ParameterExpression

Attributes

 ctrl_state Return the control state of the gate as a decimal integer. decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. definition Return definition in terms of other basic gates. duration Get the duration. label Return gate label num_ctrl_qubits Get number of control qubits. params Get parameters from base_gate. unit Get the time unit of duration.
add_decomposition(decomposition)

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble()

Assemble a QasmQobjInstruction

Return type

Instruction

broadcast_arguments(qargs, cargs)

Validation and handling of the arguments and its relationship.

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

in: [[q,q], q],[]
outs: [q, q], []
[q, q], []


• If len(qargs) == 1:

[q, q] -> [q],[q]

• If len(qargs) == 2:

[[q, q], [r, r]] -> [q, r], [q, r]
[[q], [r, r]]       -> [q, r], [q, r]
[[q, q], [r]]       -> [q, r], [q, r]

• If len(qargs) >= 3:

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

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(classical, val)

Add classical condition on register classical and value val.

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

Return controlled version of gate. See ControlledGate for usage.

Parameters
• num_ctrl_qubits (Optional[int]) – number of controls to add to gate (default=1)

• label (Optional[str]) – optional gate label

• ctrl_state (Union[int, str, None]) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use 2**num_ctrl_qubits-1.

Returns

Controlled version of gate. This default algorithm uses num_ctrl_qubits-1 ancillae qubits so returns a gate of size num_qubits + 2*num_ctrl_qubits - 1.

Return type

qiskit.circuit.ControlledGate

Raises

QiskitError – unrecognized mode or invalid ctrl_state

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

property ctrl_state

Return the control state of the gate as a decimal integer.

Return type

int

property decompositions

Get the decompositions of the instruction from the SessionEquivalenceLibrary.

property definition

Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl_state, the returned definition is conjugated with X without changing the internal _definition.

Return type

List

property duration

Get the duration.

inverse()[source]

Return inverted CU gate.

$$CU(\theta,\phi,\lambda,\gamma)^{\dagger} = CU(-\theta,-\phi,-\lambda,-\gamma)$$)

is_parameterized()

Return True .IFF. instruction is parameterized else False

property label

Return gate label

Return type

str

mirror()

DEPRECATED: use instruction.reverse_ops().

Returns

a new instruction with sub-instructions

reversed.

Return type

qiskit.circuit.Instruction

property num_ctrl_qubits

Get number of control qubits.

Returns

The number of control qubits for the gate.

Return type

int

property params

Get parameters from base_gate.

Returns

List of gate parameters.

Return type

list

Raises

CircuitError – Controlled gate does not define a base gate

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()

Return a default OpenQASM string for the instruction.

Derived instructions may override this to print in a different format (e.g. measure q -> c;).

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()

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()[source]

Return a numpy.array for the CU gate.

property unit

Get the time unit of duration.

validate_parameter(parameter)

Gate parameters should be int, float, or ParameterExpression