Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

Delay

Delay(duration, unit='dt') GitHub(opens in a new tab)

Bases: qiskit.circuit.instruction.Instruction

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

Create new delay instruction.


Methods

add_decomposition

Delay.add_decomposition(decomposition)

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble

Delay.assemble()

Assemble a QasmQobjInstruction

broadcast_arguments

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

Delay.c_if(classical, val)

Set a classical equality condition on this instruction between the register or cbit classical and value val.

Note

This is a setter method, not an additive one. Calling this multiple times will silently override any previously set condition; it does not stack.

copy

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

inverse

Delay.inverse()

Special case. Return self.

is_parameterized

Delay.is_parameterized()

Return True .IFF. instruction is parameterized else False

mirror

Delay.mirror()

DEPRECATED: use instruction.reverse_ops().

Returns

a new instruction with sub-instructions

reversed.

Return type

qiskit.circuit.Instruction

qasm

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

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

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

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

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

validate_parameter

Delay.validate_parameter(parameter)

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


Attributes

condition_bits

Get Clbits in condition.

Return type

List[Clbit]

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.

label

Return instruction label

Return type

str

params

return instruction params.

unit

Get the time unit of duration.

Was this page helpful?