393 lines
12 KiB
Plaintext
393 lines
12 KiB
Plaintext
---
|
||
title: DAGDependency
|
||
description: API reference for qiskit.dagcircuit.DAGDependency
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.dagcircuit.DAGDependency
|
||
---
|
||
|
||
# DAGDependency
|
||
|
||
<Class id="qiskit.dagcircuit.DAGDependency" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/dagcircuit/dagdependency.py" signature="DAGDependency" modifiers="class">
|
||
Bases: `object`
|
||
|
||
Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. lack of commutation).
|
||
|
||
The nodes in the graph are operations represented by quantum gates. The edges correspond to non-commutation between two operations (i.e. a dependency). A directed edge from node A to node B means that operation A does not commute with operation B. The object’s methods allow circuits to be constructed.
|
||
|
||
The nodes in the graph have the following attributes: ‘operation’, ‘successors’, ‘predecessors’.
|
||
|
||
**Example:**
|
||
|
||
Bell circuit with no measurement.
|
||
|
||
```python
|
||
┌───┐
|
||
qr_0: ┤ H ├──■──
|
||
└───┘┌─┴─┐
|
||
qr_1: ─────┤ X ├
|
||
└───┘
|
||
```
|
||
|
||
The dependency DAG for the above circuit is represented by two nodes. The first one corresponds to Hadamard gate, the second one to the CNOT gate as the gates do not commute there is an edge between the two nodes.
|
||
|
||
**Reference:**
|
||
|
||
\[1] Iten, R., Moyard, R., Metger, T., Sutter, D. and Woerner, S., 2020. Exact and practical pattern matching for quantum circuit optimization. [arXiv:1909.05270](https://arxiv.org/abs/1909.05270)
|
||
|
||
Create an empty DAGDependency.
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-add-clbits" />
|
||
|
||
### add\_clbits
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.add_clbits" signature="DAGDependency.add_clbits(clbits)">
|
||
Add individual clbit wires.
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-add-creg" />
|
||
|
||
### add\_creg
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.add_creg" signature="DAGDependency.add_creg(creg)">
|
||
Add clbits in a classical register.
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-add-op-node" />
|
||
|
||
### add\_op\_node
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.add_op_node" signature="DAGDependency.add_op_node(operation, qargs, cargs)">
|
||
Add a DAGDepNode to the graph and update the edges.
|
||
|
||
**Parameters**
|
||
|
||
* **operation** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – operation as a quantum gate
|
||
* **qargs** (*list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of qubits on which the operation acts
|
||
* **cargs** (*list\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – list of classical wires to attach to
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-add-qreg" />
|
||
|
||
### add\_qreg
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.add_qreg" signature="DAGDependency.add_qreg(qreg)">
|
||
Add qubits in a quantum register.
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-add-qubits" />
|
||
|
||
### add\_qubits
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.add_qubits" signature="DAGDependency.add_qubits(qubits)">
|
||
Add individual qubit wires.
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-copy" />
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.copy" signature="DAGDependency.copy()">
|
||
Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-depth" />
|
||
|
||
### depth
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.depth" signature="DAGDependency.depth()">
|
||
Return the circuit depth. :returns: the circuit depth :rtype: int
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-direct-predecessors" />
|
||
|
||
### direct\_predecessors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.direct_predecessors" signature="DAGDependency.direct_predecessors(node_id)">
|
||
Direct predecessors id of a given node as sorted list.
|
||
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – label of considered node.
|
||
|
||
**Returns**
|
||
|
||
direct predecessors id as a sorted list
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-direct-successors" />
|
||
|
||
### direct\_successors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.direct_successors" signature="DAGDependency.direct_successors(node_id)">
|
||
Direct successors id of a given node as sorted list.
|
||
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – label of considered node.
|
||
|
||
**Returns**
|
||
|
||
direct successors id as a sorted list
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-draw" />
|
||
|
||
### draw
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.draw" signature="DAGDependency.draw(scale=0.7, filename=None, style='color')">
|
||
Draws the DAGDependency graph.
|
||
|
||
This function needs pydot \<[https://github.com/erocarrera/pydot](https://github.com/erocarrera/pydot)>, which in turn needs Graphviz \<[https://www.graphviz.org/](https://www.graphviz.org/)>\` to be installed.
|
||
|
||
**Parameters**
|
||
|
||
* **scale** (*float*) – scaling factor
|
||
* **filename** (*str*) – file path to save image to (format inferred from name)
|
||
* **style** (*str*) – ‘plain’: B\&W graph ‘color’ (default): color input/output/op nodes
|
||
|
||
**Returns**
|
||
|
||
**if in Jupyter notebook and not saving to file,**
|
||
|
||
otherwise None.
|
||
|
||
**Return type**
|
||
|
||
Ipython.display.Image
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-get-all-edges" />
|
||
|
||
### get\_all\_edges
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.get_all_edges" signature="DAGDependency.get_all_edges()">
|
||
Enumeration of all edges.
|
||
|
||
**Returns**
|
||
|
||
corresponding to the label.
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-get-edges" />
|
||
|
||
### get\_edges
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.get_edges" signature="DAGDependency.get_edges(src_id, dest_id)">
|
||
Edge enumeration between two nodes through method get\_all\_edge\_data.
|
||
|
||
**Parameters**
|
||
|
||
* **src\_id** (*int*) – label of the first node.
|
||
* **dest\_id** (*int*) – label of the second node.
|
||
|
||
**Returns**
|
||
|
||
corresponding to all edges between the two nodes.
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-get-in-edges" />
|
||
|
||
### get\_in\_edges
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.get_in_edges" signature="DAGDependency.get_in_edges(node_id)">
|
||
Enumeration of all incoming edges for a given node.
|
||
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – label of considered node.
|
||
|
||
**Returns**
|
||
|
||
corresponding incoming edges data.
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-get-node" />
|
||
|
||
### get\_node
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.get_node" signature="DAGDependency.get_node(node_id)">
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – label of considered node.
|
||
|
||
**Returns**
|
||
|
||
corresponding to the label.
|
||
|
||
**Return type**
|
||
|
||
node
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-get-nodes" />
|
||
|
||
### get\_nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.get_nodes" signature="DAGDependency.get_nodes()">
|
||
**Returns**
|
||
|
||
iterator over all the nodes.
|
||
|
||
**Return type**
|
||
|
||
generator(dict)
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-get-out-edges" />
|
||
|
||
### get\_out\_edges
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.get_out_edges" signature="DAGDependency.get_out_edges(node_id)">
|
||
Enumeration of all outgoing edges for a given node.
|
||
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – label of considered node.
|
||
|
||
**Returns**
|
||
|
||
corresponding outgoing edges data.
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-predecessors" />
|
||
|
||
### predecessors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.predecessors" signature="DAGDependency.predecessors(node_id)">
|
||
Predecessors id of a given node as sorted list.
|
||
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – label of considered node.
|
||
|
||
**Returns**
|
||
|
||
all predecessors id as a sorted list
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-replace-block-with-op" />
|
||
|
||
### replace\_block\_with\_op
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.replace_block_with_op" signature="DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)">
|
||
Replace a block of nodes with a single node.
|
||
|
||
This is used to consolidate a block of DAGDepNodes into a single operation. A typical example is a block of CX and SWAP gates consolidated into a LinearFunction. This function is an adaptation of a similar function from DAGCircuit.
|
||
|
||
It is important that such consolidation preserves commutativity assumptions present in DAGDependency. As an example, suppose that every node in a block \[A, B, C, D] commutes with another node E. Let F be the consolidated node, F = A o B o C o D. Then F also commutes with E, and thus the result of replacing \[A, B, C, D] by F results in a valid DAGDependency. That is, any deduction about commutativity in consolidated DAGDependency is correct. On the other hand, suppose that at least one of the nodes, say B, does not commute with E. Then the consolidated DAGDependency would imply that F does not commute with E. Even though F and E may actually commute, it is still safe to assume that they do not. That is, the current implementation of consolidation may lead to suboptimal but not to incorrect results.
|
||
|
||
**Parameters**
|
||
|
||
* **node\_block** (*List\[*[*DAGDepNode*](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")*]*) – A list of dag nodes that represents the node block to be replaced
|
||
* **op** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The operation to replace the block with
|
||
* **wire\_pos\_map** (*Dict\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*, int]*) – The dictionary mapping the qarg to the position. This is necessary to reconstruct the qarg order over multiple gates in the combined single op node.
|
||
* **cycle\_check** (*bool*) – When set to True this method will check that replacing the provided `node_block` with a single node would introduce a cycle (which would invalidate the `DAGDependency`) and will raise a `DAGDependencyError` if a cycle would be introduced. This checking comes with a run time penalty. If you can guarantee that your input `node_block` is a contiguous block and won’t introduce a cycle when it’s contracted to a single node, this can be set to `False` to improve the runtime performance of this method.
|
||
|
||
**Raises**
|
||
|
||
**DAGDependencyError** – if `cycle_check` is set to `True` and replacing the specified block introduces a cycle or if `node_block` is empty.
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-size" />
|
||
|
||
### size
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.size" signature="DAGDependency.size()">
|
||
Returns the number of gates in the circuit
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-successors" />
|
||
|
||
### successors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.successors" signature="DAGDependency.successors(node_id)">
|
||
Successors id of a given node as sorted list.
|
||
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – label of considered node.
|
||
|
||
**Returns**
|
||
|
||
all successors id as a sorted list
|
||
|
||
**Return type**
|
||
|
||
List
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-to-retworkx" />
|
||
|
||
### to\_retworkx
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.to_retworkx" signature="DAGDependency.to_retworkx()">
|
||
Returns the DAGDependency in retworkx format.
|
||
</Function>
|
||
|
||
<span id="qiskit-dagcircuit-dagdependency-topological-nodes" />
|
||
|
||
### topological\_nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGDependency.topological_nodes" signature="DAGDependency.topological_nodes()">
|
||
Yield nodes in topological order.
|
||
|
||
**Returns**
|
||
|
||
node in topological order.
|
||
|
||
**Return type**
|
||
|
||
generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode"))
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### calibrations
|
||
|
||
<Attribute id="qiskit.dagcircuit.DAGDependency.calibrations">
|
||
Return calibration dictionary.
|
||
|
||
**The custom pulse definition of a given gate is of the form**
|
||
|
||
\{‘gate\_name’: \{(qubits, params): schedule}}
|
||
</Attribute>
|
||
|
||
### global\_phase
|
||
|
||
<Attribute id="qiskit.dagcircuit.DAGDependency.global_phase">
|
||
Return the global phase of the circuit.
|
||
</Attribute>
|
||
</Class>
|
||
|