Qiskit / qiskit / 27220039202

88%

main: 88%

Build Type

push

github

Committed by web-flow

Commit Message

Add C API for two qubit unitary peephole optimization pass (#16088)

* Add C API for two qubit unitary peephole optimization pass

This commit adds the new TwoQubitPeepholeOptimization pass to the C API.
It adds two new functions:
`qk_transpiler_pass_standalone_two_qubit_peephole_optimization` and
`qk_transpiler_pass_two_qubit_peephole_optimization` for running the
pass on a `QkCircuit` and a `QkDag` respectively.

* Update Python binding handling

In #13419 the pass has been updated to handle threads that need access
to Python objects to get matrices or definitions of custom Python gates.
This changes the story for the C API when using the C API in a python
binding context. To run the C API reliably within a Python context the
pass needs to be in a context with the GIL so it can be reliably
released and reacquired where necessary in the rust code.

* Add newlines to printf calls in C tests

* Rename methods to use 2q instead of two_qubit

* Update docs

* Fix clippy warnings

* Add nan approximation_degree tests

* Update names in vtable too

* Remove feature flag switching between py function

In an earlier commit this PR had used the `python_binding` feature flag
to switch between calling the Python version of the peephole pass and
the Python free version. However this solution wasn't correct because it
tied builds that enabeld the python_binding feature to always have the
GIL when calling that function, which wasn't guaranteed and wasn't the
case in our Rust test suite either.

Instead this commit removes the feature flag based switching and just
opts to call the Python free function which will not work with circuit
elements owned by Python. It documents the limitation of this function
with Python and directs people to the Python class as the entrypoint if
there is a Python owned element in the circuit.

* Fix docstring for dag function

* Add test that uses an overcomplete basis and fractional gates

* Fix windows printf

* Apply suggestions from... (continued)

Coverage Stats

111 of 123 new or added lines in 2 files covered. (90.24%)

3 existing lines in 1 file now uncovered.

110812 of 126582 relevant lines covered (87.54%)

955589.05 hits per line