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.circuit.Delay

class Delay(duration, unit='dt')

GitHub

Do nothing and just delay/wait/idle for a specified duration.

Create new delay instruction.

__init__

__init__(duration, unit='dt')

Create new delay instruction.


Methods

__init__(duration[, unit])Create new delay instruction.
add_decomposition(decomposition)Add a decomposition of the instruction to the SessionEquivalenceLibrary.
assemble()Assemble a QasmQobjInstruction
broadcast_arguments(qargs, cargs)Validation of the arguments.
c_if(classical, val)Add classical condition on register or cbit classical and value val.
copy([name])Copy of the instruction.
inverse()Special case.
is_parameterized()Return True .IFF.
mirror()DEPRECATED: use instruction.reverse_ops().
qasm()Return a default OpenQASM string for the instruction.
repeat(n)Creates an instruction with gate repeated n amount of times.
reverse_ops()For a composite instruction, reverse the order of sub-instructions.
soft_compare(other)Soft comparison between gates.
to_matrix()Return a Numpy.array for the unitary matrix.
validate_parameter(parameter)Delay parameter (i.e.

Attributes

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

add_decomposition

add_decomposition(decomposition)

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble

assemble()

Assemble a QasmQobjInstruction

broadcast_arguments

broadcast_arguments(qargs, cargs)

Validation of the arguments.

Parameters

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

Yields

Tuple(List, List) – 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 or cbit classical and value val.

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 of this delay.

inverse

inverse()

Special case. Return self.

is_parameterized

is_parameterized()

Return True .IFF. instruction is parameterized else False

label

Return instruction 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.

qasm

qasm()

Return a default OpenQASM string for the instruction.

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

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

soft_compare

soft_compare(other)

Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.

Parameters

other (instruction) – other instruction.

Returns

are self and other equal up to parameter expressions.

Return type

bool

to_matrix

to_matrix()

Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type.

Returns

matrix representation.

Return type

np.ndarray

unit

Get the time unit of duration.

validate_parameter

validate_parameter(parameter)

Delay parameter (i.e. duration) must be int, float or ParameterExpression.

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