qiskit-documentation/docs/api/qiskit/0.36/qiskit.circuit.Delay.mdx

250 lines
6.2 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: Delay
description: API reference for qiskit.circuit.Delay
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.circuit.Delay
---
# Delay
<Class id="qiskit.circuit.Delay" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/circuit/delay.py" signature="Delay(duration, unit='dt')" modifiers="class">
Bases: `qiskit.circuit.instruction.Instruction`
Do nothing and just delay/wait/idle for a specified duration.
Create new delay instruction.
## Methods
### add\_decomposition
<Function id="qiskit.circuit.Delay.add_decomposition" signature="Delay.add_decomposition(decomposition)">
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
</Function>
### assemble
<Function id="qiskit.circuit.Delay.assemble" signature="Delay.assemble()">
Assemble a QasmQobjInstruction
</Function>
### broadcast\_arguments
<Function id="qiskit.circuit.Delay.broadcast_arguments" signature="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.
</Function>
### c\_if
<Function id="qiskit.circuit.Delay.c_if" signature="Delay.c_if(classical, val)">
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
<Admonition title="Note" type="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.
</Admonition>
</Function>
### copy
<Function id="qiskit.circuit.Delay.copy" signature="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](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
</Function>
### inverse
<Function id="qiskit.circuit.Delay.inverse" signature="Delay.inverse()">
Special case. Return self.
</Function>
### is\_parameterized
<Function id="qiskit.circuit.Delay.is_parameterized" signature="Delay.is_parameterized()">
Return True .IFF. instruction is parameterized else False
</Function>
### qasm
<Function id="qiskit.circuit.Delay.qasm" signature="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];).
</Function>
### repeat
<Function id="qiskit.circuit.Delay.repeat" signature="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](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
**Raises**
**CircuitError** If n \< 1.
</Function>
### reverse\_ops
<Function id="qiskit.circuit.Delay.reverse_ops" signature="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](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
</Function>
### soft\_compare
<Function id="qiskit.circuit.Delay.soft_compare" signature="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
</Function>
### to\_matrix
<Function id="qiskit.circuit.Delay.to_matrix" signature="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
</Function>
### validate\_parameter
<Function id="qiskit.circuit.Delay.validate_parameter" signature="Delay.validate_parameter(parameter)">
Delay parameter (i.e. duration) must be int, float or ParameterExpression.
</Function>
## Attributes
### condition\_bits
<Attribute id="qiskit.circuit.Delay.condition_bits">
Get Clbits in condition.
**Return type**
`List`\[`Clbit`]
</Attribute>
### decompositions
<Attribute id="qiskit.circuit.Delay.decompositions">
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
</Attribute>
### definition
<Attribute id="qiskit.circuit.Delay.definition">
Return definition in terms of other basic gates.
</Attribute>
### duration
<Attribute id="qiskit.circuit.Delay.duration">
Get the duration of this delay.
</Attribute>
### label
<Attribute id="qiskit.circuit.Delay.label">
Return instruction label
**Return type**
`str`
</Attribute>
### name
<Attribute id="qiskit.circuit.Delay.name">
Return the name.
</Attribute>
### num\_clbits
<Attribute id="qiskit.circuit.Delay.num_clbits">
Return the number of clbits.
</Attribute>
### num\_qubits
<Attribute id="qiskit.circuit.Delay.num_qubits">
Return the number of qubits.
</Attribute>
### params
<Attribute id="qiskit.circuit.Delay.params">
return instruction params.
</Attribute>
### unit
<Attribute id="qiskit.circuit.Delay.unit">
Get the time unit of duration.
</Attribute>
</Class>