C API: Burn `Optimize1qGatesDecomposition`. by raynelfss · Pull Request #14710 · Qiskit/qiskit

raynelfss · 2025-07-08T21:52:18Z

Summary

After oxidizing Optimize1QGatesDecomposition in #12959 it's time to make a combustion reaction that releases a carbon byproduct (our C API for it). The following commits aim to expose a standalone function that will give access to the rust counterpart.

This implementation adds the function qk_transpiler_standalone_optimize_1q_gates_decomposition which accepts a QkCircuit and an optional instance of QkTarget and calls the Rust counterpart.

Details and comments

Closes #14453. ~~Built on top of #14668 (NEEDS REBASING AFTER IT MERGES).~~ REBASED!

coveralls · 2025-07-08T22:24:55Z

Pull Request Test Coverage Report for Build 17244313498

Details

17 of 17 (100.0%) changed or added relevant lines in 1 file are covered.
7 unchanged lines in 4 files lost coverage.
Overall coverage increased (+0.02%) to 88.39%

Files with Coverage Reduction	New Missed Lines	%
crates/circuit/src/parameter/parameter_expression.rs	1	82.8%
crates/qasm2/src/expr.rs	1	93.63%
crates/circuit/src/parameter/symbol_expr.rs	2	72.82%
crates/qasm2/src/lex.rs	3	91.24%

Totals
Change from base Build 17244219599:	0.02%
Covered Lines:	90135
Relevant Lines:	101974

💛 - Coveralls

qiskit-bot · 2025-07-10T18:02:58Z

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

@Eric-Arellano
@abbycross
@beckykd
@Qiskit/terra-core

- The following commit adds initial access to a standalone C foreign function interface that allows users to run the `Optimize1qGatesDecomposition` transpiler pass. The feature as it stands requires the user to build a target prior to submitting the circuit; This might change in the future. - Added 1 initial testing suite for the pass which converts a sequence of H gates into a different sequences depending on the provided target. More tests will be added with time.

… API. - Add ability of running the pass without passing a `Target`. - Add proper formatting to unit tests with multiple tests inside. - Add tests without target.

raynelfss · 2025-07-22T15:33:44Z

This PR is currently blocked on #14777

Cryoris · 2025-07-23T11:25:57Z

+/// qubit it operates on.
+///
+/// @param circuit A pointer to the ``QkCircuit`` object to transform.
+/// @param target A pointer to the ``QkTarget`` object.


From the code it looks like this is allowed to be a null pointer. What happens in this case? We should document that

From snippet:

/// In the case a null pointer is provided and gate errors are unknown /// the pass will choose the sequence with the least amount of gates, /// and will support all basis gates on its Euler basis set.

…comp

- Make tha function call run in-place and modify the pointer to the `QkCircuit` in use. - Remove `h_p_target` from tests. - Use parametric gates in the target with generic parameter expressions instead of fixed ones.

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

Cryoris

Overall LGTM, some nits below and then I think there are 2 open comments left: one about renaming this pass (which I still think we should take the chance for) and one about the docs saying that this pass compresses sequences into a single gate (which it doesn't, right?)

Cryoris · 2025-08-15T07:10:53Z

+    let mut circuit_as_dag = DAGCircuit::from_circuit_data(circuit, false, None, None, None, None)
+        .expect("Error while converting the circuit to a dag.");


It would be nice if we would have a set of TranspilerErrors which we could return here instead of just panicking... but maybe this would need to be done generally for all passes in a follow-up.

Co-authored-by: Julien Gacon <gaconju@gmail.com>

…comp

Cryoris · 2025-08-18T09:42:40Z

This LGTM up to the two comments above on the documentation (this pass does not merge gates into a single gate, the Python docs are also wrong 🙂) and I still think we should rename this pass 🙂

Cryoris

some small comments about memory freeing otherwise I think we can merge 👍🏻

- Rename files from `optimize_1q_decomposition` to `optiize_1q_sequences`. - Fixed previous oversight that counted operations before the pass was ran.

…comp

Cryoris

LGTM, I have two optional comments which we can also clean up in a follow up.

- Update release note to include explanation as to what happens if a `Target` is not provided. - Update helper function `compare_gate_counts` to take `counts` by reference.

…comp

* Initial: Introduce C-API Access to `Optimize1qGatesDecomposition`. - The following commit adds initial access to a standalone C foreign function interface that allows users to run the `Optimize1qGatesDecomposition` transpiler pass. The feature as it stands requires the user to build a target prior to submitting the circuit; This might change in the future. - Added 1 initial testing suite for the pass which converts a sequence of H gates into a different sequences depending on the provided target. More tests will be added with time. * Fix: Add target identity test. * Chore: Fix docstring and free some pointers. * Add: Support for optional target for `Optimize1qGatesDecomposition` C API. - Add ability of running the pass without passing a `Target`. - Add proper formatting to unit tests with multiple tests inside. - Add tests without target. * Chore: Add release note. * Chore: Fix docstring. * Chore: Fix bug in release note * Chore: Address review comments - Make tha function call run in-place and modify the pointer to the `QkCircuit` in use. - Remove `h_p_target` from tests. - Use parametric gates in the target with generic parameter expressions instead of fixed ones. * Update crates/cext/src/transpiler/passes/optimize_1q_decomposition.rs Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * Chore: Fix docstring * Chore: Fix release note * Update test/c/test_optimize_1q_decomposition.c Co-authored-by: Julien Gacon <gaconju@gmail.com> * Chore: Address review comments. * Fix: Review comments * Fix: Address some memory leakage. * Fix: Incorrect function name call * Chore: Address different review items - Rename files from `optimize_1q_decomposition` to `optiize_1q_sequences`. - Fixed previous oversight that counted operations before the pass was ran. * Fix: Replace `QkOpCounts` failures until it is fixed. * Fix: Add final review comments. - Update release note to include explanation as to what happens if a `Target` is not provided. - Update helper function `compare_gate_counts` to take `counts` by reference. * Fix: Cformatting issues. * Fix: More c formatting issues. --------- Co-authored-by: Matthew Treinish <mtreinish@kortar.org> Co-authored-by: Julien Gacon <gaconju@gmail.com>

raynelfss added this to the 2.2.0 milestone Jul 8, 2025

raynelfss added Changelog: None Do not include in the GitHub Release changelog. mod: transpiler Issues and PRs related to Transpiler C API Related to the C API labels Jul 8, 2025

raynelfss changed the title ~~[WIP] C API: Burn Optimize1qGateDecomposition.~~ [WIP] C API: Burn Optimize1qGatesDecomposition. Jul 8, 2025

raynelfss force-pushed the burn-optimize-1q-decomp branch 2 times, most recently from 89fdfc0 to f122074 Compare July 9, 2025 19:30

raynelfss marked this pull request as ready for review July 10, 2025 18:02

raynelfss requested a review from a team as a code owner July 10, 2025 18:02

raynelfss changed the title ~~[WIP] C API: Burn Optimize1qGatesDecomposition.~~ C API: Burn Optimize1qGatesDecomposition. Jul 10, 2025

raynelfss added Changelog: Added Add an "Added" entry in the GitHub Release changelog. and removed Changelog: None Do not include in the GitHub Release changelog. labels Jul 10, 2025

raynelfss and others added 7 commits July 15, 2025 11:18

Fix: Add target identity test.

3f053cb

Chore: Fix docstring and free some pointers.

a77ce5e

Add: Support for optional target for Optimize1qGatesDecomposition C…

0fe11b8

… API. - Add ability of running the pass without passing a `Target`. - Add proper formatting to unit tests with multiple tests inside. - Add tests without target.

Chore: Add release note.

84c6bf3

Chore: Fix docstring.

6edc33c

Chore: Fix bug in release note

cfc03cb

raynelfss force-pushed the burn-optimize-1q-decomp branch from 42b7c38 to cfc03cb Compare July 15, 2025 15:18

Cryoris reviewed Jul 23, 2025

View reviewed changes

mtreinish reviewed Aug 8, 2025

View reviewed changes

raynelfss and others added 5 commits August 12, 2025 09:32

Merge remote-tracking branch 'upstream/main' into burn-optimize-1q-de…

7ee5c4a

…comp

Chore: Address review comments

cf16fa9

- Make tha function call run in-place and modify the pointer to the `QkCircuit` in use. - Remove `h_p_target` from tests. - Use parametric gates in the target with generic parameter expressions instead of fixed ones.

Update crates/cext/src/transpiler/passes/optimize_1q_decomposition.rs

619ec0d

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

Chore: Fix docstring

7e8a147

Chore: Fix release note

b4ba388

raynelfss assigned Cryoris Aug 14, 2025

Cryoris reviewed Aug 15, 2025

View reviewed changes

Comment thread crates/cext/src/transpiler/passes/optimize_1q_decomposition.rs Outdated

Cryoris reviewed Aug 15, 2025

View reviewed changes

raynelfss and others added 3 commits August 15, 2025 13:05

Update test/c/test_optimize_1q_decomposition.c

4ab2e26

Co-authored-by: Julien Gacon <gaconju@gmail.com>

Chore: Address review comments.

19f55a6

Merge remote-tracking branch 'upstream/main' into burn-optimize-1q-de…

25cd6cf

…comp

Cryoris reviewed Aug 18, 2025

View reviewed changes

Comment thread test/c/test_optimize_1q_decomposition.c Outdated

Fix: Review comments

923a8bb

Cryoris reviewed Aug 20, 2025

View reviewed changes

Comment thread test/c/test_optimize_1q_decomposition.c Outdated

Comment thread test/c/test_optimize_1q_decomposition.c

Comment thread test/c/test_optimize_1q_decomposition.c Outdated

raynelfss added 3 commits August 20, 2025 09:29

Fix: Address some memory leakage.

0a75d7c

Fix: Incorrect function name call

01d280e

Chore: Address different review items

9315826

- Rename files from `optimize_1q_decomposition` to `optiize_1q_sequences`. - Fixed previous oversight that counted operations before the pass was ran.

raynelfss mentioned this pull request Aug 20, 2025

Fix: Memory leakage in QkCountOps creation. #14930

Merged

raynelfss added 2 commits August 22, 2025 14:21

Fix: Replace QkOpCounts failures until it is fixed.

b4bd4ba

Merge remote-tracking branch 'upstream/main' into burn-optimize-1q-de…

82ce69d

…comp

Cryoris previously approved these changes Aug 25, 2025

View reviewed changes

Comment thread test/c/test_optimize_1q_sequences.c Outdated

Comment thread releasenotes/notes/c-api-optimize-1q-decomp-88954adfe952e91f.yaml Outdated

Fix: Add final review comments.

9224253

- Update release note to include explanation as to what happens if a `Target` is not provided. - Update helper function `compare_gate_counts` to take `counts` by reference.

raynelfss dismissed Cryoris’s stale review via 9224253 August 26, 2025 14:07

raynelfss requested a review from Cryoris August 26, 2025 14:09

raynelfss added 3 commits August 26, 2025 11:21

Fix: Cformatting issues.

b40298b

Fix: More c formatting issues.

85317c9

Merge remote-tracking branch 'upstream/main' into burn-optimize-1q-de…

1b86842

…comp

Cryoris approved these changes Aug 28, 2025

View reviewed changes

Cryoris added this pull request to the merge queue Aug 28, 2025

Merged via the queue into Qiskit:main with commit e868803 Aug 28, 2025
26 checks passed

mergify Bot mentioned this pull request Aug 28, 2025

Fix: Memory leakage in QkCountOps creation. (backport #14930) #14959

Merged

		let mut circuit_as_dag = DAGCircuit::from_circuit_data(circuit, false, None, None, None, None)
		.expect("Error while converting the circuit to a dag.");

Conversation

raynelfss commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details and comments

Uh oh!

coveralls commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 17244313498

Details

💛 - Coveralls

Uh oh!

qiskit-bot commented Jul 10, 2025

Uh oh!

raynelfss commented Jul 22, 2025

Uh oh!

Uh oh!

Cryoris Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

raynelfss Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Cryoris left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Cryoris Aug 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Cryoris commented Aug 18, 2025

Uh oh!

Cryoris left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Cryoris left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

raynelfss commented Jul 8, 2025 •

edited

Loading

coveralls commented Jul 8, 2025 •

edited

Loading