Qiskit / qiskit
90%
main: 89%

LAST BUILD BRANCH: BD-add-alt-text
DEFAULT BRANCH: main
Repo Added
Files 913
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH gh-readonly-queue/main/pr-12918-592c5f4599c6988be9c8aba7ea20841ebf141b7e
branch: gh-readonly-queue/main/pr-12918-592c5f4599c6988be9c8aba7ea20841ebf141b7e
CHANGE BRANCH
x

coverage: 89.704% (-0.002%) from 89.706%
10390629683

push

github

web-flow 
Allow immutable borrow to access `QuantumCircuit.parameters` (#12918)

* Allow immutable borrow to access `QuantumCircuit.parameters`

`QuantumCircuit.parameters` is logically a read-only operation on
`QuantumCircuit`.  For efficiency in multiple calls to
`assign_parameters`, we actually cache the sort order of the internal
`ParameterTable` on access.  This is purely a caching effect, and should
not leak out to users.

The previous implementation took a Rust-space mutable borrow out in
order to (potentially) mutate the cache.  This caused problems if
multiple Python threads attempted to call `assign_parameters`
simultaneously; it was possible for one thread to give up the GIL during
its initial call to `CircuitData::copy` (so an immutable borrow was
still live), allowing another thread to continue on to the getter
`CircuitData::get_parameters`, which required a mutable borrow, which
failed due to the paused thread in `copy`.

This moves the cache into a `RefCell`, allowing the parameter getters to
take an immutable borrow as the receiver.  We now write the cache out
only if we *can* take the mutable borrow out necessary.  This can mean
that other threads will have to repeat the work of re-sorting the
parameters, because their borrows were blocking the saving of the cache,
but this will not cause failures.

The methods on `ParameterTable` that invalidate the cache all require a
mutable borrow on the table itself.  This makes it impossible for an
immutable borrow to exist simultaneously on the cache, so these methods
should always succeed to acquire the cache lock to invalidate it.

* Use `RefCell::get_mut` where possible

In several cases, the previous code was using the runtime-checked
`RefCell::borrow_mut` in locations that can be statically proven to be
safe to take the mutable reference.  Using the correct function for this
makes the logic clearer (as well as technically removing a small amount
of runtime overhead).

* Use `OnceCell` instead of `Re... (continued)

50 of 53 new or added lines in 2 files covered. (94.34%)

7 existing lines in 1 file now uncovered.

67534 of 75285 relevant lines covered (89.7%)

364019.63 hits per line

Relevant lines Covered
75285 RELEVANT LINES 67534 COVERED LINES
364019.63 HITS PER LINE
Source Files on gh-readonly-queue/main/pr-12918-592c5f4599c6988be9c8aba7ea20841ebf141b7e

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
10390629683 gh-readonly-queue/main/pr-12918-592c5f4599c6988be9c8aba7ea20841ebf141b7e Allow immutable borrow to access `QuantumCircuit.parameters` (#12918) * Allow immutable borrow to access `QuantumCircuit.parameters` `QuantumCircuit.parameters` is logically a read-only operation on `QuantumCircuit`. For efficiency in multiple ... push web-flow github
89.7
See All Builds (9023)