Qiskit / qiskit / 17078434881

88%

main: 88%

Build Type

push

github

Committed by web-flow

Commit Message

Add TranspileLayout to the C API (#14780)

* Add TranspileLayout to the C API

This commit adds the TranspileLayout struct added in #14778 to the C
API. It is a straightforward addition to the API as the interface is
fairly simple. Given a pointer to a TranspileLayout the methods return
the arrays for the various views of the layout or the number of qubits
for the input and output circuits.

One small change was made to the PhysicalQubit and VirtualQubit type
definitions to use #[repr(transparent)] which in practice shouldn't
change anything, but it makes it explicit that these can be used
interchangeably with a u32. This simplifies how we can return arrays of
either type to C because it is safe to cast them as pointers to u32s.

Note that nothing in the C API is capable of generating a transpile
layout currently. The intent is for it to be part of the full
transpile() function return (see #14778). In the meantime this is
tested solely through rust tests and there aren't any tests written
in C yet. A potential follow up commit can be made to update the
standalone vf2 layout pass function to use a transpile layout inside
it's result type which would be more ergonomic than it's current
layout object in the result. But to keep this PR targeted this doesn't
update that interface and only exposes the struct to the C API.

* Apply suggestions from code review

Co-authored-by: Jake Lishman <jake@binhbar.com>

* Update high level docs

* Rework C interface to write arrays to user provided pointers

This commit reworks the C API for accessing the layout details to
writing the output to a user provided pointer rather than allocating the
output array and giving them the pointer and size of it.

* Fix lint and docs

* Add missing free method

* Apply suggestions from code review

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

* Update crates/cext/src/transpiler/transpile_layout.rs

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

* Query everything

* Remove ... (continued)

Run Details

272 of 282 new or added lines in 1 file covered. (96.45%)

5 existing lines in 1 file now uncovered.

88393 of 100095 relevant lines covered (88.31%)

504047.55 hits per line