[WIP] Add method to add instructions to a `DAGCircuit` from an iterator of `PackedInstruction`

[raynelfss]

Solves #13003

Summary

Tracked by #13001 and preceeded by #12975 The following commits aim to add a DAGCircuit::add_from_iter() to add a chain of DAGOpNodes to the DAGCircuit based on a sequence of PackedInstruction.

Details and comments

These commits add the following two methods:

• DAGCircuit::add_from_iter() to add a sequence of PackedInstruction continously avoiding having to re-add each bit/var's output node each time an instruction is added. The addition of the output node is only performed once all instructions have been added correctly to the DAGCircuit.

Known issues:

• At the moment, I'm still thinking of ways of handling vars correctly as we need to keep track of each bit/var's output node and vars are currently represented as PyObject which are not hashable.
  • One possible solution would be to use a PyDict however the structures that are being stored within this mapping are rust-native (NodeIndex, Wire).
  • Another solution would be to somehow internalize these structures, which I'm still thinking on how to do.
• Feel free to comment with any ideas.

Blockers

• [ ] #12975 (will rebase once merged)
• [x] #12550

[coveralls]

Pull Request Test Coverage Report for Build 10527975357

Details

• 5057 of 6058 (83.48%) changed or added relevant lines in 39 files are covered.
• 51 unchanged lines in 10 files lost coverage.
• Overall coverage decreased (-0.5%) to 89.069%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
crates/circuit/src/interner.rs	16	17	94.12%
crates/circuit/src/circuit_data.rs	21	23	91.3%
crates/circuit/src/circuit_instruction.rs	3	9	33.33%
crates/circuit/src/operations.rs	10	17	58.82%
crates/circuit/src/packed_instruction.rs	65	72	90.28%
qiskit/visualization/dag_visualization.py	5	20	25.0%
crates/circuit/src/dag_node.rs	167	193	86.53%
crates/circuit/src/dot_utils.rs	0	68	0.0%
crates/circuit/src/rustworkx_core_vnext.rs	598	917	65.21%
crates/circuit/src/dag_circuit.rs	4064	4614	88.08%
<!--	Total:	5057	6058	83.48%	-->

Files with Coverage Reduction	New Missed Lines	%
crates/circuit/src/interner.rs	1	78.79%
qiskit/circuit/instruction.py	1	95.27%
qiskit/transpiler/passes/routing/stochastic_swap.py	1	95.39%
qiskit/dagcircuit/dagnode.py	1	85.37%
crates/circuit/src/circuit_instruction.rs	4	88.5%
qiskit/dagcircuit/dagdependency_v2.py	5	67.62%
crates/qasm2/src/lex.rs	5	92.48%
crates/circuit/src/dag_node.rs	7	83.61%
crates/qasm2/src/parse.rs	12	96.23%
crates/circuit/src/operations.rs	14	88.19%
<!--	Total:	51		-->

Totals
Change from base Build 10525107270:	-0.5%
Covered Lines:	71614
Relevant Lines:	80403

---

💛 - Coveralls