726 lines
27 KiB
Plaintext
726 lines
27 KiB
Plaintext
---
|
||
title: DAGCircuit
|
||
description: API reference for qiskit.dagcircuit.DAGCircuit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.dagcircuit.DAGCircuit
|
||
---
|
||
|
||
# DAGCircuit
|
||
|
||
<Class id="qiskit.dagcircuit.DAGCircuit" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/dagcircuit/dagcircuit.py" signature="DAGCircuit" modifiers="class">
|
||
Bases: `object`
|
||
|
||
Quantum circuit as a directed acyclic graph.
|
||
|
||
There are 3 types of nodes in the graph: inputs, outputs, and operations. The nodes are connected by directed edges that correspond to qubits and bits.
|
||
|
||
Create an empty circuit.
|
||
|
||
## Methods
|
||
|
||
### add\_calibration
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.add_calibration" signature="DAGCircuit.add_calibration(gate, qubits, schedule, params=None)">
|
||
Register a low-level, custom pulse definition for the given gate.
|
||
|
||
**Parameters**
|
||
|
||
* **gate** (*Union\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*, str]*) – Gate information.
|
||
* **qubits** (*Union\[int, Tuple\[int]]*) – List of qubits to be measured.
|
||
* **schedule** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")) – Schedule information.
|
||
* **params** (*Optional\[List\[Union\[float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]]*) – A list of parameters.
|
||
|
||
**Raises**
|
||
|
||
**Exception** – if the gate is of type string and params is None.
|
||
</Function>
|
||
|
||
### add\_clbits
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.add_clbits" signature="DAGCircuit.add_clbits(clbits)">
|
||
Add individual clbit wires.
|
||
</Function>
|
||
|
||
### add\_creg
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.add_creg" signature="DAGCircuit.add_creg(creg)">
|
||
Add all wires in a classical register.
|
||
</Function>
|
||
|
||
### add\_qreg
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.add_qreg" signature="DAGCircuit.add_qreg(qreg)">
|
||
Add all wires in a quantum register.
|
||
</Function>
|
||
|
||
### add\_qubits
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.add_qubits" signature="DAGCircuit.add_qubits(qubits)">
|
||
Add individual qubit wires.
|
||
</Function>
|
||
|
||
### ancestors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.ancestors" signature="DAGCircuit.ancestors(node)">
|
||
Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes.
|
||
</Function>
|
||
|
||
### apply\_operation\_back
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.apply_operation_back" signature="DAGCircuit.apply_operation_back(op, qargs=None, cargs=None)">
|
||
Apply an operation to the output of the circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **op** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – the operation associated with the DAG node
|
||
* **qargs** (*list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to
|
||
* **cargs** (*list\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to
|
||
|
||
**Returns**
|
||
|
||
the node for the op that was added to the dag
|
||
|
||
**Return type**
|
||
|
||
[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if a leaf node is connected to multiple outputs
|
||
</Function>
|
||
|
||
### apply\_operation\_front
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.apply_operation_front" signature="DAGCircuit.apply_operation_front(op, qargs, cargs)">
|
||
Apply an operation to the input of the circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **op** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – the operation associated with the DAG node
|
||
* **qargs** (*list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to
|
||
* **cargs** (*list\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to
|
||
|
||
**Returns**
|
||
|
||
the node for the op that was added to the dag
|
||
|
||
**Return type**
|
||
|
||
[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if initial nodes connected to multiple out edges
|
||
</Function>
|
||
|
||
### bfs\_successors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.bfs_successors" signature="DAGCircuit.bfs_successors(node)">
|
||
Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order.
|
||
</Function>
|
||
|
||
### collect\_1q\_runs
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.collect_1q_runs" signature="DAGCircuit.collect_1q_runs()">
|
||
Return a set of non-conditional runs of 1q “op” nodes.
|
||
</Function>
|
||
|
||
### collect\_2q\_runs
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.collect_2q_runs" signature="DAGCircuit.collect_2q_runs()">
|
||
Return a set of non-conditional runs of 2q “op” nodes.
|
||
</Function>
|
||
|
||
### collect\_runs
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.collect_runs" signature="DAGCircuit.collect_runs(namelist)">
|
||
Return a set of non-conditional runs of “op” nodes with the given names.
|
||
|
||
For example, “… h q\[0]; cx q\[0],q\[1]; cx q\[0],q\[1]; h q\[1]; ..” would produce the tuple of cx nodes as an element of the set returned from a call to collect\_runs(\[“cx”]). If instead the cx nodes were “cx q\[0],q\[1]; cx q\[1],q\[0];”, the method would still return the pair in a tuple. The namelist can contain names that are not in the circuit’s basis.
|
||
|
||
Nodes must have only one successor to continue the run.
|
||
</Function>
|
||
|
||
### compose
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.compose" signature="DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)">
|
||
Compose the `other` circuit onto the output of this circuit.
|
||
|
||
A subset of input wires of `other` are mapped to a subset of output wires of this circuit.
|
||
|
||
`other` can be narrower or of equal width to `self`.
|
||
|
||
**Parameters**
|
||
|
||
* **other** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – circuit to compose with self
|
||
* **qubits** (*list\[Qubit|int]*) – qubits of self to compose onto.
|
||
* **clbits** (*list\[Clbit|int]*) – clbits of self to compose onto.
|
||
* **front** (*bool*) – If True, front composition will be performed (not implemented yet)
|
||
* **inplace** (*bool*) – If True, modify the object. Otherwise return composed circuit.
|
||
|
||
**Returns**
|
||
|
||
the composed dag (returns None if inplace==True).
|
||
|
||
**Return type**
|
||
|
||
[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if `other` is wider or there are duplicate edge mappings.
|
||
</Function>
|
||
|
||
### count\_ops
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.count_ops" signature="DAGCircuit.count_ops()">
|
||
Count the occurrences of operation names.
|
||
|
||
Returns a dictionary of counts keyed on the operation name.
|
||
</Function>
|
||
|
||
### count\_ops\_longest\_path
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.count_ops_longest_path" signature="DAGCircuit.count_ops_longest_path()">
|
||
Count the occurrences of operation names on the longest path.
|
||
|
||
Returns a dictionary of counts keyed on the operation name.
|
||
</Function>
|
||
|
||
### depth
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.depth" signature="DAGCircuit.depth()">
|
||
Return the circuit depth. :returns: the circuit depth :rtype: int
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if not a directed acyclic graph
|
||
</Function>
|
||
|
||
### descendants
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.descendants" signature="DAGCircuit.descendants(node)">
|
||
Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes.
|
||
</Function>
|
||
|
||
### draw
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.draw" signature="DAGCircuit.draw(scale=0.7, filename=None, style='color')">
|
||
Draws the dag circuit.
|
||
|
||
This function needs [pydot](https://github.com/erocarrera/pydot), which in turn needs [Graphviz](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>
|
||
|
||
### edges
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.edges" signature="DAGCircuit.edges(nodes=None)">
|
||
Iterator for edge values and source and dest node
|
||
|
||
This works by returning the output edges from the specified nodes. If no nodes are specified all edges from the graph are returned.
|
||
|
||
#### Parameters
|
||
|
||
**nodes** ([*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")*,* [*DAGInNode*](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")*, or DAGOutNode|list(*[*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")*,* [*DAGInNode*](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")*, or* [*DAGOutNode*](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")) – Either a list of nodes or a single input node. If none is specified, all edges are returned from the graph.
|
||
|
||
#### Yields
|
||
|
||
*edge* –
|
||
|
||
#### the edge in the same format as out\_edges the tuple
|
||
|
||
(source node, destination node, edge data)
|
||
</Function>
|
||
|
||
### from\_networkx
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.from_networkx" signature="DAGCircuit.from_networkx(graph)" modifiers="classmethod">
|
||
Take a networkx MultiDigraph and create a new DAGCircuit.
|
||
|
||
**Parameters**
|
||
|
||
**graph** (*networkx.MultiDiGraph*) – The graph to create a DAGCircuit object from. The format of this MultiDiGraph format must be in the same format as returned by to\_networkx.
|
||
|
||
**Returns**
|
||
|
||
**The dagcircuit object created from the networkx**
|
||
|
||
MultiDiGraph.
|
||
|
||
**Return type**
|
||
|
||
[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")
|
||
|
||
**Raises**
|
||
|
||
* **MissingOptionalLibraryError** – If networkx is not installed
|
||
* [**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – If input networkx graph is malformed
|
||
</Function>
|
||
|
||
### front\_layer
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.front_layer" signature="DAGCircuit.front_layer()">
|
||
Return a list of op nodes in the first layer of this dag.
|
||
</Function>
|
||
|
||
### gate\_nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.gate_nodes" signature="DAGCircuit.gate_nodes()">
|
||
Get the list of gate nodes in the dag.
|
||
|
||
**Returns**
|
||
|
||
the list of DAGOpNodes that represent gates.
|
||
|
||
**Return type**
|
||
|
||
list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")]
|
||
</Function>
|
||
|
||
### has\_calibration\_for
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.has_calibration_for" signature="DAGCircuit.has_calibration_for(node)">
|
||
Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis.
|
||
</Function>
|
||
|
||
### idle\_wires
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.idle_wires" signature="DAGCircuit.idle_wires(ignore=None)">
|
||
Return idle wires.
|
||
|
||
**Parameters**
|
||
|
||
**ignore** (*list(str)*) – List of node names to ignore. Default: \[]
|
||
|
||
**Yields**
|
||
|
||
*Bit* – Bit in idle wire.
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – If the DAG is invalid
|
||
</Function>
|
||
|
||
### is\_predecessor
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.is_predecessor" signature="DAGCircuit.is_predecessor(node, node_pred)">
|
||
Checks if a second node is in the predecessors of node.
|
||
</Function>
|
||
|
||
### is\_successor
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.is_successor" signature="DAGCircuit.is_successor(node, node_succ)">
|
||
Checks if a second node is in the successors of node.
|
||
</Function>
|
||
|
||
### layers
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.layers" signature="DAGCircuit.layers()">
|
||
Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit.
|
||
|
||
A layer is a circuit whose gates act on disjoint qubits, i.e., a layer has depth 1. The total number of layers equals the circuit depth d. The layers are indexed from 0 to d-1 with the earliest layer at index 0. The layers are constructed using a greedy algorithm. Each returned layer is a dict containing \{“graph”: circuit graph, “partition”: list of qubit lists}.
|
||
|
||
The returned layer contains new (but semantically equivalent) DAGOpNodes, DAGInNodes, and DAGOutNodes. These are not the same as nodes of the original dag, but are equivalent via DAGNode.semantic\_eq(node1, node2).
|
||
|
||
TODO: Gates that use the same cbits will end up in different layers as this is currently implemented. This may not be the desired behavior.
|
||
</Function>
|
||
|
||
### longest\_path
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.longest_path" signature="DAGCircuit.longest_path()">
|
||
Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes.
|
||
</Function>
|
||
|
||
### multi\_qubit\_ops
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.multi_qubit_ops" signature="DAGCircuit.multi_qubit_ops()">
|
||
Get list of 3+ qubit operations. Ignore directives like snapshot and barrier.
|
||
</Function>
|
||
|
||
### multigraph\_layers
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.multigraph_layers" signature="DAGCircuit.multigraph_layers()">
|
||
Yield layers of the multigraph.
|
||
</Function>
|
||
|
||
### named\_nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.named_nodes" signature="DAGCircuit.named_nodes(*names)">
|
||
Get the set of “op” nodes with the given name.
|
||
</Function>
|
||
|
||
### node
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.node" signature="DAGCircuit.node(node_id)">
|
||
Get the node in the dag.
|
||
|
||
**Parameters**
|
||
|
||
**node\_id** (*int*) – Node identifier.
|
||
|
||
**Returns**
|
||
|
||
the node.
|
||
|
||
**Return type**
|
||
|
||
node
|
||
</Function>
|
||
|
||
### nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.nodes" signature="DAGCircuit.nodes()">
|
||
Iterator for node values.
|
||
|
||
**Yields**
|
||
|
||
*node* – the node.
|
||
</Function>
|
||
|
||
### nodes\_on\_wire
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.nodes_on_wire" signature="DAGCircuit.nodes_on_wire(wire, only_ops=False)">
|
||
Iterator for nodes that affect a given wire.
|
||
|
||
**Parameters**
|
||
|
||
* **wire** (*Bit*) – the wire to be looked at.
|
||
* **only\_ops** (*bool*) – True if only the ops nodes are wanted; otherwise, all nodes are returned.
|
||
|
||
**Yields**
|
||
|
||
*Iterator* – the successive nodes on the given wire
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if the given wire doesn’t exist in the DAG
|
||
</Function>
|
||
|
||
### num\_clbits
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.num_clbits" signature="DAGCircuit.num_clbits()">
|
||
Return the total number of classical bits used by the circuit.
|
||
</Function>
|
||
|
||
### num\_qubits
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.num_qubits" signature="DAGCircuit.num_qubits()">
|
||
Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564].
|
||
</Function>
|
||
|
||
### num\_tensor\_factors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.num_tensor_factors" signature="DAGCircuit.num_tensor_factors()">
|
||
Compute how many components the circuit can decompose into.
|
||
</Function>
|
||
|
||
### op\_nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.op_nodes" signature="DAGCircuit.op_nodes(op=None, include_directives=True)">
|
||
Get the list of “op” nodes in the dag.
|
||
|
||
**Parameters**
|
||
|
||
* **op** (*Type*) – [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") subclass op nodes to return. If None, return all op nodes.
|
||
* **include\_directives** (*bool*) – include barrier, snapshot etc.
|
||
|
||
**Returns**
|
||
|
||
the list of node ids containing the given op.
|
||
|
||
**Return type**
|
||
|
||
list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")]
|
||
</Function>
|
||
|
||
### predecessors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.predecessors" signature="DAGCircuit.predecessors(node)">
|
||
Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes.
|
||
</Function>
|
||
|
||
### properties
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.properties" signature="DAGCircuit.properties()">
|
||
Return a dictionary of circuit properties.
|
||
</Function>
|
||
|
||
### quantum\_predecessors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.quantum_predecessors" signature="DAGCircuit.quantum_predecessors(node)">
|
||
Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes.
|
||
</Function>
|
||
|
||
### quantum\_successors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.quantum_successors" signature="DAGCircuit.quantum_successors(node)">
|
||
Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes.
|
||
</Function>
|
||
|
||
### remove\_all\_ops\_named
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_all_ops_named" signature="DAGCircuit.remove_all_ops_named(opname)">
|
||
Remove all operation nodes with the given name.
|
||
</Function>
|
||
|
||
### remove\_ancestors\_of
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_ancestors_of" signature="DAGCircuit.remove_ancestors_of(node)">
|
||
Remove all of the ancestor operation nodes of node.
|
||
</Function>
|
||
|
||
### remove\_clbits
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_clbits" signature="DAGCircuit.remove_clbits(*clbits)">
|
||
Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed.
|
||
|
||
**Parameters**
|
||
|
||
**clbits** (*List\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – The bits to remove.
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – a clbit is not a [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit"), is not in the circuit, or is not idle.
|
||
</Function>
|
||
|
||
### remove\_cregs
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_cregs" signature="DAGCircuit.remove_cregs(*cregs)">
|
||
Remove classical registers from the circuit, leaving underlying bits in place.
|
||
|
||
**Raises**
|
||
|
||
* [**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – a creg is not a ClassicalRegister, or is not in
|
||
* **the circuit.** –
|
||
</Function>
|
||
|
||
### remove\_descendants\_of
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_descendants_of" signature="DAGCircuit.remove_descendants_of(node)">
|
||
Remove all of the descendant operation nodes of node.
|
||
</Function>
|
||
|
||
### remove\_nonancestors\_of
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_nonancestors_of" signature="DAGCircuit.remove_nonancestors_of(node)">
|
||
Remove all of the non-ancestors operation nodes of node.
|
||
</Function>
|
||
|
||
### remove\_nondescendants\_of
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_nondescendants_of" signature="DAGCircuit.remove_nondescendants_of(node)">
|
||
Remove all of the non-descendants operation nodes of node.
|
||
</Function>
|
||
|
||
### remove\_op\_node
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.remove_op_node" signature="DAGCircuit.remove_op_node(node)">
|
||
Remove an operation node n.
|
||
|
||
Add edges from predecessors to successors.
|
||
</Function>
|
||
|
||
### replace\_block\_with\_op
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.replace_block_with_op" signature="DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)">
|
||
Replace a block of nodes with a single.
|
||
|
||
This is used to consolidate a block of DAGOpNodes into a single operation. A typical example is a block of gates being consolidated into a single `UnitaryGate` representing the unitary matrix of the block.
|
||
|
||
**Parameters**
|
||
|
||
* **node\_block** (*List\[*[*DAGNode*](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")*]*) – A list of dag nodes that represents the node block to be replaced
|
||
* **op** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The instruction 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 singe 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 a cycle (which would invalidate the `DAGCircuit`) and will raise a `DAGCircuitError` 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**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if `cycle_check` is set to `True` and replacing the specified block introduces a cycle or if `node_block` is empty.
|
||
</Function>
|
||
|
||
### reverse\_ops
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.reverse_ops" signature="DAGCircuit.reverse_ops()">
|
||
Reverse the operations in the `self` circuit.
|
||
|
||
**Returns**
|
||
|
||
the reversed dag.
|
||
|
||
**Return type**
|
||
|
||
[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")
|
||
</Function>
|
||
|
||
### serial\_layers
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.serial_layers" signature="DAGCircuit.serial_layers()">
|
||
Yield a layer for all gates of this circuit.
|
||
|
||
A serial layer is a circuit with one gate. The layers have the same structure as in layers().
|
||
</Function>
|
||
|
||
### size
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.size" signature="DAGCircuit.size()">
|
||
Return the number of operations.
|
||
</Function>
|
||
|
||
### substitute\_node
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.substitute_node" signature="DAGCircuit.substitute_node(node, op, inplace=False)">
|
||
Replace an DAGOpNode with a single instruction. qargs, cargs and conditions for the new instruction will be inferred from the node to be replaced. The new instruction will be checked to match the shape of the replaced instruction.
|
||
|
||
**Parameters**
|
||
|
||
* **node** ([*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")) – Node to be replaced
|
||
* **op** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance to be added to the DAG
|
||
* **inplace** (*bool*) – Optional, default False. If True, existing DAG node will be modified to include op. Otherwise, a new DAG node will be used.
|
||
|
||
**Returns**
|
||
|
||
the new node containing the added instruction.
|
||
|
||
**Return type**
|
||
|
||
[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")
|
||
|
||
**Raises**
|
||
|
||
* [**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – If replacement instruction was incompatible with
|
||
* **location of target node.** –
|
||
</Function>
|
||
|
||
### substitute\_node\_with\_dag
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.substitute_node_with_dag" signature="DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None)">
|
||
Replace one node with dag.
|
||
|
||
**Parameters**
|
||
|
||
* **node** ([*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")) – node to substitute
|
||
* **input\_dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – circuit that will substitute the node
|
||
* **wires** (*list\[Bit]*) – gives an order for (qu)bits in the input circuit. This order gets matched to the node wires by qargs first, then cargs, then conditions.
|
||
|
||
**Returns**
|
||
|
||
maps node IDs from input\_dag to their new node incarnations in self.
|
||
|
||
**Return type**
|
||
|
||
dict
|
||
|
||
**Raises**
|
||
|
||
[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if met with unexpected predecessor/successors
|
||
</Function>
|
||
|
||
### successors
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.successors" signature="DAGCircuit.successors(node)">
|
||
Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes.
|
||
</Function>
|
||
|
||
### to\_networkx
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.to_networkx" signature="DAGCircuit.to_networkx()">
|
||
Returns a copy of the DAGCircuit in networkx format.
|
||
</Function>
|
||
|
||
### topological\_nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.topological_nodes" signature="DAGCircuit.topological_nodes(key=None)">
|
||
Yield nodes in topological order.
|
||
|
||
**Parameters**
|
||
|
||
**key** (*Callable*) – A callable which will take a DAGNode object and return a string sort key. If not specified the `sort_key` attribute will be used as the sort key for each node.
|
||
|
||
**Returns**
|
||
|
||
node in topological order
|
||
|
||
**Return type**
|
||
|
||
generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode"), [DAGInNode](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode"), or [DAGOutNode](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode"))
|
||
</Function>
|
||
|
||
### topological\_op\_nodes
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.topological_op_nodes" signature="DAGCircuit.topological_op_nodes(key=None)">
|
||
Yield op nodes in topological order.
|
||
|
||
Allowed to pass in specific key to break ties in top order
|
||
|
||
**Parameters**
|
||
|
||
**key** (*Callable*) – A callable which will take a DAGNode object and return a string sort key. If not specified the `sort_key` attribute will be used as the sort key for each node.
|
||
|
||
**Returns**
|
||
|
||
op node in topological order
|
||
|
||
**Return type**
|
||
|
||
generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode"))
|
||
</Function>
|
||
|
||
### two\_qubit\_ops
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.two_qubit_ops" signature="DAGCircuit.two_qubit_ops()">
|
||
Get list of 2 qubit operations. Ignore directives like snapshot and barrier.
|
||
</Function>
|
||
|
||
### width
|
||
|
||
<Function id="qiskit.dagcircuit.DAGCircuit.width" signature="DAGCircuit.width()">
|
||
Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width().
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### calibrations
|
||
|
||
<Attribute id="qiskit.dagcircuit.DAGCircuit.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.DAGCircuit.global_phase">
|
||
Return the global phase of the circuit.
|
||
</Attribute>
|
||
|
||
### node\_counter
|
||
|
||
<Attribute id="qiskit.dagcircuit.DAGCircuit.node_counter">
|
||
Returns the number of nodes in the dag.
|
||
</Attribute>
|
||
|
||
### wires
|
||
|
||
<Attribute id="qiskit.dagcircuit.DAGCircuit.wires">
|
||
Return a list of the wires in order.
|
||
</Attribute>
|
||
</Class>
|
||
|