Qiskit / qiskit / 16942709694

88%

main: 88%

Build Type

push

github

Committed by web-flow

Commit Message

Add structural equality check for `DAGCircuit` (#14762)

* Add structural equality check for `DAGCircuit`

The current implementation of equality (the Python-facing
`DAGCircuit.__eq__`) is a semantic-equality checker.  This is typically
what users care about.  Transpiler-pass authors, however, need to care
about determinism in the order of modifications of a DAG, including
normally internal details such as the precise set of `NodeIndex`es that
are populated, or the order the edges are traversed for any given node.

This commit adds a new method, `DAGCircuit::structurally_equal`, which
checks the node and edge lists of the graph structure for exact equality
(slightly indirectly, since `petgraph` doesn't let us access the
internal details of the `StableGraph` struct directly), to help verify
whether two DAGs have gone through the same order of modifications.

* Improve documentation

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

* Update crates/circuit/src/dag_circuit.rs

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

---------

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

Run Details

99 of 127 new or added lines in 3 files covered. (77.95%)

6 existing lines in 3 files now uncovered.

87221 of 98825 relevant lines covered (88.26%)

520963.51 hits per line