Port RemoveDiagonalGatesBeforeMeasure to rust

[ShellyGarion]

Summary

close #12255

Details and comments

[qiskit-bot]

One or more of the following people are relevant to this code:

• @Qiskit/terra-core
• @kevinhartman
• @mtreinish

[mtreinish]

This looks good, thanks for doing this. I just left a few small inline comments which I think should fix the test failures too.

[ShellyGarion]

Note that there are some 1-qubit and 2-qubit diagonal gates that did not appear in the original list, so I added them here (I'll add them to the tests later).

There is also a 3-qubit diagonal gate: CCZGate (which was not added in this PR)

[ShellyGarion]

In fact, there is also an n-qubit diagonal gate: MCPhaseGate. This gate was not handled this PR.
This is since the algorithm given here that goes over all the successors of each of the predecessors would be O(n^2) and not O(n).

[ShellyGarion]

the failing test should be fixed after #13067 is merged

[ShellyGarion]

Performance comparison of the old python code and the new rust code for a random_circuit:

n_qubits	depth	time is sec of old Python code	time in sec of new rust code
5	1024	0.06	0.00
14	1024	0.47	0.02
20	1024	0.92	0.04

[coveralls]

Pull Request Test Coverage Report for Build 10719300369

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 75 of 76 (98.68%) changed or added relevant lines in 5 files are covered.
• 120 unchanged lines in 2 files lost coverage.
• Overall coverage increased (+0.005%) to 89.186%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
crates/accelerate/src/remove_diagonal_gates_before_measure.rs	65	66	98.48%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	5	91.98%
qiskit/visualization/gate_map.py	115	6.69%

Totals
Change from base Build 10708280718:	0.005%
Covered Lines:	72673
Relevant Lines:	81485

---

💛 - Coveralls

[Cryoris]

LGTM, also great to add the phase gates 👍🏻

As you mentioned, there is MCPhaseGate which we could handle, as well as DiagonalGate or any AnnotatedOperation with a diagonal base gate. But that would be something for a follow up (we would also make sure to remove these before any further decomposition occurs).