[Stable] Improve 1q decomposition pass with multiple matching basis (#5431)

[mtreinish]

Summary

• Improve 1q decomposition pass with multiple matching basis

This commit makes an improvement to the Optimize1qGatesDecomposition
pass to improve the output from it in two scenarios. The first scenario
is if there is an over complete basis where there are multiple choices
for decomposition basis. Previously in such scenarios only the first
matching subset would be used. This improves that by finding runs in all
matching decomposition basis to simplify any runs in those gate sets.
The second improvement made here is that the decomposition is only used
if it results in a decrease in depth. There were scenarios where the
general decomposition of a run would result in more gates than the
input to the OneQubitEulerDecomposer (typically 3 gates vs 2 input). In
those cases we shouldn't use the decomposition and instead rely on the
original run because we're adding gates which is the opposit of the
expected behavior.

• Add DAGCircuit method to get 1q op node runs

This commit adds a new DAGCircuit method, collect_1q_runs, which behaves
like collect_runs(), but instead of collecting runs with gates on a name
filter it looks at the number of qubits and returns runs of any op node
that operate on a single qubit. This will be used by the optimize 1q
decomposition pass to collect arbitrary single qubit gate runs and
decompose them over the basis sets.

• Switch to use all 1q runs instead of those just matching basis

• Move parameterized gate split to collect_1q_runs

• Reverse loops so basis is the inner loop and runs the outer

• Ensure collect_1q_runs doesn't collect measurements

• Only create temp circuit once per run

• Move lone identity optimization into outer loop

• Update qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py

• Fix lint

• Use qc._append instead of qc.append

Details and comments

Backported from #5431 and #5570

Conflicts/Changes:

For backport this makes 1 key change, the collect_1q_runs method is
rewritten to be pure python instead of leveraging the retworkx
collect_runs() method which was added in a newer version of retworkx
than the minimum allowed version. This also partially pulls in the
changes made in #5570, but only some were backportable since the others
relied on attributes that don't exist in gate objects in 0.16.x.

(cherry picked from commit 5a1768f)

[kdk]

Looks good. Does this need its own release note?

[mtreinish]

@kdk Ok, I've updated this per your comments. As for the release notes I'll defer to you on it. I didn't write one for the master commit because I felt it was an internal implementation detail and kind of hard to describe the difference in a user facing perspective besides something like "update the 1q optimization decompose pass so it does a better job for an overcomplete basis" which didn't seem necessarily helpful as a fix note.